]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-20039 Clarify to end users that the apiv2 is not stable yet
authorAntoine Vigneau <antoine.vigneau@sonarsource.com>
Fri, 28 Jul 2023 12:49:49 +0000 (14:49 +0200)
committersonartech <sonartech@sonarsource.com>
Mon, 31 Jul 2023 20:03:32 +0000 (20:03 +0000)
server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/config/CommonWebConfig.java

index f8715068a3679f83751409daf109e9e40ca783b5..8c6f520197eb1ed0d2f51829a2eb10b6376548fd 100644 (file)
@@ -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.
+            """)
       );
   }