jinshan/internal/swagger/swagger.yaml
2025-06-19 10:35:26 +08:00

5605 lines
136 KiB
YAML

definitions:
errors.Error:
properties:
code:
type: integer
detail:
type: string
id:
type: string
status:
type: string
type: object
schema.Activity:
properties:
address:
type: string
categoryId:
type: string
content:
type: string
cover:
type: string
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
endAt:
type: string
endSignupAt:
type: string
id:
type: string
images:
items:
type: string
type: array
maxSignupNum:
type: integer
signupNum:
type: integer
startAt:
type: string
startSignupAt:
type: string
status:
type: string
title:
type: string
updatedAt:
type: string
type: object
schema.ActivityCategory:
properties:
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
name:
type: string
sequence:
type: integer
status:
type: string
updatedAt:
type: string
type: object
schema.ActivityCategoryForm:
type: object
schema.ActivityForm:
properties:
address:
type: string
categoryId:
type: string
content:
type: string
cover:
type: string
endAt:
type: string
endSignupAt:
type: string
images:
items:
type: string
type: array
maxSignupNum:
type: integer
signupNum:
type: integer
startAt:
type: string
startSignupAt:
type: string
status:
type: string
title:
type: string
type: object
schema.AiRequest:
properties:
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
updatedAt:
type: string
type: object
schema.AiRequestForm:
properties:
msg:
type: string
type: object
schema.App:
properties:
created_at:
description: Create time
type: string
id:
description: Unique ID
type: string
updated_at:
description: Update time
type: string
type: object
schema.AppForm:
type: object
schema.Balance:
properties:
after:
type: integer
before:
type: integer
change:
type: integer
createdAt:
type: string
createdId:
type: string
customerId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
operatorId:
type: string
reason:
type: string
type:
type: string
updatedAt:
type: string
type: object
schema.BalanceForm:
properties:
CreatedID:
type: string
after:
type: integer
before:
type: integer
change:
type: integer
customerId:
type: string
operatorId:
type: string
reason:
type: string
type:
type: string
type: object
schema.Banner:
properties:
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
desc:
type: string
id:
type: string
img:
type: string
link:
type: string
sequence:
type: integer
status:
type: string
title:
type: string
type:
type: string
updatedAt:
type: string
type: object
schema.BannerForm:
properties:
desc:
type: string
img:
type: string
link:
type: string
sequence:
type: integer
status:
type: string
title:
type: string
type:
type: string
type: object
schema.Captcha:
properties:
captcha_id:
description: Captcha ID
type: string
type: object
schema.Customer:
properties:
avatar:
type: string
birthday:
type: string
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
introduce:
type: string
name:
type: string
phone:
type: string
status:
type: string
updatedAt:
type: string
wxSign:
type: string
type: object
schema.CustomerForm:
properties:
avatar:
type: string
birthday:
type: string
introduce:
type: string
name:
type: string
phone:
type: string
status:
type: string
wxSign:
type: string
type: object
schema.Help:
properties:
createdAt:
type: string
createdId:
type: string
customerId:
type: string
deletedAt:
type: integer
deletedId:
type: string
desc:
type: string
id:
type: string
img:
type: string
link:
type: string
sequence:
type: integer
status:
type: string
type:
type: string
updatedAt:
type: string
type: object
schema.HelpForm:
type: object
schema.Logger:
properties:
created_at:
description: Create time
type: string
data:
description: Log data
type: string
id:
description: Unique ID
type: string
level:
description: Log level
type: string
login_name:
description: From User.Username
type: string
message:
description: Log message
type: string
stack:
description: Error stack
type: string
tag:
description: Log tag
type: string
trace_id:
description: Trace ID
type: string
user_id:
description: User ID
type: string
user_name:
description: From User.Name
type: string
type: object
schema.LoginForm:
properties:
captcha_code:
description: Captcha verify code
type: string
captcha_id:
description: Captcha verify id
type: string
password:
description: Login password (md5 hash)
type: string
username:
description: Login name
type: string
required:
- password
- username
type: object
schema.LoginToken:
properties:
access_token:
description: Access token (JWT)
type: string
expires_at:
description: 'Expired time (Unit: second)'
type: integer
token_type:
description: 'Token type (Usage: Authorization=${token_type} ${access_token})'
type: string
type: object
schema.Menu:
properties:
children:
description: Child menus
items:
$ref: '#/definitions/schema.Menu'
type: array
code:
description: Code of menu (unique for each level)
type: string
created_at:
description: Create time
type: string
description:
description: Details about menu
type: string
id:
description: Unique ID
type: string
name:
description: Display name of menu
type: string
parent_id:
description: Parent ID (From Menu.ID)
type: string
parent_path:
description: Parent path (split by .)
type: string
path:
description: Access path of menu
type: string
properties:
description: Properties of menu (JSON)
type: string
resources:
description: Resources of menu
items:
$ref: '#/definitions/schema.MenuResource'
type: array
sequence:
description: Sequence for sorting (Order by desc)
type: integer
status:
description: Status of menu (enabled, disabled)
type: string
type:
description: Type of menu (page, button)
type: string
updated_at:
description: Update time
type: string
type: object
schema.MenuForm:
properties:
code:
description: Code of menu (unique for each level)
maxLength: 32
type: string
description:
description: Details about menu
type: string
name:
description: Display name of menu
maxLength: 128
type: string
parent_id:
description: Parent ID (From Menu.ID)
type: string
path:
description: Access path of menu
type: string
properties:
description: Properties of menu (JSON)
type: string
resources:
description: Resources of menu
items:
$ref: '#/definitions/schema.MenuResource'
type: array
sequence:
description: Sequence for sorting (Order by desc)
type: integer
status:
description: Status of menu (enabled, disabled)
enum:
- disabled
- enabled
type: string
type:
description: Type of menu (page, button)
enum:
- page
- button
type: string
required:
- code
- name
- status
- type
type: object
schema.MenuResource:
properties:
created_at:
description: Create time
type: string
id:
description: Unique ID
type: string
menu_id:
description: From Menu.ID
type: string
method:
description: HTTP method
type: string
path:
description: API request path (e.g. /api/v1/users/:id)
type: string
updated_at:
description: Update time
type: string
type: object
schema.MettingRoom:
properties:
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
desc:
type: string
id:
type: string
imgs:
items:
type: string
type: array
link:
type: string
maxNum:
type: integer
status:
type: string
title:
type: string
updatedAt:
type: string
type: object
schema.MettingRoomForm:
properties:
desc:
type: string
imgs:
items:
type: string
type: array
link:
type: string
maxNum:
type: integer
status:
type: string
title:
type: string
type: object
schema.MettingRoomOrder:
properties:
concatName:
type: string
concatPhone:
type: string
createdAt:
type: string
createdId:
type: string
customerId:
type: string
deletedAt:
type: integer
deletedId:
type: string
endAt:
type: string
id:
type: string
roomId:
type: string
startAt:
type: string
status:
type: string
updatedAt:
type: string
type: object
schema.MettingRoomOrderForm:
properties:
concatName:
type: string
concatPhone:
type: string
customerId:
type: string
endAt:
type: string
roomId:
type: string
startAt:
type: string
status:
type: string
type: object
schema.Notice:
properties:
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
desc:
type: string
id:
type: string
link:
type: string
sequence:
type: integer
status:
type: string
title:
type: string
updatedAt:
type: string
type: object
schema.NoticeForm:
properties:
desc:
type: string
link:
type: string
sequence:
type: integer
status:
type: string
title:
type: string
type: object
schema.Order:
properties:
createdAt:
type: string
createdId:
type: string
customerId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
num:
type: integer
productId:
type: string
shopId:
type: string
status:
type: string
updatedAt:
type: string
type: object
schema.OrderForm:
type: object
schema.Product:
properties:
categoryId:
type: string
content:
type: string
cover:
type: string
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
images:
items:
type: string
type: array
introduce:
type: string
num:
type: integer
price:
type: integer
shopId:
type: string
status:
type: string
title:
type: string
updatedAt:
type: string
type: object
schema.ProductCategory:
properties:
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
name:
type: string
sequence:
type: integer
status:
type: string
updatedAt:
type: string
type: object
schema.ProductCategoryForm:
properties:
name:
type: string
sequence:
type: integer
status:
type: string
type: object
schema.ProductForm:
properties:
categoryId:
type: string
content:
type: string
cover:
type: string
images:
items:
type: string
type: array
introduce:
type: string
num:
type: integer
price:
type: integer
shopId:
type: string
status:
type: string
title:
type: string
type: object
schema.Reciprocity:
properties:
content:
type: string
createdAt:
type: string
createdId:
type: string
customerId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
images:
items:
type: string
type: array
status:
type: string
title:
type: string
updatedAt:
type: string
type: object
schema.ReciprocityForm:
properties:
content:
type: string
customerId:
type: string
images:
items:
type: string
type: array
status:
type: string
title:
type: string
type: object
schema.Record:
properties:
content:
type: string
sendAt:
type: string
sender:
type: string
type: object
schema.Role:
properties:
code:
description: Code of role (unique)
type: string
created_at:
description: Create time
type: string
description:
description: Details about role
type: string
id:
description: Unique ID
type: string
menus:
description: Role menu list
items:
$ref: '#/definitions/schema.RoleMenu'
type: array
name:
description: Display name of role
type: string
sequence:
description: Sequence for sorting
type: integer
status:
description: Status of role (disabled, enabled)
type: string
updated_at:
description: Update time
type: string
type: object
schema.RoleForm:
properties:
code:
description: Code of role (unique)
maxLength: 32
type: string
description:
description: Details about role
type: string
menus:
description: Role menu list
items:
$ref: '#/definitions/schema.RoleMenu'
type: array
name:
description: Display name of role
maxLength: 128
type: string
sequence:
description: Sequence for sorting
type: integer
status:
description: Status of role (enabled, disabled)
enum:
- disabled
- enabled
type: string
required:
- code
- name
- status
type: object
schema.RoleMenu:
properties:
created_at:
description: Create time
type: string
id:
description: Unique ID
type: string
menu_id:
description: From Menu.ID
type: string
role_id:
description: From Role.ID
type: string
updated_at:
description: Update time
type: string
type: object
schema.Shop:
properties:
content:
type: string
cover:
type: string
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
images:
items:
type: string
type: array
introduce:
type: string
latitude:
type: number
longitude:
type: number
status:
type: string
title:
type: string
updatedAt:
type: string
type: object
schema.ShopForm:
properties:
content:
type: string
cover:
type: string
images:
items:
type: string
type: array
introduce:
type: string
latitude:
type: number
longitude:
type: number
status:
type: string
title:
type: string
type: object
schema.SurroundingService:
properties:
content:
type: string
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
desc:
type: string
id:
type: string
img:
type: string
link:
type: string
sequence:
type: integer
status:
type: string
title:
type: string
typeId:
type: string
updatedAt:
type: string
type: object
schema.SurroundingServiceForm:
properties:
content:
type: string
desc:
type: string
img:
type: string
link:
type: string
sequence:
type: integer
status:
type: string
title:
type: string
typeId:
type: string
type: object
schema.SurroundingServiceType:
properties:
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
name:
type: string
sequence:
type: integer
status:
type: string
updatedAt:
type: string
type: object
schema.SurroundingServiceTypeForm:
properties:
name:
type: string
sequence:
type: integer
status:
type: string
type: object
schema.UpdateCurrentUser:
properties:
email:
description: Email of user
maxLength: 128
type: string
name:
description: Name of user
maxLength: 64
type: string
phone:
description: Phone number of user
maxLength: 32
type: string
remark:
description: Remark of user
maxLength: 1024
type: string
required:
- name
type: object
schema.UpdateLoginPassword:
properties:
new_password:
description: New password (md5 hash)
type: string
old_password:
description: Old password (md5 hash)
type: string
required:
- new_password
- old_password
type: object
schema.User:
properties:
created_at:
description: Create time
type: string
email:
description: Email of user
type: string
id:
description: Unique ID
type: string
name:
description: Name of user
type: string
phone:
description: Phone number of user
type: string
remark:
description: Remark of user
type: string
roles:
description: Roles of user
items:
$ref: '#/definitions/schema.UserRole'
type: array
status:
description: Status of user (activated, freezed)
type: string
updated_at:
description: Update time
type: string
username:
description: Username for login
type: string
type: object
schema.UserForm:
properties:
email:
description: Email of user
maxLength: 128
type: string
name:
description: Name of user
maxLength: 64
type: string
password:
description: Password for login (md5 hash)
maxLength: 64
type: string
phone:
description: Phone number of user
maxLength: 32
type: string
remark:
description: Remark of user
maxLength: 1024
type: string
roles:
description: Roles of user
items:
$ref: '#/definitions/schema.UserRole'
type: array
status:
description: Status of user (activated, freezed)
enum:
- activated
- freezed
type: string
username:
description: Username for login
maxLength: 64
type: string
required:
- name
- roles
- status
- username
type: object
schema.UserRole:
properties:
created_at:
description: Create time
type: string
id:
description: Unique ID
type: string
role_id:
description: From Role.ID
type: string
role_name:
description: From Role.Name
type: string
updated_at:
description: Update time
type: string
user_id:
description: From User.ID
type: string
type: object
schema.WebSite:
properties:
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
phone:
type: string
updatedAt:
type: string
type: object
schema.WebSiteForm:
properties:
phone:
type: string
type: object
schema.WorkOrder:
properties:
content:
type: string
createdAt:
type: string
createdId:
type: string
customerId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
images:
items:
type: string
type: array
records:
items:
$ref: '#/definitions/schema.Record'
type: array
status:
type: string
updatedAt:
type: string
videos:
items:
type: string
type: array
type: object
schema.WorkOrderForm:
properties:
content:
type: string
customerId:
type: string
images:
items:
type: string
type: array
records:
items:
$ref: '#/definitions/schema.Record'
type: array
status:
type: string
videos:
items:
type: string
type: array
type: object
schema.WorkOrderType:
properties:
createdAt:
type: string
createdId:
type: string
deletedAt:
type: integer
deletedId:
type: string
id:
type: string
name:
type: string
sequence:
type: integer
status:
type: string
updatedAt:
type: string
type: object
schema.WorkOrderTypeForm:
properties:
name:
type: string
sequence:
type: integer
status:
type: string
type: object
util.ResponseResult:
properties:
data: {}
error:
$ref: '#/definitions/errors.Error'
success:
type: boolean
total:
type: integer
type: object
info:
contact: {}
description: 近山社区小程序平台
title: jinshan_community
version: v1.0.0
paths:
/api/v1/activities:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Activity'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query activity list
tags:
- ActivityAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ActivityForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Activity'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create activity record
tags:
- ActivityAPI
/api/v1/activities/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete activity record by ID
tags:
- ActivityAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Activity'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get activity record by ID
tags:
- ActivityAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ActivityForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update activity record by ID
tags:
- ActivityAPI
/api/v1/activity-categories:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.ActivityCategory'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query activity category list
tags:
- ActivityCategoryAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ActivityCategoryForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ActivityCategory'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create activity category record
tags:
- ActivityCategoryAPI
/api/v1/activity-categories/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete activity category record by ID
tags:
- ActivityCategoryAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ActivityCategory'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get activity category record by ID
tags:
- ActivityCategoryAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ActivityCategoryForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update activity category record by ID
tags:
- ActivityCategoryAPI
/api/v1/ai-requests:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.AiRequest'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query ai request list
tags:
- AiRequestAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.AiRequestForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.AiRequest'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create ai request record
tags:
- AiRequestAPI
/api/v1/ai-requests/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete ai request record by ID
tags:
- AiRequestAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.AiRequest'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get ai request record by ID
tags:
- AiRequestAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.AiRequestForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update ai request record by ID
tags:
- AiRequestAPI
/api/v1/apps:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.App'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query app list
tags:
- AppAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.AppForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.App'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create app record
tags:
- AppAPI
/api/v1/apps/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete app record by ID
tags:
- AppAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.App'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get app record by ID
tags:
- AppAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.AppForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update app record by ID
tags:
- AppAPI
/api/v1/balances:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Balance'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query balance list
tags:
- BalanceAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.BalanceForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Balance'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create balance record
tags:
- BalanceAPI
/api/v1/balances/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete balance record by ID
tags:
- BalanceAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Balance'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get balance record by ID
tags:
- BalanceAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.BalanceForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update balance record by ID
tags:
- BalanceAPI
/api/v1/banners:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Banner'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query banner list
tags:
- BannerAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.BannerForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Banner'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create banner record
tags:
- BannerAPI
/api/v1/banners/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete banner record by ID
tags:
- BannerAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Banner'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get banner record by ID
tags:
- BannerAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.BannerForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update banner record by ID
tags:
- BannerAPI
/api/v1/captcha/id:
get:
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Captcha'
type: object
summary: Get captcha ID
tags:
- LoginAPI
/api/v1/captcha/image:
get:
parameters:
- description: Captcha ID
in: query
name: id
required: true
type: string
- description: Reload captcha image (reload=1)
in: query
name: reload
type: number
produces:
- image/png
responses:
"200":
description: Captcha image
"404":
description: Not Found
schema:
$ref: '#/definitions/util.ResponseResult'
summary: Response captcha image
tags:
- LoginAPI
/api/v1/current/logout:
post:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Logout system
tags:
- LoginAPI
/api/v1/current/menus:
get:
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Menu'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query current user menus based on the current user role
tags:
- LoginAPI
/api/v1/current/password:
put:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.UpdateLoginPassword'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Change current user password
tags:
- LoginAPI
/api/v1/current/refresh-token:
post:
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.LoginToken'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Refresh current access token
tags:
- LoginAPI
/api/v1/current/user:
get:
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.User'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get current user info
tags:
- LoginAPI
put:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.UpdateCurrentUser'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update current user info
tags:
- LoginAPI
/api/v1/customers:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Customer'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query customer list
tags:
- CustomerAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.CustomerForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Customer'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create customer record
tags:
- CustomerAPI
/api/v1/customers/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete customer record by ID
tags:
- CustomerAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Customer'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get customer record by ID
tags:
- CustomerAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.CustomerForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update customer record by ID
tags:
- CustomerAPI
/api/v1/helps:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Help'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query help list
tags:
- HelpAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.HelpForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Help'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create help record
tags:
- HelpAPI
/api/v1/helps/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete help record by ID
tags:
- HelpAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Help'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get help record by ID
tags:
- HelpAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.HelpForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update help record by ID
tags:
- HelpAPI
/api/v1/loggers:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
- description: log level
in: query
name: level
type: string
- description: trace ID
in: query
name: traceID
type: string
- description: user name
in: query
name: userName
type: string
- description: log tag
in: query
name: tag
type: string
- description: log message
in: query
name: message
type: string
- description: start time
in: query
name: startTime
type: string
- description: end time
in: query
name: endTime
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Logger'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query logger list
tags:
- LoggerAPI
/api/v1/login:
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.LoginForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.LoginToken'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
summary: Login system with username and password
tags:
- LoginAPI
/api/v1/menus:
get:
parameters:
- description: Code path of menu (like xxx.xxx.xxx)
in: query
name: code
type: string
- description: Name of menu
in: query
name: name
type: string
- description: Whether to include menu resources
in: query
name: includeResources
type: boolean
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Menu'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query menu tree data
tags:
- MenuAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.MenuForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Menu'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create menu record
tags:
- MenuAPI
/api/v1/menus/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete menu record by ID
tags:
- MenuAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Menu'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get menu record by ID
tags:
- MenuAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.MenuForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update menu record by ID
tags:
- MenuAPI
/api/v1/metting-room-orders:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.MettingRoomOrder'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query metting room order list
tags:
- MettingRoomOrderAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.MettingRoomOrderForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.MettingRoomOrder'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create metting room order record
tags:
- MettingRoomOrderAPI
/api/v1/metting-room-orders/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete metting room order record by ID
tags:
- MettingRoomOrderAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.MettingRoomOrder'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get metting room order record by ID
tags:
- MettingRoomOrderAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.MettingRoomOrderForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update metting room order record by ID
tags:
- MettingRoomOrderAPI
/api/v1/metting-rooms:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.MettingRoom'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query metting room list
tags:
- MettingRoomAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.MettingRoomForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.MettingRoom'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create metting room record
tags:
- MettingRoomAPI
/api/v1/metting-rooms/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete metting room record by ID
tags:
- MettingRoomAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.MettingRoom'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get metting room record by ID
tags:
- MettingRoomAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.MettingRoomForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update metting room record by ID
tags:
- MettingRoomAPI
/api/v1/notices:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Notice'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query notice list
tags:
- NoticeAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.NoticeForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Notice'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create notice record
tags:
- NoticeAPI
/api/v1/notices/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete notice record by ID
tags:
- NoticeAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Notice'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get notice record by ID
tags:
- NoticeAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.NoticeForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update notice record by ID
tags:
- NoticeAPI
/api/v1/orders:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Order'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query order list
tags:
- OrderAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.OrderForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Order'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create order record
tags:
- OrderAPI
/api/v1/orders/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete order record by ID
tags:
- OrderAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Order'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get order record by ID
tags:
- OrderAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.OrderForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update order record by ID
tags:
- OrderAPI
/api/v1/product-categories:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.ProductCategory'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query product category list
tags:
- ProductCategoryAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ProductCategoryForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ProductCategory'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create product category record
tags:
- ProductCategoryAPI
/api/v1/product-categories/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete product category record by ID
tags:
- ProductCategoryAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ProductCategory'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get product category record by ID
tags:
- ProductCategoryAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ProductCategoryForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update product category record by ID
tags:
- ProductCategoryAPI
/api/v1/products:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Product'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query product list
tags:
- ProductAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ProductForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Product'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create product record
tags:
- ProductAPI
/api/v1/products/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete product record by ID
tags:
- ProductAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Product'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get product record by ID
tags:
- ProductAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ProductForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update product record by ID
tags:
- ProductAPI
/api/v1/reciprocities:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Reciprocity'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query reciprocity list
tags:
- ReciprocityAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ReciprocityForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Reciprocity'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create reciprocity record
tags:
- ReciprocityAPI
/api/v1/reciprocities/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete reciprocity record by ID
tags:
- ReciprocityAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Reciprocity'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get reciprocity record by ID
tags:
- ReciprocityAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ReciprocityForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update reciprocity record by ID
tags:
- ReciprocityAPI
/api/v1/roles:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
- description: Display name of role
in: query
name: name
type: string
- description: Status of role (disabled, enabled)
in: query
name: status
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Role'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query role list
tags:
- RoleAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.RoleForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Role'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create role record
tags:
- RoleAPI
/api/v1/roles/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete role record by ID
tags:
- RoleAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Role'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get role record by ID
tags:
- RoleAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.RoleForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update role record by ID
tags:
- RoleAPI
/api/v1/shops:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Shop'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query shop list
tags:
- ShopAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ShopForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Shop'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create shop record
tags:
- ShopAPI
/api/v1/shops/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete shop record by ID
tags:
- ShopAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Shop'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get shop record by ID
tags:
- ShopAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ShopForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update shop record by ID
tags:
- ShopAPI
/api/v1/surrounding-service-types:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.SurroundingServiceType'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query surrounding service type list
tags:
- SurroundingServiceTypeAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.SurroundingServiceTypeForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.SurroundingServiceType'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create surrounding service type record
tags:
- SurroundingServiceTypeAPI
/api/v1/surrounding-service-types/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete surrounding service type record by ID
tags:
- SurroundingServiceTypeAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.SurroundingServiceType'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get surrounding service type record by ID
tags:
- SurroundingServiceTypeAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.SurroundingServiceTypeForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update surrounding service type record by ID
tags:
- SurroundingServiceTypeAPI
/api/v1/surrounding-services:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.SurroundingService'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query surrounding service list
tags:
- SurroundingServiceAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.SurroundingServiceForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.SurroundingService'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create surrounding service record
tags:
- SurroundingServiceAPI
/api/v1/surrounding-services/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete surrounding service record by ID
tags:
- SurroundingServiceAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.SurroundingService'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get surrounding service record by ID
tags:
- SurroundingServiceAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.SurroundingServiceForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update surrounding service record by ID
tags:
- SurroundingServiceAPI
/api/v1/users:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
- description: Username for login
in: query
name: username
type: string
- description: Name of user
in: query
name: name
type: string
- description: Status of user (activated, freezed)
in: query
name: status
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.User'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query user list
tags:
- UserAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.UserForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.User'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create user record
tags:
- UserAPI
/api/v1/users/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete user record by ID
tags:
- UserAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.User'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get user record by ID
tags:
- UserAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.UserForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update user record by ID
tags:
- UserAPI
/api/v1/users/{id}/reset-pwd:
patch:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Reset user password by ID
tags:
- UserAPI
/api/v1/web-sites:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.WebSite'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query web site list
tags:
- WebSiteAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.WebSiteForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.WebSite'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create web site record
tags:
- WebSiteAPI
/api/v1/web-sites/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete web site record by ID
tags:
- WebSiteAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.WebSite'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get web site record by ID
tags:
- WebSiteAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.WebSiteForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update web site record by ID
tags:
- WebSiteAPI
/api/v1/work-order-types:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.WorkOrderType'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query work order type list
tags:
- WorkOrderTypeAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.WorkOrderTypeForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.WorkOrderType'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create work order type record
tags:
- WorkOrderTypeAPI
/api/v1/work-order-types/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete work order type record by ID
tags:
- WorkOrderTypeAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.WorkOrderType'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get work order type record by ID
tags:
- WorkOrderTypeAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.WorkOrderTypeForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update work order type record by ID
tags:
- WorkOrderTypeAPI
/api/v1/work-orders:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.WorkOrder'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query work order list
tags:
- WorkOrderAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.WorkOrderForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.WorkOrder'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create work order record
tags:
- WorkOrderAPI
/api/v1/work-orders/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete work order record by ID
tags:
- WorkOrderAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.WorkOrder'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get work order record by ID
tags:
- WorkOrderAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.WorkOrderForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update work order record by ID
tags:
- WorkOrderAPI
securityDefinitions:
ApiKeyAuth:
in: header
name: Authorization
type: apiKey
swagger: "2.0"