From cea8d3b9c04ee7b61be40d50290fe5554d8dd633 Mon Sep 17 00:00:00 2001 From: Antoine Vigneau Date: Fri, 28 Jul 2023 14:49:49 +0200 Subject: [PATCH] SONAR-20039 Clarify to end users that the apiv2 is not stable yet --- .../org/sonar/server/v2/config/CommonWebConfig.java | 12 +++++++----- 1 file changed, 7 insertions(+), 5 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 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. + """) ); } -- 2.39.5