MieuxVoter
/
gitea-fork-majority-judgment
mirror of https://github.com/domi41/gitea.git
4
0
Fork 0
Code Issues 8 Releases Wiki Polls Activity

fix wrong issue endpoints in swagger doc (#3914)

Browse Source
release/v1.5
David Schneiderbauer 6 years ago committed by Bo-Yi Wu
parent 773530c917
commit ea01decb6b
3 changed files with 197 additions and 201 deletions
Show Stats Download Patch File Download Diff File

388
public/swagger.v1.json vendored
Unescape View File

@ -1605,7 +1605,7 @@
} }
} }
}, },
"/repos/{owner}/{repo}/issue/{index}/comments": { "/repos/{owner}/{repo}/issues": {
"get": { "get": {
"produces": [ "produces": [
"application/json" "application/json"
@ -1613,8 +1613,8 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "List all comments on an issue", "summary": "List a repository's issues",
"operationId": "issueGetComments", "operationId": "issueListIssues",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -1630,29 +1630,32 @@
"in": "path", "in": "path",
"required": true "required": true
}, },
{
"type": "string",
"description": "whether issue is open or closed",
"name": "state",
"in": "query"
},
{ {
"type": "integer", "type": "integer",
"description": "index of the issue", "description": "page number of requested issues",
"name": "id", "name": "page",
"in": "path", "in": "query"
"required": true
}, },
{ {
"type": "string", "type": "string",
"description": "if provided, only comments updated since the specified time are returned.", "description": "search string",
"name": "string", "name": "q",
"in": "query" "in": "query"
} }
], ],
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/CommentList" "$ref": "#/responses/IssueList"
} }
} }
} },
}, "post": {
"/repos/{owner}/{repo}/issue/{index}/labels": {
"put": {
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@ -1662,8 +1665,8 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Replace an issue's labels", "summary": "Create an issue",
"operationId": "issueReplaceLabels", "operationId": "issueCreateIssue",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -1679,39 +1682,31 @@
"in": "path", "in": "path",
"required": true "required": true
}, },
{
"type": "integer",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
},
{ {
"name": "body", "name": "body",
"in": "body", "in": "body",
"schema": { "schema": {
"$ref": "#/definitions/IssueLabelsOption" "$ref": "#/definitions/CreateIssueOption"
} }
} }
], ],
"responses": { "responses": {
"200": { "201": {
"$ref": "#/responses/LabelList" "$ref": "#/responses/Issue"
} }
} }
}, }
"post": { },
"consumes": [ "/repos/{owner}/{repo}/issues/comments": {
"application/json" "get": {
],
"produces": [ "produces": [
"application/json" "application/json"
], ],
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Add a label to an issue", "summary": "List all comments in a repository",
"operationId": "issueAddLabel", "operationId": "issueGetRepoComments",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -1728,35 +1723,26 @@
"required": true "required": true
}, },
{ {
"type": "integer", "type": "string",
"description": "index of the issue", "description": "if provided, only comments updated since the provided time are returned.",
"name": "index", "name": "string",
"in": "path", "in": "query"
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/IssueLabelsOption"
}
} }
], ],
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/LabelList" "$ref": "#/responses/CommentList"
} }
} }
}, }
},
"/repos/{owner}/{repo}/issues/comments/{id}": {
"delete": { "delete": {
"produces": [
"application/json"
],
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Remove all labels from an issue", "summary": "Delete a comment",
"operationId": "issueClearLabels", "operationId": "issueDeleteComment",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -1774,8 +1760,8 @@
}, },
{ {
"type": "integer", "type": "integer",
"description": "index of the issue", "description": "id of comment to delete",
"name": "index", "name": "id",
"in": "path", "in": "path",
"required": true "required": true
} }
@ -1785,18 +1771,19 @@
"$ref": "#/responses/empty" "$ref": "#/responses/empty"
} }
} }
} },
}, "patch": {
"/repos/{owner}/{repo}/issue/{index}/labels/{id}": { "consumes": [
"delete": { "application/json"
],
"produces": [ "produces": [
"application/json" "application/json"
], ],
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Remove a label from an issue", "summary": "Edit a comment",
"operationId": "issueRemoveLabel", "operationId": "issueEditComment",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -1814,27 +1801,27 @@
}, },
{ {
"type": "integer", "type": "integer",
"description": "index of the issue", "description": "id of the comment to edit",
"name": "index", "name": "id",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "integer", "name": "body",
"description": "id of the label to remove", "in": "body",
"name": "id", "schema": {
"in": "path", "$ref": "#/definitions/EditIssueCommentOption"
"required": true }
} }
], ],
"responses": { "responses": {
"204": { "200": {
"$ref": "#/responses/empty" "$ref": "#/responses/Comment"
} }
} }
} }
}, },
"/repos/{owner}/{repo}/issues": { "/repos/{owner}/{repo}/issues/{index}": {
"get": { "get": {
"produces": [ "produces": [
"application/json" "application/json"
@ -1842,8 +1829,8 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "List a repository's issues", "summary": "Get an issue",
"operationId": "issueListIssues", "operationId": "issueGetIssue",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -1859,32 +1846,21 @@
"in": "path", "in": "path",
"required": true "required": true
}, },
{
"type": "string",
"description": "whether issue is open or closed",
"name": "state",
"in": "query"
},
{ {
"type": "integer", "type": "integer",
"description": "page number of requested issues", "description": "index of the issue to get",
"name": "page", "name": "index",
"in": "query" "in": "path",
}, "required": true
{
"type": "string",
"description": "search string",
"name": "q",
"in": "query"
} }
], ],
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/IssueList" "$ref": "#/responses/Issue"
} }
} }
}, },
"post": { "patch": {
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@ -1894,8 +1870,8 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Create an issue", "summary": "Edit an issue",
"operationId": "issueCreateIssue", "operationId": "issueEditIssue",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -1911,11 +1887,18 @@
"in": "path", "in": "path",
"required": true "required": true
}, },
{
"type": "integer",
"description": "index of the issue to edit",
"name": "index",
"in": "path",
"required": true
},
{ {
"name": "body", "name": "body",
"in": "body", "in": "body",
"schema": { "schema": {
"$ref": "#/definitions/CreateIssueOption" "$ref": "#/definitions/EditIssueOption"
} }
} }
], ],
@ -1926,7 +1909,7 @@
} }
} }
}, },
"/repos/{owner}/{repo}/issues/comments": { "/repos/{owner}/{repo}/issues/{index}/comments": {
"get": { "get": {
"produces": [ "produces": [
"application/json" "application/json"
@ -1934,8 +1917,8 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "List all comments in a repository", "summary": "List all comments on an issue",
"operationId": "issueGetRepoComments", "operationId": "issueGetComments",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -1951,9 +1934,16 @@
"in": "path", "in": "path",
"required": true "required": true
}, },
{
"type": "integer",
"description": "index of the issue",
"name": "id",
"in": "path",
"required": true
},
{ {
"type": "string", "type": "string",
"description": "if provided, only comments updated since the provided time are returned.", "description": "if provided, only comments updated since the specified time are returned.",
"name": "string", "name": "string",
"in": "query" "in": "query"
} }
@ -1963,15 +1953,64 @@
"$ref": "#/responses/CommentList" "$ref": "#/responses/CommentList"
} }
} }
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Add a comment to an issue",
"operationId": "issueCreateComment",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
},
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "index of the issue",
"name": "id",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/CreateIssueOption"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Comment"
}
}
} }
}, },
"/repos/{owner}/{repo}/issues/comments/{id}": { "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
"delete": { "delete": {
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Delete a comment", "summary": "Delete a comment",
"operationId": "issueDeleteComment", "operationId": "issueDeleteCommentDeprecated",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -1987,6 +2026,13 @@
"in": "path", "in": "path",
"required": true "required": true
}, },
{
"type": "integer",
"description": "this parameter is ignored",
"name": "index",
"in": "path",
"required": true
},
{ {
"type": "integer", "type": "integer",
"description": "id of comment to delete", "description": "id of comment to delete",
@ -2012,7 +2058,8 @@
"issue" "issue"
], ],
"summary": "Edit a comment", "summary": "Edit a comment",
"operationId": "issueEditComment", "operationId": "issueEditCommentDeprecated",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -2028,6 +2075,13 @@
"in": "path", "in": "path",
"required": true "required": true
}, },
{
"type": "integer",
"description": "this parameter is ignored",
"name": "index",
"in": "path",
"required": true
},
{ {
"type": "integer", "type": "integer",
"description": "id of the comment to edit", "description": "id of the comment to edit",
@ -2050,7 +2104,7 @@
} }
} }
}, },
"/repos/{owner}/{repo}/issues/{index}": { "/repos/{owner}/{repo}/issues/{index}/labels": {
"get": { "get": {
"produces": [ "produces": [
"application/json" "application/json"
@ -2058,8 +2112,8 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Get an issue", "summary": "Get an issue's labels",
"operationId": "issueGetIssue", "operationId": "issueGetLabels",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -2077,7 +2131,7 @@
}, },
{ {
"type": "integer", "type": "integer",
"description": "index of the issue to get", "description": "index of the issue",
"name": "index", "name": "index",
"in": "path", "in": "path",
"required": true "required": true
@ -2085,11 +2139,14 @@
], ],
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/Issue" "$ref": "#/responses/LabelList"
},
"404": {
"$ref": "#/responses/notFound"
} }
} }
}, },
"patch": { "put": {
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@ -2099,8 +2156,8 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Edit an issue", "summary": "Replace an issue's labels",
"operationId": "issueEditIssue", "operationId": "issueReplaceLabels",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -2118,7 +2175,7 @@
}, },
{ {
"type": "integer", "type": "integer",
"description": "index of the issue to edit", "description": "index of the issue",
"name": "index", "name": "index",
"in": "path", "in": "path",
"required": true "required": true
@ -2127,18 +2184,16 @@
"name": "body", "name": "body",
"in": "body", "in": "body",
"schema": { "schema": {
"$ref": "#/definitions/EditIssueOption" "$ref": "#/definitions/IssueLabelsOption"
} }
} }
], ],
"responses": { "responses": {
"201": { "200": {
"$ref": "#/responses/Issue" "$ref": "#/responses/LabelList"
} }
} }
} },
},
"/repos/{owner}/{repo}/issues/{index}/comments": {
"post": { "post": {
"consumes": [ "consumes": [
"application/json" "application/json"
@ -2149,8 +2204,8 @@
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Add a comment to an issue", "summary": "Add a label to an issue",
"operationId": "issueCreateComment", "operationId": "issueAddLabel",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -2169,7 +2224,7 @@
{ {
"type": "integer", "type": "integer",
"description": "index of the issue", "description": "index of the issue",
"name": "id", "name": "index",
"in": "path", "in": "path",
"required": true "required": true
}, },
@ -2177,25 +2232,25 @@
"name": "body", "name": "body",
"in": "body", "in": "body",
"schema": { "schema": {
"$ref": "#/definitions/CreateIssueOption" "$ref": "#/definitions/IssueLabelsOption"
} }
} }
], ],
"responses": { "responses": {
"201": { "200": {
"$ref": "#/responses/Comment" "$ref": "#/responses/LabelList"
} }
} }
} },
},
"/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
"delete": { "delete": {
"produces": [
"application/json"
],
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Delete a comment", "summary": "Remove all labels from an issue",
"operationId": "issueDeleteCommentDeprecated", "operationId": "issueClearLabels",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -2213,17 +2268,10 @@
}, },
{ {
"type": "integer", "type": "integer",
"description": "this parameter is ignored", "description": "index of the issue",
"name": "index", "name": "index",
"in": "path", "in": "path",
"required": true "required": true
},
{
"type": "integer",
"description": "id of comment to delete",
"name": "id",
"in": "path",
"required": true
} }
], ],
"responses": { "responses": {
@ -2231,20 +2279,18 @@
"$ref": "#/responses/empty" "$ref": "#/responses/empty"
} }
} }
}, }
"patch": { },
"consumes": [ "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
"application/json" "delete": {
],
"produces": [ "produces": [
"application/json" "application/json"
], ],
"tags": [ "tags": [
"issue" "issue"
], ],
"summary": "Edit a comment", "summary": "Remove a label from an issue",
"operationId": "issueEditCommentDeprecated", "operationId": "issueRemoveLabel",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@ -2262,72 +2308,22 @@
}, },
{ {
"type": "integer", "type": "integer",
"description": "this parameter is ignored", "description": "index of the issue",
"name": "index", "name": "index",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "integer", "type": "integer",
"description": "id of the comment to edit", "description": "id of the label to remove",
"name": "id", "name": "id",
"in": "path", "in": "path",
"required": true "required": true
},
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/EditIssueCommentOption"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Comment"
}
}
}
},
"/repos/{owner}/{repo}/issues/{index}/labels": {
"get": {
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Get an issue's labels",
"operationId": "issueGetLabels",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
},
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
} }
], ],
"responses": { "responses": {
"200": { "204": {
"$ref": "#/responses/LabelList" "$ref": "#/responses/empty"
},
"404": {
"$ref": "#/responses/notFound"
} }
} }
} }

2
routers/api/v1/repo/issue_comment.go
Unescape View File

@ -15,7 +15,7 @@ import (
// ListIssueComments list all the comments of an issue // ListIssueComments list all the comments of an issue
func ListIssueComments(ctx *context.APIContext) { func ListIssueComments(ctx *context.APIContext) {
// swagger:operation GET /repos/{owner}/{repo}/issue/{index}/comments issue issueGetComments // swagger:operation GET /repos/{owner}/{repo}/issues/{index}/comments issue issueGetComments
// --- // ---
// summary: List all comments on an issue // summary: List all comments on an issue
// produces: // produces:

8
routers/api/v1/repo/issue_label.go
Unescape View File

@ -58,7 +58,7 @@ func ListIssueLabels(ctx *context.APIContext) {
// AddIssueLabels add labels for an issue // AddIssueLabels add labels for an issue
func AddIssueLabels(ctx *context.APIContext, form api.IssueLabelsOption) { func AddIssueLabels(ctx *context.APIContext, form api.IssueLabelsOption) {
// swagger:operation POST /repos/{owner}/{repo}/issue/{index}/labels issue issueAddLabel // swagger:operation POST /repos/{owner}/{repo}/issues/{index}/labels issue issueAddLabel
// --- // ---
// summary: Add a label to an issue // summary: Add a label to an issue
// consumes: // consumes:
@ -129,7 +129,7 @@ func AddIssueLabels(ctx *context.APIContext, form api.IssueLabelsOption) {
// DeleteIssueLabel delete a label for an issue // DeleteIssueLabel delete a label for an issue
func DeleteIssueLabel(ctx *context.APIContext) { func DeleteIssueLabel(ctx *context.APIContext) {
// swagger:operation DELETE /repos/{owner}/{repo}/issue/{index}/labels/{id} issue issueRemoveLabel // swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/labels/{id} issue issueRemoveLabel
// --- // ---
// summary: Remove a label from an issue // summary: Remove a label from an issue
// produces: // produces:
@ -193,7 +193,7 @@ func DeleteIssueLabel(ctx *context.APIContext) {
// ReplaceIssueLabels replace labels for an issue // ReplaceIssueLabels replace labels for an issue
func ReplaceIssueLabels(ctx *context.APIContext, form api.IssueLabelsOption) { func ReplaceIssueLabels(ctx *context.APIContext, form api.IssueLabelsOption) {
// swagger:operation PUT /repos/{owner}/{repo}/issue/{index}/labels issue issueReplaceLabels // swagger:operation PUT /repos/{owner}/{repo}/issues/{index}/labels issue issueReplaceLabels
// --- // ---
// summary: Replace an issue's labels // summary: Replace an issue's labels
// consumes: // consumes:
@ -264,7 +264,7 @@ func ReplaceIssueLabels(ctx *context.APIContext, form api.IssueLabelsOption) {
// ClearIssueLabels delete all the labels for an issue // ClearIssueLabels delete all the labels for an issue
func ClearIssueLabels(ctx *context.APIContext) { func ClearIssueLabels(ctx *context.APIContext) {
// swagger:operation DELETE /repos/{owner}/{repo}/issue/{index}/labels issue issueClearLabels // swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/labels issue issueClearLabels
// --- // ---
// summary: Remove all labels from an issue // summary: Remove all labels from an issue
// produces: // produces:

Write Preview
Loading…
Cancel
Save