From: Antoine Vigneau <antoine.vigneau@sonarsource.com>
Date: Fri, 28 Jul 2023 12:49:49 +0000 (+0200)
Subject: SONAR-20039 Clarify to end users that the apiv2 is not stable yet
X-Git-Tag: 10.2.0.77647~268
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=cea8d3b9c04ee7b61be40d50290fe5554d8dd633;p=sonarqube.git

SONAR-20039 Clarify to end users that the apiv2 is not stable yet
---

diff --git a/server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/config/CommonWebConfig.java b/server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/config/CommonWebConfig.java
index f8715068a36..8c6f520197e 100644
--- a/server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/config/CommonWebConfig.java
+++ b/server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/config/CommonWebConfig.java
@@ -50,11 +50,13 @@ public class CommonWebConfig {
   @Bean
   public OpenAPI customOpenAPI() {
     return new OpenAPI()
-      .info(
-        new Info()
-          .title("SonarQube Web API")
-          .version("1.0.0 beta")
-          .description("Documentation of SonarQube Web API")
+      .info(new Info()
+          .title("SonarQube Web API v2")
+          .version("1.0.0 alpha")
+          .description("""
+            The SonarQube API v2 is a REST API which enables you to interact with SonarQube programmatically. Endpoint listed here should work as expected.
+            However, you should not consider the API stable for now as it is still under development. New releases of SonarQube can bring changes to existing endpoint definitions.
+            """)
       );
   }