[dd-sso] Add project texts for API documentation
Evilham
parent
d37b4dfa6a
commit
583664cca8
|
|
@ -73,14 +73,17 @@ def setup_api_views(app: "AdminFlaskApp") -> None:
|
||||||
app,
|
app,
|
||||||
template={
|
template={
|
||||||
"info": {
|
"info": {
|
||||||
"title": "DD API",
|
"title": "DD API NotaBLE",
|
||||||
"description": "DD API for external integrations",
|
"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",
|
"version": "2022.11.0",
|
||||||
"termsOfService": "",
|
"termsOfService": "",
|
||||||
},
|
},
|
||||||
"externalDocs": {
|
"externalDocs": {
|
||||||
"description": "Online Documentation",
|
"description": "Online Documentation",
|
||||||
"url": "https://dd.digitalitzacio-democratica.xnet-x.net/docs/",
|
"url": "https://dd.digitalitzacio-democratica.xnet-x.net/docs/integrations.ca/",
|
||||||
},
|
},
|
||||||
"securityDefinitions": {
|
"securityDefinitions": {
|
||||||
"dd_jwt": {
|
"dd_jwt": {
|
||||||
|
|
|
||||||
164
docs/ddapi.json
164
docs/ddapi.json
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"info": {
|
"info": {
|
||||||
"title": "DD API",
|
"title": "DD API NotaBLE",
|
||||||
"description": "DD API for external integrations",
|
"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",
|
"version": "2022.11.0",
|
||||||
"termsOfService": ""
|
"termsOfService": ""
|
||||||
},
|
},
|
||||||
|
|
@ -124,59 +124,6 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/ddapi/user/{user_ddid}": {
|
"/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": {
|
"put": {
|
||||||
"summary": "Modify a user in DD",
|
"summary": "Modify a user in DD",
|
||||||
"responses": {
|
"responses": {
|
||||||
|
|
@ -244,6 +191,59 @@
|
||||||
"consumes": [
|
"consumes": [
|
||||||
"application/json"
|
"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": {
|
"/ddapi/user": {
|
||||||
|
|
@ -323,6 +323,32 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/ddapi/group/{group_id}": {
|
"/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": {
|
"get": {
|
||||||
"summary": "Get a registered group in DD",
|
"summary": "Get a registered group in DD",
|
||||||
"responses": {
|
"responses": {
|
||||||
|
|
@ -349,32 +375,6 @@
|
||||||
"consumes": [
|
"consumes": [
|
||||||
"application/json"
|
"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": {
|
"/ddapi/group": {
|
||||||
|
|
@ -535,7 +535,7 @@
|
||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"externalDocs": {
|
"externalDocs": {
|
||||||
"description": "Online Documentation",
|
"description": "Online Documentation",
|
||||||
"url": "https://dd.digitalitzacio-democratica.xnet-x.net/docs/"
|
"url": "https://dd.digitalitzacio-democratica.xnet-x.net/docs/integrations.ca/"
|
||||||
},
|
},
|
||||||
"securityDefinitions": {
|
"securityDefinitions": {
|
||||||
"dd_jwt": {
|
"dd_jwt": {
|
||||||
|
|
|
||||||
|
|
@ -58,6 +58,8 @@ generar aquests tokens.
|
||||||
[jwt]: https://jwt.io/
|
[jwt]: https://jwt.io/
|
||||||
[jose]: https://python-jose.readthedocs.io/
|
[jose]: https://python-jose.readthedocs.io/
|
||||||
|
|
||||||
## API
|
## API Notable
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
!!swagger ddapi.json!!
|
!!swagger ddapi.json!!
|
||||||
|
|
|
||||||
|
|
@ -59,6 +59,7 @@ nav:
|
||||||
- index.es.md
|
- index.es.md
|
||||||
- install.ca.md
|
- install.ca.md
|
||||||
- customising.ca.md
|
- customising.ca.md
|
||||||
|
- integrations.ca.md
|
||||||
- post-install.ca.md
|
- post-install.ca.md
|
||||||
- contributing.ca.md
|
- contributing.ca.md
|
||||||
- security.ca.md
|
- security.ca.md
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue