chore: regenerate swagger docs

This commit is contained in:
2026-01-12 15:44:15 +08:00
parent 4022a776a6
commit 2cf4d379a8
3 changed files with 738 additions and 96 deletions

View File

@@ -101,31 +101,44 @@ definitions:
dto.AdminContentItem:
properties:
content:
$ref: '#/definitions/dto.ContentItem'
allOf:
- $ref: '#/definitions/dto.ContentItem'
description: Content 内容摘要信息。
owner:
$ref: '#/definitions/dto.AdminContentOwnerLite'
allOf:
- $ref: '#/definitions/dto.AdminContentOwnerLite'
description: Owner 内容作者用户信息。
price:
$ref: '#/definitions/dto.ContentPrice'
allOf:
- $ref: '#/definitions/dto.ContentPrice'
description: Price 内容价格信息。
status_description:
description: StatusDescription 状态描述(用于展示)。
type: string
tenant:
allOf:
- $ref: '#/definitions/dto.SuperContentTenantLite'
description: Tenant 内容所属租户信息,用于超管列表展示与跳转。
visibility_description:
description: VisibilityDescription 可见性描述(用于展示)。
type: string
type: object
dto.AdminContentOwnerLite:
properties:
id:
description: ID 用户ID。
type: integer
roles:
description: Roles 用户角色列表。
items:
$ref: '#/definitions/consts.Role'
type: array
status:
$ref: '#/definitions/consts.UserStatus'
allOf:
- $ref: '#/definitions/consts.UserStatus'
description: Status 用户状态。
username:
description: Username 用户名。
type: string
type: object
dto.ApplyForm:
@@ -611,8 +624,10 @@ definitions:
dto.OrderBuyerLite:
properties:
id:
description: ID 买家用户ID。
type: integer
username:
description: Username 买家用户名。
type: string
type: object
dto.OrderCreateForm:
@@ -654,23 +669,31 @@ definitions:
dto.OrderStatisticsResponse:
properties:
by_status:
description: ByStatus 按状态聚合统计。
items:
$ref: '#/definitions/dto.OrderStatisticsRow'
type: array
total_amount_paid_sum:
description: TotalAmountPaidSum 实付总额(分)。
type: integer
total_count:
description: TotalCount 订单总数。
type: integer
type: object
dto.OrderStatisticsRow:
properties:
amount_paid_sum:
description: AmountPaidSum 该状态实付总额(分)。
type: integer
count:
description: Count 该状态订单数量。
type: integer
status:
$ref: '#/definitions/consts.OrderStatus'
allOf:
- $ref: '#/definitions/consts.OrderStatus'
description: Status 订单状态。
status_description:
description: StatusDescription 状态描述(用于展示)。
type: string
type: object
dto.OrderStatusResponse:
@@ -682,10 +705,13 @@ definitions:
dto.OrderTenantLite:
properties:
code:
description: Code 租户编码。
type: string
id:
description: ID 租户ID。
type: integer
name:
description: Name 租户名称。
type: string
type: object
dto.PayoutAccount:
@@ -778,38 +804,54 @@ definitions:
dto.SuperContentTenantLite:
properties:
code:
description: Code 租户编码。
type: string
id:
description: ID 租户ID。
type: integer
name:
description: Name 租户名称。
type: string
type: object
dto.SuperOrderDetail:
properties:
buyer:
$ref: '#/definitions/dto.OrderBuyerLite'
allOf:
- $ref: '#/definitions/dto.OrderBuyerLite'
description: Buyer 订单买家信息。
order:
allOf:
- $ref: '#/definitions/dto.SuperOrderItem'
description: Using SuperOrderItem as base, extend if needed
description: Order 订单详细信息。
tenant:
$ref: '#/definitions/dto.OrderTenantLite'
allOf:
- $ref: '#/definitions/dto.OrderTenantLite'
description: Tenant 订单所属租户信息。
type: object
dto.SuperOrderItem:
properties:
amount_discount:
description: AmountDiscount 优惠金额(分)。
type: integer
amount_original:
description: AmountOriginal 原价金额(分)。
type: integer
amount_paid:
description: AmountPaid 实付金额(分)。
type: integer
buyer:
$ref: '#/definitions/dto.OrderBuyerLite'
allOf:
- $ref: '#/definitions/dto.OrderBuyerLite'
description: Buyer 订单买家信息。
created_at:
description: CreatedAt 创建时间RFC3339
type: string
currency:
$ref: '#/definitions/consts.Currency'
allOf:
- $ref: '#/definitions/consts.Currency'
description: Currency 币种。
id:
description: ID 订单ID。
type: integer
items:
description: Items 订单明细行,用于展示具体内容与金额拆分。
@@ -817,20 +859,30 @@ definitions:
$ref: '#/definitions/dto.SuperOrderItemLine'
type: array
paid_at:
description: PaidAt 支付时间RFC3339
type: string
refunded_at:
description: RefundedAt 退款时间RFC3339
type: string
snapshot:
description: Snapshot 订单快照,包含下单时的关键参数与定价信息,便于审计回溯。
status:
$ref: '#/definitions/consts.OrderStatus'
allOf:
- $ref: '#/definitions/consts.OrderStatus'
description: Status 订单状态。
status_description:
description: StatusDescription 状态描述(用于展示)。
type: string
tenant:
$ref: '#/definitions/dto.OrderTenantLite'
allOf:
- $ref: '#/definitions/dto.OrderTenantLite'
description: Tenant 订单所属租户信息。
type:
$ref: '#/definitions/consts.OrderType'
allOf:
- $ref: '#/definitions/consts.OrderType'
description: Type 订单类型。
updated_at:
description: UpdatedAt 更新时间RFC3339
type: string
type: object
dto.SuperOrderItemLine:
@@ -850,10 +902,13 @@ definitions:
dto.SuperOrderRefundForm:
properties:
force:
description: Force 是否强制退款(忽略部分约束)。
type: boolean
idempotency_key:
description: IdempotencyKey 幂等键(防止重复提交)。
type: string
reason:
description: Reason 退款原因说明。
type: string
type: object
dto.SuperTenantContentStatusUpdateForm:
@@ -861,6 +916,7 @@ definitions:
status:
allOf:
- $ref: '#/definitions/consts.ContentStatus'
description: Status 目标内容状态。
enum:
- unpublished
- blocked
@@ -870,46 +926,64 @@ definitions:
dto.SuperTenantUserItem:
properties:
tenant_user:
$ref: '#/definitions/dto.TenantUser'
allOf:
- $ref: '#/definitions/dto.TenantUser'
description: TenantUser 租户成员关系信息。
user:
$ref: '#/definitions/dto.SuperUserLite'
allOf:
- $ref: '#/definitions/dto.SuperUserLite'
description: User 用户信息。
type: object
dto.SuperUserLite:
properties:
created_at:
description: CreatedAt 创建时间RFC3339
type: string
id:
description: ID 用户ID。
type: integer
roles:
description: Roles 用户角色列表。
items:
$ref: '#/definitions/consts.Role'
type: array
status:
$ref: '#/definitions/consts.UserStatus'
allOf:
- $ref: '#/definitions/consts.UserStatus'
description: Status 用户状态。
status_description:
description: StatusDescription 状态描述(用于展示)。
type: string
updated_at:
description: UpdatedAt 更新时间RFC3339
type: string
username:
description: Username 用户名(用于识别/展示)。
type: string
verified_at:
description: VerifiedAt 实名认证时间RFC3339
type: string
type: object
dto.TenantAdminUserLite:
properties:
id:
description: ID 用户ID。
type: integer
username:
description: Username 用户名。
type: string
type: object
dto.TenantCreateForm:
properties:
admin_user_id:
description: AdminUserID 租户管理员用户ID。
type: integer
code:
description: Code 租户编码(唯一)。
maxLength: 64
type: string
duration:
description: Duration 租户有效期(天)。
enum:
- 7
- 30
@@ -918,6 +992,7 @@ definitions:
- 365
type: integer
name:
description: Name 租户名称。
maxLength: 128
type: string
required:
@@ -929,6 +1004,7 @@ definitions:
dto.TenantExpireUpdateForm:
properties:
duration:
description: Duration 延长有效期(天)。
enum:
- 7
- 30
@@ -942,50 +1018,69 @@ definitions:
dto.TenantItem:
properties:
admin_users:
description: AdminUsers 租户管理员列表。
items:
$ref: '#/definitions/dto.TenantAdminUserLite'
type: array
code:
description: Code 租户编码。
type: string
config:
description: Replace with actual config struct if needed
description: Config 租户配置项(占位/需要结构化时替换)。
items:
type: integer
type: array
created_at:
description: CreatedAt 创建时间RFC3339
type: string
expired_at:
description: ExpiredAt 租户过期时间RFC3339
type: string
id:
description: ID 租户ID。
type: integer
income_amount_paid_sum:
description: IncomeAmountPaidSum 累计实收金额(分)。
type: integer
name:
description: Name 租户名称。
type: string
owner:
$ref: '#/definitions/dto.TenantOwnerUserLite'
allOf:
- $ref: '#/definitions/dto.TenantOwnerUserLite'
description: Owner 租户所有者信息。
status:
$ref: '#/definitions/consts.TenantStatus'
allOf:
- $ref: '#/definitions/consts.TenantStatus'
description: Status 租户状态。
status_description:
description: StatusDescription 租户状态描述。
type: string
updated_at:
description: UpdatedAt 更新时间RFC3339
type: string
user_count:
description: UserCount 租户成员数量。
type: integer
user_id:
description: UserID 创建者用户ID。
type: integer
users:
description: Users 租户成员列表(用于详情展示)。
items:
$ref: '#/definitions/dto.SuperUserLite'
type: array
uuid:
description: UUID 租户UUID。
type: string
type: object
dto.TenantOwnerUserLite:
properties:
id:
description: ID 用户ID。
type: integer
username:
description: Username 用户名。
type: string
type: object
dto.TenantProfile:
@@ -1022,27 +1117,37 @@ definitions:
dto.TenantStatusUpdateForm:
properties:
status:
$ref: '#/definitions/consts.TenantStatus'
allOf:
- $ref: '#/definitions/consts.TenantStatus'
description: Status 目标租户状态。
required:
- status
type: object
dto.TenantUser:
properties:
created_at:
description: CreatedAt 创建时间RFC3339
type: string
id:
description: ID 成员记录ID。
type: integer
role:
description: Role 成员角色列表。
items:
$ref: '#/definitions/consts.TenantUserRole'
type: array
status:
$ref: '#/definitions/consts.UserStatus'
allOf:
- $ref: '#/definitions/consts.UserStatus'
description: Status 成员状态。
tenant_id:
description: TenantID 租户ID。
type: integer
updated_at:
description: UpdatedAt 更新时间RFC3339
type: string
user_id:
description: UserID 用户ID。
type: integer
type: object
dto.Topic:
@@ -1171,35 +1276,49 @@ definitions:
dto.UserItem:
properties:
balance:
description: Balance 账户可用余额(分)。
type: integer
balance_frozen:
description: BalanceFrozen 账户冻结余额(分)。
type: integer
created_at:
description: CreatedAt 创建时间RFC3339
type: string
id:
description: ID 用户ID。
type: integer
joined_tenant_count:
description: JoinedTenantCount 加入的租户数量。
type: integer
owned_tenant_count:
description: OwnedTenantCount 拥有的租户数量。
type: integer
roles:
description: Roles 用户角色列表。
items:
$ref: '#/definitions/consts.Role'
type: array
status:
$ref: '#/definitions/consts.UserStatus'
allOf:
- $ref: '#/definitions/consts.UserStatus'
description: Status 用户状态。
status_description:
description: StatusDescription 状态描述(用于展示)。
type: string
updated_at:
description: UpdatedAt 更新时间RFC3339
type: string
username:
description: Username 用户名(用于识别/展示)。
type: string
verified_at:
description: VerifiedAt 实名认证时间RFC3339
type: string
type: object
dto.UserRolesUpdateForm:
properties:
roles:
description: Roles 目标角色列表(至少包含 1 个)。
items:
$ref: '#/definitions/consts.Role'
minItems: 1
@@ -1210,44 +1329,64 @@ definitions:
dto.UserStatistics:
properties:
count:
description: Count 该状态用户数量。
type: integer
status:
$ref: '#/definitions/consts.UserStatus'
allOf:
- $ref: '#/definitions/consts.UserStatus'
description: Status 用户状态枚举。
status_description:
description: StatusDescription 状态描述(用于展示)。
type: string
type: object
dto.UserStatusUpdateForm:
properties:
status:
$ref: '#/definitions/consts.UserStatus'
allOf:
- $ref: '#/definitions/consts.UserStatus'
description: Status 目标用户状态。
required:
- status
type: object
dto.UserTenantItem:
properties:
code:
description: Code 租户编码。
type: string
expired_at:
description: ExpiredAt 租户过期时间RFC3339
type: string
joined_at:
description: JoinedAt 加入时间RFC3339
type: string
member_status:
$ref: '#/definitions/consts.UserStatus'
allOf:
- $ref: '#/definitions/consts.UserStatus'
description: MemberStatus 成员状态。
member_status_description:
description: MemberStatusDescription 成员状态描述。
type: string
name:
description: Name 租户名称。
type: string
owner:
$ref: '#/definitions/dto.TenantOwnerUserLite'
allOf:
- $ref: '#/definitions/dto.TenantOwnerUserLite'
description: Owner 租户所有者用户信息。
role:
description: Role 用户在该租户内的角色列表。
items:
$ref: '#/definitions/consts.TenantUserRole'
type: array
tenant_id:
description: TenantID 租户ID。
type: integer
tenant_status:
$ref: '#/definitions/consts.TenantStatus'
allOf:
- $ref: '#/definitions/consts.TenantStatus'
description: TenantStatus 租户状态。
tenant_status_description:
description: TenantStatusDescription 租户状态描述。
type: string
type: object
dto.UserUpdate:
@@ -1299,48 +1438,67 @@ definitions:
quyun_v2_app_http_super_v1_dto.Location:
properties:
city:
description: City 城市名称。
type: string
province:
description: Province 省份名称。
type: string
type: object
quyun_v2_app_http_super_v1_dto.LoginForm:
properties:
password:
description: Password 登录密码(加密传输)。
type: string
username:
description: Username 登录用户名。
type: string
type: object
quyun_v2_app_http_super_v1_dto.LoginResponse:
properties:
token:
description: Token 登录后签发的 JWT。
type: string
user:
$ref: '#/definitions/quyun_v2_app_http_super_v1_dto.User'
allOf:
- $ref: '#/definitions/quyun_v2_app_http_super_v1_dto.User'
description: User 当前登录用户信息。
type: object
quyun_v2_app_http_super_v1_dto.User:
properties:
avatar:
description: Avatar 头像URL。
type: string
balance:
description: Balance 账户余额(元)。
type: number
bio:
description: Bio 用户简介。
type: string
birthday:
description: YYYY-MM-DD
description: Birthday 生日(YYYY-MM-DD)。
type: string
gender:
$ref: '#/definitions/consts.Gender'
allOf:
- $ref: '#/definitions/consts.Gender'
description: Gender 性别male/female/secret
id:
description: ID 用户ID。
type: integer
is_real_name_verified:
description: IsRealNameVerified 是否已实名认证。
type: boolean
location:
$ref: '#/definitions/quyun_v2_app_http_super_v1_dto.Location'
allOf:
- $ref: '#/definitions/quyun_v2_app_http_super_v1_dto.Location'
description: Location 所在地(省/市)。
nickname:
description: Nickname 用户昵称。
type: string
phone:
description: Phone 手机号。
type: string
points:
description: Points 用户积分。
type: integer
type: object
quyun_v2_app_http_v1_dto.Location:
@@ -2681,7 +2839,7 @@ paths:
- application/json
description: List contents of a specific creator
parameters:
- description: Tenant ID
- description: Creator User ID
format: int64
in: path
name: id