ruochen/ez-api
1
0
Fork 0
mirror of https://github.com/EZ-Api/ez-api.git synced 2026-01-13 17:47:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(swagger): document admin master child key endpoints

Browse Source
This commit is contained in:
zenfun
2026-01-10 01:19:53 +08:00
parent e7db9f319f
commit f52c7acbe6
3 changed files with 542 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

212
docs/swagger.json
View File

@@ -4208,6 +4208,107 @@
}
},
"/admin/masters/{id}/keys": {
"get": {
"security": [
{
"AdminAuth": []
}
],
"description": "List child keys issued under a master (admin view)",
"produces": [
"application/json"
],
"tags": [
"admin"
],
"summary": "List child keys for a master",
"parameters": [
{
"type": "integer",
"description": "Master ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "page (1-based)",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "limit (default 50, max 200)",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "search by group/scopes/namespaces/status",
"name": "search",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/internal_api.ResponseEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/internal_api.TokenView"
}
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"allOf": [
{
"$ref": "#/definitions/internal_api.ResponseEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/gin.H"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"allOf": [
{
"$ref": "#/definitions/internal_api.ResponseEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/gin.H"
}
}
}
]
}
}
}
},
"post": {
"security": [
{
@@ -4337,6 +4438,113 @@
}
}
},
"/admin/masters/{id}/keys/{key_id}": {
"delete": {
"security": [
{
"AdminAuth": []
}
],
"description": "Revokes and removes a child key under the specified master",
"produces": [
"application/json"
],
"tags": [
"admin"
],
"summary": "Delete child key",
"parameters": [
{
"type": "integer",
"description": "Master ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Token ID",
"name": "key_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/internal_api.ResponseEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/gin.H"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"allOf": [
{
"$ref": "#/definitions/internal_api.ResponseEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/gin.H"
}
}
}
]
}
},
"404": {
"description": "Not Found",
"schema": {
"allOf": [
{
"$ref": "#/definitions/internal_api.ResponseEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/gin.H"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"allOf": [
{
"$ref": "#/definitions/internal_api.ResponseEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/gin.H"
}
}
}
]
}
}
}
}
},
"/admin/masters/{id}/manage": {
"post": {
"security": [
@@ -7932,6 +8140,10 @@
}
},
"definitions": {
"gin.H": {
"type": "object",
"additionalProperties": {}
},
"github_com_ez-api_ez-api_internal_dto.APIKeyDTO": {
"type": "object",
"properties": {