forks/forgejo
1
0
Fork 0
Code Releases Activity

fix swagger description of reaction API (#9617)

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

24
routers/api/v1/repo/issue_reaction.go
View file

@ -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:

12
templates/swagger/v1_json.tmpl
View file

@ -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": [
{