Skip to content

Commit bcac7cb

Browse files
6543lafriks
authored andcommitted
fix swagger description of reaction API (#9617)
1 parent 2a1cf5b commit bcac7cb

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

routers/api/v1/repo/issue_reaction.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ import (
1313
api "code.gitea.io/gitea/modules/structs"
1414
)
1515

16-
// GetIssueCommentReactions list reactions of a issue comment
16+
// GetIssueCommentReactions list reactions of a comment from an issue
1717
func GetIssueCommentReactions(ctx *context.APIContext) {
1818
// swagger:operation GET /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issueGetCommentReactions
1919
// ---
20-
// summary: Get a list reactions of a issue comment
20+
// summary: Get a list of reactions from a comment of an issue
2121
// consumes:
2222
// - application/json
2323
// produces:
@@ -83,11 +83,11 @@ func GetIssueCommentReactions(ctx *context.APIContext) {
8383
ctx.JSON(http.StatusOK, result)
8484
}
8585

86-
// PostIssueCommentReaction add a reaction to a comment of a issue
86+
// PostIssueCommentReaction add a reaction to a comment of an issue
8787
func PostIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOption) {
8888
// swagger:operation POST /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issuePostCommentReaction
8989
// ---
90-
// summary: Add a reaction to a comment of a issue comment
90+
// summary: Add a reaction to a comment of an issue
9191
// consumes:
9292
// - application/json
9393
// produces:
@@ -124,11 +124,11 @@ func PostIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOpti
124124
changeIssueCommentReaction(ctx, form, true)
125125
}
126126

127-
// DeleteIssueCommentReaction list reactions of a issue comment
127+
// DeleteIssueCommentReaction remove a reaction from a comment of an issue
128128
func DeleteIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOption) {
129129
// swagger:operation DELETE /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issueDeleteCommentReaction
130130
// ---
131-
// summary: Remove a reaction from a comment of a issue comment
131+
// summary: Remove a reaction from a comment of an issue
132132
// consumes:
133133
// - application/json
134134
// produces:
@@ -219,11 +219,11 @@ func changeIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOp
219219
}
220220
}
221221

222-
// GetIssueReactions list reactions of a issue comment
222+
// GetIssueReactions list reactions of an issue
223223
func GetIssueReactions(ctx *context.APIContext) {
224224
// swagger:operation GET /repos/{owner}/{repo}/issues/{index}/reactions issue issueGetIssueReactions
225225
// ---
226-
// summary: Get a list reactions of a issue
226+
// summary: Get a list reactions of an issue
227227
// consumes:
228228
// - application/json
229229
// produces:
@@ -289,11 +289,11 @@ func GetIssueReactions(ctx *context.APIContext) {
289289
ctx.JSON(http.StatusOK, result)
290290
}
291291

292-
// PostIssueReaction add a reaction to a comment of a issue
292+
// PostIssueReaction add a reaction to an issue
293293
func PostIssueReaction(ctx *context.APIContext, form api.EditReactionOption) {
294294
// swagger:operation POST /repos/{owner}/{repo}/issues/{index}/reactions issue issuePostIssueReaction
295295
// ---
296-
// summary: Add a reaction to a comment of a issue
296+
// summary: Add a reaction to an issue
297297
// consumes:
298298
// - application/json
299299
// produces:
@@ -330,11 +330,11 @@ func PostIssueReaction(ctx *context.APIContext, form api.EditReactionOption) {
330330
changeIssueReaction(ctx, form, true)
331331
}
332332

333-
// DeleteIssueReaction list reactions of a issue comment
333+
// DeleteIssueReaction remove a reaction from an issue
334334
func DeleteIssueReaction(ctx *context.APIContext, form api.EditReactionOption) {
335335
// swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/reactions issue issueDeleteIssueReaction
336336
// ---
337-
// summary: Remove a reaction from a comment of a issue
337+
// summary: Remove a reaction from an issue
338338
// consumes:
339339
// - application/json
340340
// produces:

templates/swagger/v1_json.tmpl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3102,7 +3102,7 @@
31023102
"tags": [
31033103
"issue"
31043104
],
3105-
"summary": "Get a list reactions of a issue comment",
3105+
"summary": "Get a list of reactions from a comment of an issue",
31063106
"operationId": "issueGetCommentReactions",
31073107
"parameters": [
31083108
{
@@ -3147,7 +3147,7 @@
31473147
"tags": [
31483148
"issue"
31493149
],
3150-
"summary": "Add a reaction to a comment of a issue comment",
3150+
"summary": "Add a reaction to a comment of an issue",
31513151
"operationId": "issuePostCommentReaction",
31523152
"parameters": [
31533153
{
@@ -3202,7 +3202,7 @@
32023202
"tags": [
32033203
"issue"
32043204
],
3205-
"summary": "Remove a reaction from a comment of a issue comment",
3205+
"summary": "Remove a reaction from a comment of an issue",
32063206
"operationId": "issueDeleteCommentReaction",
32073207
"parameters": [
32083208
{
@@ -3871,7 +3871,7 @@
38713871
"tags": [
38723872
"issue"
38733873
],
3874-
"summary": "Get a list reactions of a issue",
3874+
"summary": "Get a list reactions of an issue",
38753875
"operationId": "issueGetIssueReactions",
38763876
"parameters": [
38773877
{
@@ -3916,7 +3916,7 @@
39163916
"tags": [
39173917
"issue"
39183918
],
3919-
"summary": "Add a reaction to a comment of a issue",
3919+
"summary": "Add a reaction to an issue",
39203920
"operationId": "issuePostIssueReaction",
39213921
"parameters": [
39223922
{
@@ -3971,7 +3971,7 @@
39713971
"tags": [
39723972
"issue"
39733973
],
3974-
"summary": "Remove a reaction from a comment of a issue",
3974+
"summary": "Remove a reaction from an issue",
39753975
"operationId": "issueDeleteIssueReaction",
39763976
"parameters": [
39773977
{

0 commit comments

Comments
 (0)