From cdc0accc1349e8146f2eff57f7b5e53481a3065a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C3=ABl=20Minelli?= <git@minelli.swiss>
Date: Mon, 21 Oct 2024 16:28:23 +0200
Subject: [PATCH] OpenAPI => Add documentation of clients_config route
---
.idea/material_theme_project_new.xml | 9 +++++-
ExpressAPI/assets/OpenAPI/OpenAPI.yaml | 44 ++++++++++++++++++++++++--
2 files changed, 49 insertions(+), 4 deletions(-)
diff --git a/.idea/material_theme_project_new.xml b/.idea/material_theme_project_new.xml
index 920abda..9bdfa31 100644
--- a/.idea/material_theme_project_new.xml
+++ b/.idea/material_theme_project_new.xml
@@ -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
diff --git a/ExpressAPI/assets/OpenAPI/OpenAPI.yaml b/ExpressAPI/assets/OpenAPI/OpenAPI.yaml
index 23d099e..a1da612 100644
--- a/ExpressAPI/assets/OpenAPI/OpenAPI.yaml
+++ b/ExpressAPI/assets/OpenAPI/OpenAPI.yaml
@@ -1,7 +1,7 @@
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:
--
GitLab