aljaz/btcpayserver
1
0
Fork 0
mirror of https://github.com/aljazceru/btcpayserver.git synced 2026-02-23 15:14:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve redoc

Browse Source
This commit is contained in:
nicolas.dorier
2020-03-18 23:30:27 +09:00
parent e50e3f662d
commit 0a0d8d53a4
1 changed files with 10 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
BTCPayServer/wwwroot/swagger/v1/swagger.template.json
View File

@@ -24,7 +24,7 @@
"parameters": [
{
"name": "permissions",
"description": "The permissions to request. Current permissions available: ServerManagement, StoreManagement, ProfileManagement",
"description": "The permissions to request. (See APIKey authentication)",
"in": "query",
"style": "form",
"explode": true,
@@ -243,58 +243,6 @@
}
]
}
},
"/api/v1/users/me/api-keys/current": {
"get": {
"tags": [
"API Keys"
],
"summary": "Get current API Key information",
"description": "View information about the current API key",
"operationId": "ApiKeys_GetKey2",
"responses": {
"200": {
"description": "Information about the current api key",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiKeyData"
}
}
}
}
},
"security": [
{
"APIKey": []
}
]
},
"delete": {
"tags": [
"API Keys"
],
"summary": "Revoke the current API Key",
"description": "Revoke the current API key so that it cannot be used anymore",
"operationId": "ApiKeys_RevokeKey2",
"responses": {
"200": {
"description": "The key was revoked and is no longer usable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiKeyData"
}
}
}
}
},
"security": [
{
"APIKey": []
}
]
}
}
},
"components": {
@@ -403,15 +351,22 @@
"securitySchemes": {
"APIKey": {
"type": "apiKey",
"description": "BTCPay Server supports authenticating and authorizing users through an API Key that is generated by them. Send the API Key as a header value to Authorization with the format: token {token}. For a smoother experience, you can generate a url that redirects users to an API key creation screen.",
"description": "BTCPay Server supports authenticating and authorizing users through an API Key that is generated by them. Send the API Key as a header value to Authorization with the format: token {token}. For a smoother experience, you can generate a url that redirects users to an API key creation screen.\n\n You can create API Keys in the user profile / Api Keys. (Available are: ServerManagement, StoreManagement, ProfileManagement)",
"name": "Authorization",
"in": "header"
},
"Anonymous": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "Nothing required",
"description": "Anonymous authentication"
}
}
},
"security": [
{
"APIKey": []
"APIKey": [],
"Anonymous": []
}
],
"tags": [