Browse Source

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

tags/10.2.0.77647
Antoine Vigneau 10 months ago
parent
commit
cea8d3b9c0

+ 7
- 5
server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/config/CommonWebConfig.java View 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.
""")
);
}


Loading…
Cancel
Save