Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
DojoBackendAPI
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
External wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Dojo Project (HES-SO)
Projects
Backend
DojoBackendAPI
Commits
cdc0accc
Commit
cdc0accc
authored
6 months ago
by
michael.minelli
Browse files
Options
Downloads
Patches
Plain Diff
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
6 months ago
Stage: code_quality
Stage: test
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
.idea/material_theme_project_new.xml
+8
-1
8 additions, 1 deletion
.idea/material_theme_project_new.xml
ExpressAPI/assets/OpenAPI/OpenAPI.yaml
+41
-3
41 additions, 3 deletions
ExpressAPI/assets/OpenAPI/OpenAPI.yaml
with
49 additions
and
4 deletions
.idea/material_theme_project_new.xml
+
8
−
1
View file @
cdc0accc
...
...
@@ -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
This diff is collapsed.
Click to expand it.
ExpressAPI/assets/OpenAPI/OpenAPI.yaml
+
41
−
3
View file @
cdc0accc
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
:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment