Skip to content

Commit ef6ec03

Browse files
authored
Document API endpoints (#4572)
1 parent eaff0bb commit ef6ec03

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

docs/web/api/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ Any new client should only interact with the database through these APIs.
99
* [Report server](#report-server-api)
1010
* [Authentication system](#authentication-system-api)
1111
* [Product management system](#product-management-system-api)
12+
* [Configuration](#configuration-api)
13+
* [Server information](#server-information-api)
14+
* [Other endpoints](#other-endpoints)
1215
* [API versioning](#api-versioning)
1316
* [How to add new API versions](#how-to-add-new-api-versions)
1417
* [Minor API improvements](#minor-api-improvements)
@@ -21,14 +24,41 @@ Any new client should only interact with the database through these APIs.
2124
The report server API should be used by any client to view or store analysis
2225
results.
2326

27+
API Endpoint: `/<product-name>/<API-version>/CodeCheckerService`
28+
API description can be found in [report_server.thrift](/web/api/report_server.thrift).
29+
2430
## Authentication system API <a name="authentication-system-api"></a>
2531
The authentication layer is used for supporting privileged-access only access
2632
and permission management.
2733

34+
API Endpoint: `/<API-version>/Authentication`
35+
API description can be found in [authentication.thrift](/web/api/authentication.thrift).
36+
2837
## Product management system API <a name="product-management-system-api"></a>
2938
The product management layer is responsible for handling requests about the
3039
different products and their configuration.
3140

41+
API Endpoint: `/<API-version>/Products`
42+
API description can be found in [products.thrift](/web/api/products.thrift).
43+
44+
## Configuration API <a name="configuration-api"></a>
45+
The configuration layer is used to set notifications displayed on the server.
46+
47+
API Endpoint: `/<API-version>/Configuration`
48+
API description can be found in [configuration.thrift](/web/api/configuration.thrift).
49+
50+
## Server information API <a name="server-information-api"></a>
51+
The server information layer is used to get the running CodeChecker version,
52+
for API compatibility purposes.
53+
54+
API Endpoint: `/<API-version>/ServerInfo`
55+
API description can be found in [server_info.thrift](/web/api/server_info.thrift).
56+
57+
## Other endpoints <a name="other-endpoints"></a>
58+
59+
GET requests made to endpoints `/live` and `/ready` can be used to check the
60+
health of the running server.
61+
3262
# API versioning <a name="api-versioning"></a>
3363

3464
CodeChecker supports some backward compatibility between API versions.

0 commit comments

Comments
 (0)