EDUCATIC
/
digitaldemocratic
mirror of https://gitlab.com/digitaldemocratic/digitaldemocratic
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[dd-sso] Add project texts for API documentation

merge-requests/56/head
Evilham 2022-12-12 12:50:41 +01:00
parent d37b4dfa6a
commit 583664cca8
No known key found for this signature in database
GPG Key ID: AE3EE30D970886BF
4 changed files with 92 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
dd-sso/admin/src/admin/views/ApiViews.py
View File

@ -73,14 +73,17 @@ def setup_api_views(app: "AdminFlaskApp") -> None:
app,
template={
"info": {
"title": "DD API",
"description": "DD API for external integrations",
"title": "DD API NotaBLE",
"description":
"""NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics, guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de la Fundació BitHabitat.""",
"version": "2022.11.0",
"termsOfService": "",
},
"externalDocs": {
"description": "Online Documentation",
"url": "https://dd.digitalitzacio-democratica.xnet-x.net/docs/",
"url": "https://dd.digitalitzacio-democratica.xnet-x.net/docs/integrations.ca/",
},
"securityDefinitions": {
"dd_jwt": {

164
docs/ddapi.json
View File

@ -1,7 +1,7 @@
{
"info": {
"title": "DD API",
"description": "DD API for external integrations",
"title": "DD API NotaBLE",
"description": "NotaBLE \u00e9s la col\u00b7laboraci\u00f3 entre Gwido i el Workspace educatiu DD.\n\n\u00c9s un projecte de Xnet, IsardVDI, Gwido i Taller de M\u00fasics, guanyador de la Ciutat Proactiva 2021, suport a la innovaci\u00f3 urbana de la Fundaci\u00f3 BitHabitat.",
"version": "2022.11.0",
"termsOfService": ""
},
@ -124,59 +124,6 @@
}
},
"/ddapi/user/{user_ddid}": {
"get": {
"summary": "Get a registered user in DD",
"responses": {
"200": {
"description": "The user as it exists on DD\n",
"schema": {
"$ref": "#/definitions/User"
}
},
"404": {
"description": "The user does not exist\n"
}
},
"parameters": [
{
"in": "url",
"name": "user_ddid",
"description": "The user to retrieve from DD\n",
"schema": {
"type": "string"
}
}
],
"consumes": [
"application/json"
]
},
"delete": {
"summary": "Delete a registered user in DD",
"responses": {
"200": {
"schema": {
"type": "object"
}
},
"404": {
"description": "The user does not exist\n"
}
},
"parameters": [
{
"in": "url",
"name": "user_ddid",
"description": "The user to delete from DD\n",
"schema": {
"type": "string"
}
}
],
"consumes": [
"application/json"
]
},
"put": {
"summary": "Modify a user in DD",
"responses": {
@ -244,6 +191,59 @@
"consumes": [
"application/json"
]
},
"delete": {
"summary": "Delete a registered user in DD",
"responses": {
"200": {
"schema": {
"type": "object"
}
},
"404": {
"description": "The user does not exist\n"
}
},
"parameters": [
{
"in": "url",
"name": "user_ddid",
"description": "The user to delete from DD\n",
"schema": {
"type": "string"
}
}
],
"consumes": [
"application/json"
]
},
"get": {
"summary": "Get a registered user in DD",
"responses": {
"200": {
"description": "The user as it exists on DD\n",
"schema": {
"$ref": "#/definitions/User"
}
},
"404": {
"description": "The user does not exist\n"
}
},
"parameters": [
{
"in": "url",
"name": "user_ddid",
"description": "The user to retrieve from DD\n",
"schema": {
"type": "string"
}
}
],
"consumes": [
"application/json"
]
}
},
"/ddapi/user": {
@ -323,6 +323,32 @@
}
},
"/ddapi/group/{group_id}": {
"delete": {
"summary": "Delete a registered group in DD",
"responses": {
"200": {
"schema": {
"type": "object"
}
},
"404": {
"description": "The group does not exist\n"
}
},
"parameters": [
{
"in": "url",
"name": "group_id",
"description": "The group to delete from DD\n",
"schema": {
"type": "string"
}
}
],
"consumes": [
"application/json"
]
},
"get": {
"summary": "Get a registered group in DD",
"responses": {
@ -349,32 +375,6 @@
"consumes": [
"application/json"
]
},
"delete": {
"summary": "Delete a registered group in DD",
"responses": {
"200": {
"schema": {
"type": "object"
}
},
"404": {
"description": "The group does not exist\n"
}
},
"parameters": [
{
"in": "url",
"name": "group_id",
"description": "The group to delete from DD\n",
"schema": {
"type": "string"
}
}
],
"consumes": [
"application/json"
]
}
},
"/ddapi/group": {
@ -535,7 +535,7 @@
"swagger": "2.0",
"externalDocs": {
"description": "Online Documentation",
"url": "https://dd.digitalitzacio-democratica.xnet-x.net/docs/"
"url": "https://dd.digitalitzacio-democratica.xnet-x.net/docs/integrations.ca/"
},
"securityDefinitions": {
"dd_jwt": {

4
docs/integrations.ca.md
View File

@ -58,6 +58,8 @@ generar aquests tokens.
[jwt]: https://jwt.io/
[jose]: https://python-jose.readthedocs.io/
## API
## API Notable
![Projecte NotaBLE](assets/images/notable.jpg)
!!swagger ddapi.json!!

1
mkdocs.yml
View File

@ -59,6 +59,7 @@ nav:
- index.es.md
- install.ca.md
- customising.ca.md
- integrations.ca.md
- post-install.ca.md
- contributing.ca.md
- security.ca.md