Skip to content

Commit 4ad86e2

Browse files
65436543
committed
refactor swagger options/definitions
1 parent 82557ce commit 4ad86e2

File tree

5 files changed

+41
-51
lines changed

5 files changed

+41
-51
lines changed

‎modules/structs/issue_reaction.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ type EditReactionOption struct {
1313
Reaction string `json:"content"`
1414
}
1515

16-
// ReactionResponse contain one reaction
17-
type ReactionResponse struct {
16+
// Reaction contain one reaction
17+
type Reaction struct {
1818
User *User `json:"user"`
1919
Reaction string `json:"content"`
2020
// swagger:strfmt date-time

‎routers/api/v1/repo/issue_reaction.go

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func GetIssueCommentReactions(ctx *context.APIContext) {
4141
// required: true
4242
// responses:
4343
// "200":
44-
// "$ref": "#/responses/ReactionResponseList"
44+
// "$ref": "#/responses/ReactionList"
4545
// "403":
4646
// "$ref": "#/responses/forbidden"
4747

@@ -71,9 +71,9 @@ func GetIssueCommentReactions(ctx *context.APIContext) {
7171
return
7272
}
7373

74-
var result []api.ReactionResponse
74+
var result []api.Reaction
7575
for _, r := range reactions {
76-
result = append(result, api.ReactionResponse{
76+
result = append(result, api.Reaction{
7777
User: r.User.APIFormat(),
7878
Reaction: r.Type,
7979
Created: r.CreatedUnix.AsTime(),
@@ -116,10 +116,10 @@ func PostIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOpti
116116
// responses:
117117
// "200":
118118
// description: reaction already exist
119-
// "$ref": "#/responses/ReactionResponse"
119+
// "$ref": "#/responses/Reaction"
120120
// "201":
121121
// description: reaction created successfully
122-
// "$ref": "#/responses/ReactionResponse"
122+
// "$ref": "#/responses/Reaction"
123123
// "403":
124124
// "$ref": "#/responses/forbidden"
125125

@@ -193,7 +193,7 @@ func changeIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOp
193193
if models.IsErrForbiddenIssueReaction(err) {
194194
ctx.Error(http.StatusForbidden, err.Error(), err)
195195
} else if models.IsErrReactionAlreadyExist(err) {
196-
ctx.JSON(http.StatusOK, api.ReactionResponse{
196+
ctx.JSON(http.StatusOK, api.Reaction{
197197
User: ctx.User.APIFormat(),
198198
Reaction: reaction.Type,
199199
Created: reaction.CreatedUnix.AsTime(),
@@ -204,7 +204,7 @@ func changeIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOp
204204
return
205205
}
206206

207-
ctx.JSON(http.StatusCreated, api.ReactionResponse{
207+
ctx.JSON(http.StatusCreated, api.Reaction{
208208
User: ctx.User.APIFormat(),
209209
Reaction: reaction.Type,
210210
Created: reaction.CreatedUnix.AsTime(),
@@ -249,7 +249,7 @@ func GetIssueReactions(ctx *context.APIContext) {
249249
// required: true
250250
// responses:
251251
// "200":
252-
// "$ref": "#/responses/ReactionResponseList"
252+
// "$ref": "#/responses/ReactionList"
253253
// "403":
254254
// "$ref": "#/responses/forbidden"
255255

@@ -279,9 +279,9 @@ func GetIssueReactions(ctx *context.APIContext) {
279279
return
280280
}
281281

282-
var result []api.ReactionResponse
282+
var result []api.Reaction
283283
for _, r := range reactions {
284-
result = append(result, api.ReactionResponse{
284+
result = append(result, api.Reaction{
285285
User: r.User.APIFormat(),
286286
Reaction: r.Type,
287287
Created: r.CreatedUnix.AsTime(),
@@ -324,10 +324,10 @@ func PostIssueReaction(ctx *context.APIContext, form api.EditReactionOption) {
324324
// responses:
325325
// "200":
326326
// description: reaction already exist
327-
// "$ref": "#/responses/ReactionResponse"
327+
// "$ref": "#/responses/Reaction"
328328
// "201":
329329
// description: reaction created successfully
330-
// "$ref": "#/responses/ReactionResponse"
330+
// "$ref": "#/responses/Reaction"
331331
// "403":
332332
// "$ref": "#/responses/forbidden"
333333

@@ -396,7 +396,7 @@ func changeIssueReaction(ctx *context.APIContext, form api.EditReactionOption, i
396396
if models.IsErrForbiddenIssueReaction(err) {
397397
ctx.Error(http.StatusForbidden, err.Error(), err)
398398
} else if models.IsErrReactionAlreadyExist(err) {
399-
ctx.JSON(http.StatusOK, api.ReactionResponse{
399+
ctx.JSON(http.StatusOK, api.Reaction{
400400
User: ctx.User.APIFormat(),
401401
Reaction: reaction.Type,
402402
Created: reaction.CreatedUnix.AsTime(),
@@ -407,7 +407,7 @@ func changeIssueReaction(ctx *context.APIContext, form api.EditReactionOption, i
407407
return
408408
}
409409

410-
ctx.JSON(http.StatusCreated, api.ReactionResponse{
410+
ctx.JSON(http.StatusCreated, api.Reaction{
411411
User: ctx.User.APIFormat(),
412412
Reaction: reaction.Type,
413413
Created: reaction.CreatedUnix.AsTime(),

‎routers/api/v1/swagger/issue.go

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -99,23 +99,16 @@ type swaggerResponseStopWatchList struct {
9999
Body []api.StopWatch `json:"body"`
100100
}
101101

102-
// EditReactionOption
103-
// swagger:response EditReactionOption
104-
type swaggerEditReactionOption struct {
102+
// Reaction
103+
// swagger:response Reaction
104+
type swaggerReaction struct {
105105
// in:body
106-
Body api.EditReactionOption `json:"body"`
106+
Body api.Reaction `json:"body"`
107107
}
108108

109-
// ReactionResponse
110-
// swagger:response ReactionResponse
111-
type swaggerReactionResponse struct {
109+
// ReactionList
110+
// swagger:response ReactionList
111+
type swaggerReactionList struct {
112112
// in:body
113-
Body api.ReactionResponse `json:"body"`
114-
}
115-
116-
// ReactionResponseList
117-
// swagger:response ReactionResponseList
118-
type swaggerReactionResponseList struct {
119-
// in:body
120-
Body []api.ReactionResponse `json:"body"`
113+
Body []api.Reaction `json:"body"`
121114
}

‎routers/api/v1/swagger/options.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,7 @@ type swaggerParameterBodies struct {
123123

124124
// in:body
125125
RepoTopicOptions api.RepoTopicOptions
126+
127+
// in:body
128+
EditReactionOption api.EditReactionOption
126129
}

‎templates/swagger/v1_json.tmpl

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3130,7 +3130,7 @@
31303130
],
31313131
"responses": {
31323132
"200": {
3133-
"$ref": "#/responses/ReactionResponseList"
3133+
"$ref": "#/responses/ReactionList"
31343134
},
31353135
"403": {
31363136
"$ref": "#/responses/forbidden"
@@ -3183,11 +3183,11 @@
31833183
"responses": {
31843184
"200": {
31853185
"description": "reaction already exist",
3186-
"$ref": "#/responses/ReactionResponse"
3186+
"$ref": "#/responses/Reaction"
31873187
},
31883188
"201": {
31893189
"description": "reaction created successfully",
3190-
"$ref": "#/responses/ReactionResponse"
3190+
"$ref": "#/responses/Reaction"
31913191
},
31923192
"403": {
31933193
"$ref": "#/responses/forbidden"
@@ -3901,7 +3901,7 @@
39013901
],
39023902
"responses": {
39033903
"200": {
3904-
"$ref": "#/responses/ReactionResponseList"
3904+
"$ref": "#/responses/ReactionList"
39053905
},
39063906
"403": {
39073907
"$ref": "#/responses/forbidden"
@@ -3954,11 +3954,11 @@
39543954
"responses": {
39553955
"200": {
39563956
"description": "reaction already exist",
3957-
"$ref": "#/responses/ReactionResponse"
3957+
"$ref": "#/responses/Reaction"
39583958
},
39593959
"201": {
39603960
"description": "reaction created successfully",
3961-
"$ref": "#/responses/ReactionResponse"
3961+
"$ref": "#/responses/Reaction"
39623962
},
39633963
"403": {
39643964
"$ref": "#/responses/forbidden"
@@ -10825,7 +10825,7 @@
1082510825
},
1082610826
"x-go-package": "code.gitea.io/gitea/modules/structs"
1082710827
},
10828-
"ReactionResponse": {
10828+
"Reaction": {
1082910829
"description": "ReactionResponse contain one reaction",
1083010830
"type": "object",
1083110831
"properties": {
@@ -11738,12 +11738,6 @@
1173811738
}
1173911739
}
1174011740
},
11741-
"EditReactionOption": {
11742-
"description": "EditReactionOption",
11743-
"schema": {
11744-
"$ref": "#/definitions/EditReactionOption"
11745-
}
11746-
},
1174711741
"EmailList": {
1174811742
"description": "EmailList",
1174911743
"schema": {
@@ -11930,18 +11924,18 @@
1193011924
}
1193111925
}
1193211926
},
11933-
"ReactionResponse": {
11934-
"description": "ReactionResponse",
11927+
"Reaction": {
11928+
"description": "Reaction",
1193511929
"schema": {
11936-
"$ref": "#/definitions/ReactionResponse"
11930+
"$ref": "#/definitions/Reaction"
1193711931
}
1193811932
},
11939-
"ReactionResponseList": {
11940-
"description": "ReactionResponseList",
11933+
"ReactionList": {
11934+
"description": "ReactionList",
1194111935
"schema": {
1194211936
"type": "array",
1194311937
"items": {
11944-
"$ref": "#/definitions/ReactionResponse"
11938+
"$ref": "#/definitions/Reaction"
1194511939
}
1194611940
}
1194711941
},
@@ -12167,7 +12161,7 @@
1216712161
"parameterBodies": {
1216812162
"description": "parameterBodies",
1216912163
"schema": {
12170-
"$ref": "#/definitions/RepoTopicOptions"
12164+
"$ref": "#/definitions/EditReactionOption"
1217112165
}
1217212166
},
1217312167
"redirect": {

0 commit comments

Comments
 (0)