Skip to content

Commit 4af23d6

Browse files
committed
fix: add hidden query parameter to swagger
1 parent 5bad1c5 commit 4af23d6

File tree

6 files changed

+59
-8
lines changed

6 files changed

+59
-8
lines changed

api/docs.go

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,15 +123,21 @@ const docTemplate = `{
123123
},
124124
{
125125
"type": "boolean",
126-
"description": "Filter by on/off-budget",
126+
"description": "Is the account on-budget?",
127127
"name": "onBudget",
128128
"in": "query"
129129
},
130130
{
131131
"type": "boolean",
132-
"description": "Filter internal/external",
132+
"description": "Is the account external?",
133133
"name": "external",
134134
"in": "query"
135+
},
136+
{
137+
"type": "boolean",
138+
"description": "Is the account hidden?",
139+
"name": "hidden",
140+
"in": "query"
135141
}
136142
],
137143
"responses": {
@@ -1193,6 +1199,12 @@ const docTemplate = `{
11931199
"description": "Filter by budget ID",
11941200
"name": "budget",
11951201
"in": "query"
1202+
},
1203+
{
1204+
"type": "boolean",
1205+
"description": "Is the category hidden?",
1206+
"name": "hidden",
1207+
"in": "query"
11961208
}
11971209
],
11981210
"responses": {
@@ -1477,6 +1489,12 @@ const docTemplate = `{
14771489
"description": "Filter by category ID",
14781490
"name": "category",
14791491
"in": "query"
1492+
},
1493+
{
1494+
"type": "boolean",
1495+
"description": "Is the envelope hidden?",
1496+
"name": "hidden",
1497+
"in": "query"
14801498
}
14811499
],
14821500
"responses": {

api/swagger.json

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,15 +111,21 @@
111111
},
112112
{
113113
"type": "boolean",
114-
"description": "Filter by on/off-budget",
114+
"description": "Is the account on-budget?",
115115
"name": "onBudget",
116116
"in": "query"
117117
},
118118
{
119119
"type": "boolean",
120-
"description": "Filter internal/external",
120+
"description": "Is the account external?",
121121
"name": "external",
122122
"in": "query"
123+
},
124+
{
125+
"type": "boolean",
126+
"description": "Is the account hidden?",
127+
"name": "hidden",
128+
"in": "query"
123129
}
124130
],
125131
"responses": {
@@ -1181,6 +1187,12 @@
11811187
"description": "Filter by budget ID",
11821188
"name": "budget",
11831189
"in": "query"
1190+
},
1191+
{
1192+
"type": "boolean",
1193+
"description": "Is the category hidden?",
1194+
"name": "hidden",
1195+
"in": "query"
11841196
}
11851197
],
11861198
"responses": {
@@ -1465,6 +1477,12 @@
14651477
"description": "Filter by category ID",
14661478
"name": "category",
14671479
"in": "query"
1480+
},
1481+
{
1482+
"type": "boolean",
1483+
"description": "Is the envelope hidden?",
1484+
"name": "hidden",
1485+
"in": "query"
14681486
}
14691487
],
14701488
"responses": {

api/swagger.yaml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -915,14 +915,18 @@ paths:
915915
in: query
916916
name: budget
917917
type: string
918-
- description: Filter by on/off-budget
918+
- description: Is the account on-budget?
919919
in: query
920920
name: onBudget
921921
type: boolean
922-
- description: Filter internal/external
922+
- description: Is the account external?
923923
in: query
924924
name: external
925925
type: boolean
926+
- description: Is the account hidden?
927+
in: query
928+
name: hidden
929+
type: boolean
926930
produces:
927931
- application/json
928932
responses:
@@ -1645,6 +1649,10 @@ paths:
16451649
in: query
16461650
name: budget
16471651
type: string
1652+
- description: Is the category hidden?
1653+
in: query
1654+
name: hidden
1655+
type: boolean
16481656
produces:
16491657
- application/json
16501658
responses:
@@ -1836,6 +1844,10 @@ paths:
18361844
in: query
18371845
name: category
18381846
type: string
1847+
- description: Is the envelope hidden?
1848+
in: query
1849+
name: hidden
1850+
type: boolean
18391851
produces:
18401852
- application/json
18411853
responses:

pkg/controllers/account.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,9 @@ func (co Controller) CreateAccount(c *gin.Context) {
157157
// @Param name query string false "Filter by name"
158158
// @Param note query string false "Filter by note"
159159
// @Param budget query string false "Filter by budget ID"
160-
// @Param onBudget query bool false "Filter by on/off-budget"
161-
// @Param external query bool false "Filter internal/external"
160+
// @Param onBudget query bool false "Is the account on-budget?"
161+
// @Param external query bool false "Is the account external?"
162+
// @Param hidden query bool false "Is the account hidden?"
162163
func (co Controller) GetAccounts(c *gin.Context) {
163164
var filter AccountQueryFilter
164165
if err := c.Bind(&filter); err != nil {

pkg/controllers/category.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ func (co Controller) CreateCategory(c *gin.Context) {
153153
// @Param name query string false "Filter by name"
154154
// @Param note query string false "Filter by note"
155155
// @Param budget query string false "Filter by budget ID"
156+
// @Param hidden query bool false "Is the category hidden?"
156157
func (co Controller) GetCategories(c *gin.Context) {
157158
var filter CategoryQueryFilter
158159

pkg/controllers/envelope.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ func (co Controller) CreateEnvelope(c *gin.Context) {
157157
// @Param name query string false "Filter by name"
158158
// @Param note query string false "Filter by note"
159159
// @Param category query string false "Filter by category ID"
160+
// @Param hidden query bool false "Is the envelope hidden?"
160161
func (co Controller) GetEnvelopes(c *gin.Context) {
161162
var filter EnvelopeQueryFilter
162163

0 commit comments

Comments
 (0)