From bcac7cb9342e17bdb80028f342fb911dcb854c25 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Mon, 6 Jan 2020 05:58:13 +0100 Subject: [PATCH] fix swagger description of reaction API (#9617) --- routers/api/v1/repo/issue_reaction.go | 24 ++++++++++++------------ templates/swagger/v1_json.tmpl | 12 ++++++------ 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/routers/api/v1/repo/issue_reaction.go b/routers/api/v1/repo/issue_reaction.go index d612b20d7..b943ea698 100644 --- a/routers/api/v1/repo/issue_reaction.go +++ b/routers/api/v1/repo/issue_reaction.go @@ -13,11 +13,11 @@ import ( api "code.gitea.io/gitea/modules/structs" ) -// GetIssueCommentReactions list reactions of a issue comment +// GetIssueCommentReactions list reactions of a comment from an issue func GetIssueCommentReactions(ctx *context.APIContext) { // swagger:operation GET /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issueGetCommentReactions // --- - // summary: Get a list reactions of a issue comment + // summary: Get a list of reactions from a comment of an issue // consumes: // - application/json // produces: @@ -83,11 +83,11 @@ func GetIssueCommentReactions(ctx *context.APIContext) { ctx.JSON(http.StatusOK, result) } -// PostIssueCommentReaction add a reaction to a comment of a issue +// PostIssueCommentReaction add a reaction to a comment of an issue func PostIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOption) { // swagger:operation POST /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issuePostCommentReaction // --- - // summary: Add a reaction to a comment of a issue comment + // summary: Add a reaction to a comment of an issue // consumes: // - application/json // produces: @@ -124,11 +124,11 @@ func PostIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOpti changeIssueCommentReaction(ctx, form, true) } -// DeleteIssueCommentReaction list reactions of a issue comment +// DeleteIssueCommentReaction remove a reaction from a comment of an issue func DeleteIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOption) { // swagger:operation DELETE /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issueDeleteCommentReaction // --- - // summary: Remove a reaction from a comment of a issue comment + // summary: Remove a reaction from a comment of an issue // consumes: // - application/json // produces: @@ -219,11 +219,11 @@ func changeIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOp } } -// GetIssueReactions list reactions of a issue comment +// GetIssueReactions list reactions of an issue func GetIssueReactions(ctx *context.APIContext) { // swagger:operation GET /repos/{owner}/{repo}/issues/{index}/reactions issue issueGetIssueReactions // --- - // summary: Get a list reactions of a issue + // summary: Get a list reactions of an issue // consumes: // - application/json // produces: @@ -289,11 +289,11 @@ func GetIssueReactions(ctx *context.APIContext) { ctx.JSON(http.StatusOK, result) } -// PostIssueReaction add a reaction to a comment of a issue +// PostIssueReaction add a reaction to an issue func PostIssueReaction(ctx *context.APIContext, form api.EditReactionOption) { // swagger:operation POST /repos/{owner}/{repo}/issues/{index}/reactions issue issuePostIssueReaction // --- - // summary: Add a reaction to a comment of a issue + // summary: Add a reaction to an issue // consumes: // - application/json // produces: @@ -330,11 +330,11 @@ func PostIssueReaction(ctx *context.APIContext, form api.EditReactionOption) { changeIssueReaction(ctx, form, true) } -// DeleteIssueReaction list reactions of a issue comment +// DeleteIssueReaction remove a reaction from an issue func DeleteIssueReaction(ctx *context.APIContext, form api.EditReactionOption) { // swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/reactions issue issueDeleteIssueReaction // --- - // summary: Remove a reaction from a comment of a issue + // summary: Remove a reaction from an issue // consumes: // - application/json // produces: diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index f31b37cc4..45e84d3ed 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -3102,7 +3102,7 @@ "tags": [ "issue" ], - "summary": "Get a list reactions of a issue comment", + "summary": "Get a list of reactions from a comment of an issue", "operationId": "issueGetCommentReactions", "parameters": [ { @@ -3147,7 +3147,7 @@ "tags": [ "issue" ], - "summary": "Add a reaction to a comment of a issue comment", + "summary": "Add a reaction to a comment of an issue", "operationId": "issuePostCommentReaction", "parameters": [ { @@ -3202,7 +3202,7 @@ "tags": [ "issue" ], - "summary": "Remove a reaction from a comment of a issue comment", + "summary": "Remove a reaction from a comment of an issue", "operationId": "issueDeleteCommentReaction", "parameters": [ { @@ -3871,7 +3871,7 @@ "tags": [ "issue" ], - "summary": "Get a list reactions of a issue", + "summary": "Get a list reactions of an issue", "operationId": "issueGetIssueReactions", "parameters": [ { @@ -3916,7 +3916,7 @@ "tags": [ "issue" ], - "summary": "Add a reaction to a comment of a issue", + "summary": "Add a reaction to an issue", "operationId": "issuePostIssueReaction", "parameters": [ { @@ -3971,7 +3971,7 @@ "tags": [ "issue" ], - "summary": "Remove a reaction from a comment of a issue", + "summary": "Remove a reaction from an issue", "operationId": "issueDeleteIssueReaction", "parameters": [ {