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

fix(swagger): restore apikey security definition with Bearer usage description

Browse Source
This commit is contained in:
RC-CHN
2025-12-25 11:32:55 +08:00
parent c8fced4cf1
commit b566eb8058
4 changed files with 52 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/docs.go
View File

@@ -4714,6 +4714,20 @@ const docTemplate = `{
}
}
}
},
"securityDefinitions": {
"AdminAuth": {
"description": "Type \"Bearer\" followed by a space and the admin token. Example: Bearer admin123",
"type": "apiKey",
"name": "Authorization",
"in": "header"
},
"MasterAuth": {
"description": "Type \"Bearer\" followed by a space and the master key. Example: Bearer sk-xxx",
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}`
@@ -4724,7 +4738,7 @@ var SwaggerInfo = &swag.Spec{
BasePath: "/",
Schemes: []string{},
Title: "EZ-API Control Plane",
Description: "Master key for tenant API access",
Description: "Management API for EZ-API Gateway system.",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",

16
docs/swagger.json
View File

@@ -1,7 +1,7 @@
{
"swagger": "2.0",
"info": {
"description": "Master key for tenant API access",
"description": "Management API for EZ-API Gateway system.",
"title": "EZ-API Control Plane",
"termsOfService": "http://swagger.io/terms/",
"contact": {
@@ -4708,5 +4708,19 @@
}
}
}
},
"securityDefinitions": {
"AdminAuth": {
"description": "Type \"Bearer\" followed by a space and the admin token. Example: Bearer admin123",
"type": "apiKey",
"name": "Authorization",
"in": "header"
},
"MasterAuth": {
"description": "Type \"Bearer\" followed by a space and the master key. Example: Bearer sk-xxx",
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}

15
docs/swagger.yaml
View File

@@ -798,7 +798,7 @@ info:
email: support@swagger.io
name: API Support
url: http://www.swagger.io/support
description: Master key for tenant API access
description: Management API for EZ-API Gateway system.
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
@@ -3025,4 +3025,17 @@ paths:
summary: Update child key
tags:
- master
securityDefinitions:
AdminAuth:
description: 'Type "Bearer" followed by a space and the admin token. Example:
Bearer admin123'
in: header
name: Authorization
type: apiKey
MasterAuth:
description: 'Type "Bearer" followed by a space and the master key. Example: Bearer
sk-xxx'
in: header
name: Authorization
type: apiKey
swagger: "2.0"