1
0
mirror of https://github.com/matrix-org/matrix-authentication-service.git synced 2025-08-01 20:26:56 +03:00

doc: auto-generate the API schema in the documentation

This commit is contained in:
Quentin Gliech
2024-07-24 15:44:08 +02:00
parent 76755610cb
commit 43ff6dc9d3
3 changed files with 124 additions and 0 deletions

50
docs/api.schema.json Normal file
View File

@ -0,0 +1,50 @@
{
"openapi": "3.1.0",
"info": {
"title": "Matrix Authentication Service admin API",
"version": ""
},
"servers": [
{
"url": "{base}",
"variables": {
"base": {
"default": "/",
"description": null
}
}
}
],
"paths": {},
"components": {
"securitySchemes": {
"oauth2": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"refreshUrl": "/oauth2/token",
"tokenUrl": "/oauth2/token",
"scopes": {
"urn:mas:admin": "Grant access to the admin API"
}
},
"authorizationCode": {
"authorizationUrl": "/authorize",
"tokenUrl": "/oauth2/token",
"refreshUrl": "/oauth2/token",
"scopes": {
"urn:mas:admin": "Grant access to the admin API"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"urn:mas:admin"
]
}
]
}