diff options
Diffstat (limited to 'server')
2 files changed, 6 insertions, 2 deletions
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 3185e497266..640de88fb8a 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 @@ -73,8 +73,8 @@ public class CommonWebConfig implements WebMvcConfigurer { .info(new Info() .title("SonarQube Web API v2") .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. + The SonarQube API v2 is a REST API which enables you to interact with SonarQube programmatically. + While not all endpoints of the former Web API are available yet, the ones available are stable and can be used in production environments. """) .version(sqVersion.toString())); } diff --git a/server/sonar-webserver-webapi-v2/src/test/java/org/sonar/server/v2/config/CommonWebConfigTest.java b/server/sonar-webserver-webapi-v2/src/test/java/org/sonar/server/v2/config/CommonWebConfigTest.java index 8e7b5865d02..9563ddd06fb 100644 --- a/server/sonar-webserver-webapi-v2/src/test/java/org/sonar/server/v2/config/CommonWebConfigTest.java +++ b/server/sonar-webserver-webapi-v2/src/test/java/org/sonar/server/v2/config/CommonWebConfigTest.java @@ -57,6 +57,10 @@ public class CommonWebConfigTest { var info = commonWebConfig.customOpenAPI().getInfo(); assertThat(info.getVersion()).isNotNull(); + assertThat(info.getDescription()).isEqualTo(""" + The SonarQube API v2 is a REST API which enables you to interact with SonarQube programmatically. + While not all endpoints of the former Web API are available yet, the ones available are stable and can be used in production environments. + """); assertThat(info.getVersion()).isEqualTo(expectedVersion.toString()); } } |