]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-13860 Update Web API info in the documentation
authormichaelbirnstiehl <michael.birnstiehl@sonarsource.com>
Tue, 8 Sep 2020 19:21:25 +0000 (14:21 -0500)
committersonartech <sonartech@sonarsource.com>
Wed, 9 Sep 2020 20:07:14 +0000 (20:07 +0000)
server/sonar-docs/src/images/webapi.png [new file with mode: 0644]
server/sonar-docs/src/pages/extend/web-api.md

diff --git a/server/sonar-docs/src/images/webapi.png b/server/sonar-docs/src/images/webapi.png
new file mode 100644 (file)
index 0000000..46488a6
Binary files /dev/null and b/server/sonar-docs/src/images/webapi.png differ
index 310eea605d78b858671df0204725a5f88890ebba..ab142a176e4dcd91222d205183a8dbb771410ae1 100644 (file)
@@ -1,12 +1,18 @@
 ---
-title: Web API Authentication
+title: Web API
 url: /extend/web-api/
 ---
-SonarQube provides web API to access its functionalities from applications. The web services composing the web API are documented within SonarQube, through the URL [/web_api](/#sonarqube#/web_api), which can also be reached from a link in the page footer. 
+## Documentation
+
+SonarQube provides web API to access its functionalities from applications. The web services composing the web API are documented within SonarQube, through the URL [/web_api](/#sonarqube#/web_api). You can also access the web API documentation from the top bar in SonarQube:
+
+ ![web API documentation](/images/webapi.png)
+
+## Authentication
 
 Administrative web services are secured and require the user to have specific permissions. In order to be authenticated, the user must provide credentials as described below.
 
-## User Token
+### User Token
 
 This is the recommended way. Benefits are described in the page [User Token](/user-guide/user-token/). The token is sent via the login field of HTTP basic authentication, without any password.
 ```
@@ -14,7 +20,8 @@ This is the recommended way. Benefits are described in the page [User Token](/us
 curl -u THIS_IS_MY_TOKEN: https://sonarqube.com/api/user_tokens/search
 ```
 
-## HTTP Basic Access
+### HTTP Basic Access
+
 Login and password are sent via the standard HTTP Basic fields:
 ```
 curl -u MY_LOGIN:MY_PASSWORD https://sonarqube.com/api/user_tokens/search