Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions lib/server/api-docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
15 changes: 15 additions & 0 deletions lib/server/api-docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,21 @@ <h2>Status</h2>
<pre><code class="language-bash">curl -g &quot;$BOOKKEEPING_URL/api/status/gui?token=$TOKEN&quot;
</code></pre>
</details>
<h2>Configuration</h2>
<p>Addresses of the external services Bookkeeping links to.</p>
<details>
<summary><h3><span class="method get">GET</span> <code>/configuration</code> - Get the URLs of the external services</h3></summary>

<p>Operation id: <code>getConfiguration</code></p>
<p>Returns the addresses of the services Bookkeeping links to (InfoLogger, AliECS GUI, QC GUI, ali-flp-index).
A URL is <code>null</code> when the service is not configured on this deployment.</p>
<p>Responses:</p>
<ul>
<li><code>200</code>: The configured URLs.</li>
</ul>
<pre><code class="language-bash">curl -g &quot;$BOOKKEEPING_URL/api/configuration?token=$TOKEN&quot;
</code></pre>
</details>

</main>
<footer>Generated from openapi.yaml by <code>npm run docs:api</code> · ALICE Bookkeeping · internal use only</footer>
Expand Down
36 changes: 36 additions & 0 deletions lib/server/api-docs/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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. }
Loading