2
0
mirror of https://github.com/acepanel/panel.git synced 2026-02-07 02:07:26 +08:00

fix: 文档错误

This commit is contained in:
耗子
2024-01-24 02:50:15 +08:00
parent 8dc41d4222
commit 63033dfa15
6 changed files with 145 additions and 154 deletions

View File

@@ -121,7 +121,7 @@ func (r *CertController) Algorithms(ctx http.Context) http.Response {
// @Tags 证书管理
// @Produce json
// @Security BearerToken
// @Param data body commonrequests.Paginate true "request"
// @Param data query commonrequests.Paginate true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/cert/users [get]
func (r *CertController) UserList(ctx http.Context) http.Response {
@@ -273,7 +273,7 @@ func (r *CertController) UserDestroy(ctx http.Context) http.Response {
// @Tags 证书管理
// @Produce json
// @Security BearerToken
// @Param data body commonrequests.Paginate true "request"
// @Param data query commonrequests.Paginate true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/cert/dns [get]
func (r *CertController) DNSList(ctx http.Context) http.Response {
@@ -425,7 +425,7 @@ func (r *CertController) DNSDestroy(ctx http.Context) http.Response {
// @Tags 证书管理
// @Produce json
// @Security BearerToken
// @Param data body commonrequests.Paginate true "request"
// @Param data query commonrequests.Paginate true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/cert/certs [get]
func (r *CertController) CertList(ctx http.Context) http.Response {

View File

@@ -104,7 +104,7 @@ func (r *RsyncController) Stop(ctx http.Context) http.Response {
// @Tags 插件-Rsync
// @Produce json
// @Security BearerToken
// @Param data body commonrequests.Paginate true "request"
// @Param data query commonrequests.Paginate true "request"
// @Success 200 {object} controllers.SuccessResponse
// @Router /plugins/rsync/modules [get]
func (r *RsyncController) List(ctx http.Context) http.Response {

View File

@@ -327,7 +327,7 @@ func (r *WebsiteController) UpdateRemark(ctx http.Context) http.Response {
// @Tags 网站管理
// @Produce json
// @Security BearerToken
// @Param data body commonrequests.Paginate true "request"
// @Param data query commonrequests.Paginate true "request"
// @Success 200 {object} SuccessResponse{data=[]internal.BackupFile}
// @Router /panel/website/backupList [get]
func (r *WebsiteController) BackupList(ctx http.Context) http.Response {

View File

@@ -88,13 +88,14 @@ const docTemplate = `{
"summary": "获取证书列表",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -286,13 +287,14 @@ const docTemplate = `{
"summary": "获取 DNS 接口列表",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -641,13 +643,14 @@ const docTemplate = `{
"summary": "获取用户列表",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -1549,13 +1552,14 @@ const docTemplate = `{
"summary": "获取备份列表",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -1756,13 +1760,14 @@ const docTemplate = `{
"summary": "获取网站列表",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -2240,13 +2245,14 @@ const docTemplate = `{
"summary": "列出模块",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -2524,17 +2530,6 @@ const docTemplate = `{
}
}
},
"commonrequests.Paginate": {
"type": "object",
"properties": {
"limit": {
"type": "integer"
},
"page": {
"type": "integer"
}
}
},
"controllers.ErrorResponse": {
"type": "object",
"properties": {
@@ -2817,6 +2812,9 @@ const docTemplate = `{
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
},

View File

@@ -81,13 +81,14 @@
"summary": "获取证书列表",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -279,13 +280,14 @@
"summary": "获取 DNS 接口列表",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -634,13 +636,14 @@
"summary": "获取用户列表",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -1542,13 +1545,14 @@
"summary": "获取备份列表",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -1749,13 +1753,14 @@
"summary": "获取网站列表",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -2233,13 +2238,14 @@
"summary": "列出模块",
"parameters": [
{
"description": "request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commonrequests.Paginate"
}
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"name": "page",
"in": "query"
}
],
"responses": {
@@ -2517,17 +2523,6 @@
}
}
},
"commonrequests.Paginate": {
"type": "object",
"properties": {
"limit": {
"type": "integer"
},
"page": {
"type": "integer"
}
}
},
"controllers.ErrorResponse": {
"type": "object",
"properties": {
@@ -2810,6 +2805,9 @@
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
},

View File

@@ -24,13 +24,6 @@ definitions:
value:
type: string
type: object
commonrequests.Paginate:
properties:
limit:
type: integer
page:
type: integer
type: object
controllers.ErrorResponse:
properties:
code:
@@ -220,6 +213,8 @@ definitions:
type: string
port:
type: integer
ssl:
type: boolean
username:
type: string
website_path:
@@ -525,12 +520,12 @@ paths:
get:
description: 获取面板证书管理的证书列表
parameters:
- description: request
in: body
name: data
required: true
schema:
$ref: '#/definitions/commonrequests.Paginate'
- in: query
name: limit
type: integer
- in: query
name: page
type: integer
produces:
- application/json
responses:
@@ -646,12 +641,12 @@ paths:
get:
description: 获取面板证书管理的 DNS 接口列表
parameters:
- description: request
in: body
name: data
required: true
schema:
$ref: '#/definitions/commonrequests.Paginate'
- in: query
name: limit
type: integer
- in: query
name: page
type: integer
produces:
- application/json
responses:
@@ -861,12 +856,12 @@ paths:
get:
description: 获取面板证书管理的 ACME 用户列表
parameters:
- description: request
in: body
name: data
required: true
schema:
$ref: '#/definitions/commonrequests.Paginate'
- in: query
name: limit
type: integer
- in: query
name: page
type: integer
produces:
- application/json
responses:
@@ -1421,12 +1416,12 @@ paths:
get:
description: 获取网站的备份列表
parameters:
- description: request
in: body
name: data
required: true
schema:
$ref: '#/definitions/commonrequests.Paginate'
- in: query
name: limit
type: integer
- in: query
name: page
type: integer
produces:
- application/json
responses:
@@ -1544,12 +1539,12 @@ paths:
get:
description: 获取网站管理的网站列表
parameters:
- description: request
in: body
name: data
required: true
schema:
$ref: '#/definitions/commonrequests.Paginate'
- in: query
name: limit
type: integer
- in: query
name: page
type: integer
produces:
- application/json
responses:
@@ -1842,12 +1837,12 @@ paths:
get:
description: 列出所有 Rsync 模块
parameters:
- description: request
in: body
name: data
required: true
schema:
$ref: '#/definitions/commonrequests.Paginate'
- in: query
name: limit
type: integer
- in: query
name: page
type: integer
produces:
- application/json
responses: