finn/forgejo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix swagger docs (#3300)

Browse source
This commit is contained in:
Ethan Koenig 2018-01-04 01:31:40 -05:00 committed by Bo-Yi Wu
parent 30fb81c71e
commit ce7ae17b81
2 changed files with 13 additions and 162 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

161
public/swagger.v1.json vendored
View file

File diff suppressed because it is too large Load diff

14
routers/api/v1/repo/issue.go
View file

@ -77,9 +77,9 @@ func ListIssues(ctx *context.APIContext) {
// GetIssue get an issue of a repository // GetIssue get an issue of a repository
func GetIssue(ctx *context.APIContext) { func GetIssue(ctx *context.APIContext) {
// swagger:operation GET /repos/{owner}/{repo}/issues/{id} issue issueGetIssue // swagger:operation GET /repos/{owner}/{repo}/issues/{index} issue issueGetIssue
// --- // ---
// summary: Get an issue by id // summary: Get an issue
// produces: // produces:
// - application/json // - application/json
// parameters: // parameters:
@ -93,9 +93,9 @@ func GetIssue(ctx *context.APIContext) {
// description: name of the repo // description: name of the repo
// type: string // type: string
// required: true // required: true
// - name: id // - name: index
// in: path // in: path
// description: id of the issue to get // description: index of the issue to get
// type: integer // type: integer
// required: true // required: true
// responses: // responses:
@ -190,7 +190,7 @@ func CreateIssue(ctx *context.APIContext, form api.CreateIssueOption) {
// EditIssue modify an issue of a repository // EditIssue modify an issue of a repository
func EditIssue(ctx *context.APIContext, form api.EditIssueOption) { func EditIssue(ctx *context.APIContext, form api.EditIssueOption) {
// swagger:operation PATCH /repos/{owner}/{repo}/issues/{id} issue issueEditIssue // swagger:operation PATCH /repos/{owner}/{repo}/issues/{index} issue issueEditIssue
// --- // ---
// summary: Edit an issue // summary: Edit an issue
// consumes: // consumes:
@ -208,9 +208,9 @@ func EditIssue(ctx *context.APIContext, form api.EditIssueOption) {
// description: name of the repo // description: name of the repo
// type: string // type: string
// required: true // required: true
// - name: id // - name: index
// in: path // in: path
// description: id of the issue to edit // description: index of the issue to edit
// type: integer // type: integer
// required: true // required: true
// - name: body // - name: body