Skip to content

Commit 197c85d

Browse files
committed
chore(docs): add frozen status and statistics fields to the documentation template.
1 parent d0e27bd commit 197c85d

File tree

3 files changed

+38
-0
lines changed

3 files changed

+38
-0
lines changed

docs/docs.go

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3534,6 +3534,10 @@ const docTemplate = `{
35343534
"type": "integer",
35353535
"minimum": 1
35363536
},
3537+
"frozen": {
3538+
"description": "admin only",
3539+
"type": "boolean"
3540+
},
35373541
"hidden": {
35383542
"description": "Admin only",
35393543
"type": "boolean"
@@ -3785,6 +3789,9 @@ const docTemplate = `{
37853789
"description": "所属 division 的 id",
37863790
"type": "integer"
37873791
},
3792+
"favorite_count": {
3793+
"type": "integer"
3794+
},
37883795
"floors": {
37893796
"description": "返回给前端的楼层列表,包括首楼、尾楼和预加载的前 n 个楼层",
37903797
"type": "object",
@@ -3814,6 +3821,10 @@ const docTemplate = `{
38143821
}
38153822
}
38163823
},
3824+
"frozen": {
3825+
"description": "冻结帖子,如果冻结则发帖不会更新 UpdatedAt",
3826+
"type": "boolean"
3827+
},
38173828
"good": {
38183829
"type": "boolean"
38193830
},
@@ -3840,6 +3851,9 @@ const docTemplate = `{
38403851
"description": "回复量(即该洞下 floor 的数量 - 1)",
38413852
"type": "integer"
38423853
},
3854+
"subscription_count": {
3855+
"type": "integer"
3856+
},
38433857
"tags": {
38443858
"description": "tag 列表;不超过 10 个",
38453859
"type": "array",

docs/swagger.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3527,6 +3527,10 @@
35273527
"type": "integer",
35283528
"minimum": 1
35293529
},
3530+
"frozen": {
3531+
"description": "admin only",
3532+
"type": "boolean"
3533+
},
35303534
"hidden": {
35313535
"description": "Admin only",
35323536
"type": "boolean"
@@ -3778,6 +3782,9 @@
37783782
"description": "所属 division 的 id",
37793783
"type": "integer"
37803784
},
3785+
"favorite_count": {
3786+
"type": "integer"
3787+
},
37813788
"floors": {
37823789
"description": "返回给前端的楼层列表,包括首楼、尾楼和预加载的前 n 个楼层",
37833790
"type": "object",
@@ -3807,6 +3814,10 @@
38073814
}
38083815
}
38093816
},
3817+
"frozen": {
3818+
"description": "冻结帖子,如果冻结则发帖不会更新 UpdatedAt",
3819+
"type": "boolean"
3820+
},
38103821
"good": {
38113822
"type": "boolean"
38123823
},
@@ -3833,6 +3844,9 @@
38333844
"description": "回复量(即该洞下 floor 的数量 - 1)",
38343845
"type": "integer"
38353846
},
3847+
"subscription_count": {
3848+
"type": "integer"
3849+
},
38363850
"tags": {
38373851
"description": "tag 列表;不超过 10 个",
38383852
"type": "array",

docs/swagger.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,9 @@ definitions:
303303
description: Admin and owner only
304304
minimum: 1
305305
type: integer
306+
frozen:
307+
description: admin only
308+
type: boolean
306309
hidden:
307310
description: Admin only
308311
type: boolean
@@ -482,6 +485,8 @@ definitions:
482485
division_id:
483486
description: 所属 division 的 id
484487
type: integer
488+
favorite_count:
489+
type: integer
485490
floors:
486491
description: 返回给前端的楼层列表,包括首楼、尾楼和预加载的前 n 个楼层
487492
properties:
@@ -499,6 +504,9 @@ definitions:
499504
$ref: '#/definitions/models.Floor'
500505
type: array
501506
type: object
507+
frozen:
508+
description: 冻结帖子,如果冻结则发帖不会更新 UpdatedAt
509+
type: boolean
502510
good:
503511
type: boolean
504512
hidden:
@@ -518,6 +526,8 @@ definitions:
518526
reply:
519527
description: 回复量(即该洞下 floor 的数量 - 1)
520528
type: integer
529+
subscription_count:
530+
type: integer
521531
tags:
522532
description: tag 列表;不超过 10 个
523533
items:

0 commit comments

Comments
 (0)