fix swagger description of reaction API (#9617)

This commit is contained in:
6543 2020-01-06 05:58:13 +01:00 committed by Lauris BH
parent 2a1cf5bae9
commit bcac7cb934
2 changed files with 18 additions and 18 deletions

View File

@ -13,11 +13,11 @@ import (
api "code.gitea.io/gitea/modules/structs" 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) { func GetIssueCommentReactions(ctx *context.APIContext) {
// swagger:operation GET /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issueGetCommentReactions // 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: // consumes:
// - application/json // - application/json
// produces: // produces:
@ -83,11 +83,11 @@ func GetIssueCommentReactions(ctx *context.APIContext) {
ctx.JSON(http.StatusOK, result) 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) { func PostIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOption) {
// swagger:operation POST /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issuePostCommentReaction // 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: // consumes:
// - application/json // - application/json
// produces: // produces:
@ -124,11 +124,11 @@ func PostIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOpti
changeIssueCommentReaction(ctx, form, true) 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) { func DeleteIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOption) {
// swagger:operation DELETE /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issueDeleteCommentReaction // 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: // consumes:
// - application/json // - application/json
// produces: // 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) { func GetIssueReactions(ctx *context.APIContext) {
// swagger:operation GET /repos/{owner}/{repo}/issues/{index}/reactions issue issueGetIssueReactions // 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: // consumes:
// - application/json // - application/json
// produces: // produces:
@ -289,11 +289,11 @@ func GetIssueReactions(ctx *context.APIContext) {
ctx.JSON(http.StatusOK, result) 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) { func PostIssueReaction(ctx *context.APIContext, form api.EditReactionOption) {
// swagger:operation POST /repos/{owner}/{repo}/issues/{index}/reactions issue issuePostIssueReaction // 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: // consumes:
// - application/json // - application/json
// produces: // produces:
@ -330,11 +330,11 @@ func PostIssueReaction(ctx *context.APIContext, form api.EditReactionOption) {
changeIssueReaction(ctx, form, true) 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) { func DeleteIssueReaction(ctx *context.APIContext, form api.EditReactionOption) {
// swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/reactions issue issueDeleteIssueReaction // 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: // consumes:
// - application/json // - application/json
// produces: // produces:

View File

@ -3102,7 +3102,7 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Get a list reactions of a issue comment", "summary": "Get a list of reactions from a comment of an issue",
"operationId": "issueGetCommentReactions", "operationId": "issueGetCommentReactions",
"parameters": [ "parameters": [
{ {
@ -3147,7 +3147,7 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Add a reaction to a comment of a issue comment", "summary": "Add a reaction to a comment of an issue",
"operationId": "issuePostCommentReaction", "operationId": "issuePostCommentReaction",
"parameters": [ "parameters": [
{ {
@ -3202,7 +3202,7 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Remove a reaction from a comment of a issue comment", "summary": "Remove a reaction from a comment of an issue",
"operationId": "issueDeleteCommentReaction", "operationId": "issueDeleteCommentReaction",
"parameters": [ "parameters": [
{ {
@ -3871,7 +3871,7 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Get a list reactions of a issue", "summary": "Get a list reactions of an issue",
"operationId": "issueGetIssueReactions", "operationId": "issueGetIssueReactions",
"parameters": [ "parameters": [
{ {
@ -3916,7 +3916,7 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Add a reaction to a comment of a issue", "summary": "Add a reaction to an issue",
"operationId": "issuePostIssueReaction", "operationId": "issuePostIssueReaction",
"parameters": [ "parameters": [
{ {
@ -3971,7 +3971,7 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Remove a reaction from a comment of a issue", "summary": "Remove a reaction from an issue",
"operationId": "issueDeleteIssueReaction", "operationId": "issueDeleteIssueReaction",
"parameters": [ "parameters": [
{ {