Skip to content
Snippets Groups Projects
Commit cdc0accc authored by michael.minelli's avatar michael.minelli
Browse files

OpenAPI => Add documentation of clients_config route

parent ce33884d
No related branches found
No related tags found
No related merge requests found
Pipeline #35116 passed
......@@ -3,8 +3,15 @@
<component name="MaterialThemeProjectNewConfig">
<option name="metadata">
<MTProjectMetadataState>
<option name="userId" value="-6f2668ee:1924765eb2a:-7fc3" />
<option name="migrated" value="true" />
<option name="pristineConfig" value="false" />
<option name="userId" value="104e8585:19002424fea:-7ffe" />
</MTProjectMetadataState>
</option>
<option name="titleBarState">
<MTProjectTitleBarConfigState>
<option name="overrideColor" value="false" />
</MTProjectTitleBarConfigState>
</option>
</component>
</project>
\ No newline at end of file
openapi: 3.1.0
info:
title: Dojo API
version: 4.2.0
version: 5.0.0
description: |
**Backend API of the Dojo project.**
......@@ -46,8 +46,46 @@ paths:
schema:
$ref: '#/components/schemas/DojoBackendResponse'
description: OK
default:
$ref: '#/components/responses/ERROR'
/clients_config:
get:
tags:
- General
summary: Config of the clients
description: This route is used to get the configuration that clients (CLI, Checkers, etc.) need to operate.
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DojoBackendResponse'
- type: object
properties:
data:
type: object
properties:
gitlabUrl:
type: string
examples:
- https://gitedu.hesge.ch/
gitlabAccountId:
type: number
examples:
- 1076
gitlabAccountUsername:
type: string
examples:
- isc-dojo
loginGitlabClientId:
type: string
examples:
- 262b4d7c215233fa6fc91e70fb387a9314c02472dc3c6d22d6861fe93db6996a
required:
- gitlabUrl
- gitlabAccountId
- gitlabAccountUsername
- loginGitlabClientId
description: OK
/login:
post:
tags:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment