diff --git a/lib/server/api-docs/API.md b/lib/server/api-docs/API.md index cd0e49775e..988eb990f7 100644 --- a/lib/server/api-docs/API.md +++ b/lib/server/api-docs/API.md @@ -250,3 +250,22 @@ Responses: ```bash curl -g "$BOOKKEEPING_URL/api/status/gui?token=$TOKEN" ``` + +## Configuration + +Addresses of the external services Bookkeeping links to. + +### `GET /configuration` - Get the URLs of the external services + +Operation id: `getConfiguration` + +Returns the addresses of the services Bookkeeping links to (InfoLogger, AliECS GUI, QC GUI, ali-flp-index). +A URL is `null` when the service is not configured on this deployment. + +Responses: + +- `200`: The configured URLs. + +```bash +curl -g "$BOOKKEEPING_URL/api/configuration?token=$TOKEN" +``` diff --git a/lib/server/api-docs/index.html b/lib/server/api-docs/index.html index bc843e20c8..4b8861d795 100644 --- a/lib/server/api-docs/index.html +++ b/lib/server/api-docs/index.html @@ -459,6 +459,21 @@

Status

curl -g "$BOOKKEEPING_URL/api/status/gui?token=$TOKEN"
 
+

Configuration

+

Addresses of the external services Bookkeeping links to.

+
+

GET /configuration - Get the URLs of the external services

+ +

Operation id: getConfiguration

+

Returns the addresses of the services Bookkeeping links to (InfoLogger, AliECS GUI, QC GUI, ali-flp-index). +A URL is null when the service is not configured on this deployment.

+

Responses:

+ +
curl -g "$BOOKKEEPING_URL/api/configuration?token=$TOKEN"
+
+
diff --git a/lib/server/api-docs/openapi.yaml b/lib/server/api-docs/openapi.yaml index d865d4f7b7..ebaa4bc8cd 100644 --- a/lib/server/api-docs/openapi.yaml +++ b/lib/server/api-docs/openapi.yaml @@ -39,6 +39,8 @@ tags: description: Labels attached to logs (and runs). Each tag may notify an e-mail list and a Mattermost channel. - name: Status description: Health of the Bookkeeping application and of its database. + - name: Configuration + description: Addresses of the external services Bookkeeping links to. paths: /tags: @@ -267,6 +269,28 @@ paths: example: data: { host: localhost, port: 4000, version: 1.20.0, status: { ok: true, configured: true } } + /configuration: + get: + tags: [Configuration] + operationId: getConfiguration + summary: Get the URLs of the external services + description: | + Returns the addresses of the services Bookkeeping links to (InfoLogger, AliECS GUI, QC GUI, ali-flp-index). + A URL is `null` when the service is not configured on this deployment. + responses: + '200': + description: The configured URLs. + content: + application/json: + schema: { $ref: '#/components/schemas/Configuration' } + example: + data: + FlpInfologgerUrl: http://localhost:8081 + EpnInfologgerUrl: null + AliFlpIndexUrl: http://localhost:80 + QcGuiUrl: http://localhost:8082 + AliEcsGuiUrl: http://localhost:8080 + components: securitySchemes: jwtQuery: @@ -400,3 +424,15 @@ components: required: [data] properties: data: { $ref: '#/components/schemas/ServiceStatus' } + Configuration: + type: object + required: [data] + properties: + data: + type: object + properties: + FlpInfologgerUrl: { type: [string, 'null'], description: FLP InfoLogger GUI. } + EpnInfologgerUrl: { type: [string, 'null'], description: EPN InfoLogger GUI. } + AliFlpIndexUrl: { type: [string, 'null'], description: ali-flp-index page. } + QcGuiUrl: { type: [string, 'null'], description: Quality Control GUI. } + AliEcsGuiUrl: { type: [string, 'null'], description: AliECS GUI. }