1Panel-dev/1Panel
1
1
Fork 0
mirror of https://github.com/1Panel-dev/1Panel.git synced 2025-10-06 13:27:43 +08:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: Update swagger docs (#8002)

Browse source 
Refs #8001
This commit is contained in:
蘭 2025-02-26 10:55:40 +08:00 • committed by GitHub
parent 67c1bf2924
commit 193b0f3cd4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 31 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
backend/app/api/v1/container.go
View file

@ -391,7 +391,7 @@ func (b *BaseApi) ContainerOperation(c *gin.Context) {
// @Tags Container
// @Summary Container stats
// @Param id path integer true "container id"
// @Param id path string true "container id"
// @Success 200 {object} dto.ContainerStats
// @Security ApiKeyAuth
// @Security Timestamp

10
cmd/server/docs/docs.go
View file

@ -3483,7 +3483,7 @@ const docTemplate = `{
"summary": "Container stats",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "container id",
"name": "id",
"in": "path",
@ -19382,6 +19382,9 @@ const docTemplate = `{
"dto.ForwardRuleOperate": {
"type": "object",
"properties": {
"forceDelete": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
@ -20708,6 +20711,9 @@ const docTemplate = `{
"dto.OllamaBindDomainRes": {
"type": "object",
"properties": {
"acmeAccountID": {
"type": "integer"
},
"allowIPs": {
"type": "array",
"items": {
@ -26721,7 +26727,7 @@ const docTemplate = `{
},
"securityDefinitions": {
"ApiKeyAuth": {
"description": "- ` + "`" + `1Panel-Token` + "`" + ` is the key for the panel API Key.",
"description": "Custom Token Format, Format: md5('1panel' + API-Key + UnixTimestamp).\n` + "`" + `` + "`" + `` + "`" + `\neg:\ncurl -X GET \"http://localhost:4004/api/v1/dashboard/current\" \\\n-H \"1Panel-Token: \u003c1panel_token\u003e\" \\\n-H \"1Panel-Timestamp: \u003ccurrent_unix_timestamp\u003e\"\n` + "`" + `` + "`" + `` + "`" + `\n- ` + "`" + `1Panel-Token` + "`" + ` is the key for the panel API Key.",
"type": "apiKey",
"name": "1Panel-Token",
"in": "header"

10
cmd/server/docs/swagger.json
View file

@ -3480,7 +3480,7 @@
"summary": "Container stats",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "container id",
"name": "id",
"in": "path",
@ -19379,6 +19379,9 @@
"dto.ForwardRuleOperate": {
"type": "object",
"properties": {
"forceDelete": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
@ -20705,6 +20708,9 @@
"dto.OllamaBindDomainRes": {
"type": "object",
"properties": {
"acmeAccountID": {
"type": "integer"
},
"allowIPs": {
"type": "array",
"items": {
@ -26718,7 +26724,7 @@
},
"securityDefinitions": {
"ApiKeyAuth": {
"description": "- `1Panel-Token` is the key for the panel API Key.",
"description": "Custom Token Format, Format: md5('1panel' + API-Key + UnixTimestamp).\n```\neg:\ncurl -X GET \"http://localhost:4004/api/v1/dashboard/current\" \\\n-H \"1Panel-Token: \u003c1panel_token\u003e\" \\\n-H \"1Panel-Timestamp: \u003ccurrent_unix_timestamp\u003e\"\n```\n- `1Panel-Token` is the key for the panel API Key.",
"type": "apiKey",
"name": "1Panel-Token",
"in": "header"

16
cmd/server/docs/swagger.yaml
View file

@ -1578,6 +1578,8 @@ definitions:
type: object
dto.ForwardRuleOperate:
properties:
forceDelete:
type: boolean
rules:
items:
properties:
@ -2480,6 +2482,8 @@ definitions:
type: object
dto.OllamaBindDomainRes:
properties:
acmeAccountID:
type: integer
allowIPs:
items:
type: string
@ -8585,7 +8589,7 @@ paths:
in: path
name: id
required: true
type: integer
type: string
responses:
"200":
description: OK
@ -16762,7 +16766,15 @@ schemes:
- https
securityDefinitions:
ApiKeyAuth:
description: '- `1Panel-Token` is the key for the panel API Key.'
description: |-
Custom Token Format, Format: md5('1panel' + API-Key + UnixTimestamp).
```
eg:
curl -X GET "http://localhost:4004/api/v1/dashboard/current" \
-H "1Panel-Token: <1panel_token>" \
-H "1Panel-Timestamp: <current_unix_timestamp>"
```
- `1Panel-Token` is the key for the panel API Key.
in: header
name: 1Panel-Token
type: apiKey