tdsds.com/gitea
1
1
Fork 0
mirror of https://github.com/go-gitea/gitea synced 2025-07-22 18:28:37 +00:00
Code Releases Activity

Fix Swagger JSON autogeneration issues. (#4845)

Browse Source 
* Fix Swagger JSON.

Remove unnecessary schema references for the forbidden and empty responses

Signed-off-by: Andrew Thornton <art27@cantab.net>

* Fix swagger API for CreateAccessToken

* Fix admin create org swagger

* Fix swagger for adminCreateRepo

* More swagger fixes

Set int64 format for those which are int64
Some more form fixes

* Fix swagger description of GET /repos/{owner}/{repo}/pulls
This commit is contained in:
zeripath
2018-10-21 04:40:42 +01:00
committed by techknowlogick
parent 9b2fcadeef
commit 43f9233914
23 changed files with 298 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

221
templates/swagger/v1_json.tmpl
View File

@@ -150,6 +150,13 @@
"name": "username",
"in": "path",
"required": true
},
{
"name": "key",
"in": "body",
"schema": {
"$ref": "#/definitions/CreateKeyOption"
}
}
],
"responses": {
@@ -185,6 +192,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the key to delete",
"name": "id",
"in": "path",
@@ -224,6 +232,14 @@
"name": "username",
"in": "path",
"required": true
},
{
"name": "organization",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateOrgOption"
}
}
],
"responses": {
@@ -259,6 +275,14 @@
"name": "username",
"in": "path",
"required": true
},
{
"name": "repository",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateRepoOption"
}
}
],
"responses": {
@@ -488,6 +512,14 @@
"name": "org",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateHookOption"
}
}
],
"responses": {
@@ -517,6 +549,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the hook to get",
"name": "id",
"in": "path",
@@ -548,6 +581,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the hook to delete",
"name": "id",
"in": "path",
@@ -582,10 +616,18 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the hook to update",
"name": "id",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/EditHookOption"
}
}
],
"responses": {
@@ -646,16 +688,10 @@
],
"responses": {
"204": {
"description": "user is a member",
"schema": {
"$ref": "#/responses/empty"
}
"description": "user is a member"
},
"404": {
"description": "user is not a member",
"schema": {
"$ref": "#/responses/empty"
}
"description": "user is not a member"
}
}
},
@@ -686,10 +722,7 @@
],
"responses": {
"204": {
"description": "member removed",
"schema": {
"$ref": "#/responses/empty"
}
"description": "member removed"
}
}
}
@@ -745,16 +778,10 @@
],
"responses": {
"204": {
"description": "user is a public member",
"schema": {
"$ref": "#/responses/empty"
}
"description": "user is a public member"
},
"404": {
"description": "user is not a public member",
"schema": {
"$ref": "#/responses/empty"
}
"description": "user is not a public member"
}
}
},
@@ -785,10 +812,7 @@
],
"responses": {
"204": {
"description": "membership publicized",
"schema": {
"$ref": "#/responses/empty"
}
"description": "membership publicized"
}
}
},
@@ -958,6 +982,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "search only for repos that the user with the given id owns or contributes to",
"name": "uid",
"in": "query"
@@ -1600,6 +1625,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the hook to get",
"name": "id",
"in": "path",
@@ -1638,6 +1664,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the hook to delete",
"name": "id",
"in": "path",
@@ -1679,6 +1706,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the hook",
"name": "id",
"in": "path",
@@ -1726,6 +1754,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the hook to test",
"name": "id",
"in": "path",
@@ -1894,6 +1923,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of comment to delete",
"name": "id",
"in": "path",
@@ -1935,6 +1965,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the comment to edit",
"name": "id",
"in": "path",
@@ -1982,6 +2013,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue",
"name": "id",
"in": "path",
@@ -2023,6 +2055,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue to add tracked time to",
"name": "id",
"in": "path",
@@ -2076,6 +2109,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue to get",
"name": "index",
"in": "path",
@@ -2117,6 +2151,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue to edit",
"name": "index",
"in": "path",
@@ -2164,6 +2199,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
@@ -2211,6 +2247,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
@@ -2263,6 +2300,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of comment to delete",
"name": "id",
"in": "path",
@@ -2312,6 +2350,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the comment to edit",
"name": "id",
"in": "path",
@@ -2362,6 +2401,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue to create or update a deadline on",
"name": "index",
"in": "path",
@@ -2380,16 +2420,10 @@
"$ref": "#/responses/IssueDeadline"
},
"403": {
"description": "Not repo writer",
"schema": {
"$ref": "#/responses/forbidden"
}
"description": "Not repo writer"
},
"404": {
"description": "Issue not found",
"schema": {
"$ref": "#/responses/empty"
}
"description": "Issue not found"
}
}
}
@@ -2421,6 +2455,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
@@ -2465,6 +2500,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
@@ -2513,6 +2549,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
@@ -2558,6 +2595,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
@@ -2598,6 +2636,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
@@ -2605,6 +2644,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the label to remove",
"name": "id",
"in": "path",
@@ -2719,6 +2759,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the key to get",
"name": "id",
"in": "path",
@@ -2754,6 +2795,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the key to delete",
"name": "id",
"in": "path",
@@ -2868,6 +2910,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the label to get",
"name": "id",
"in": "path",
@@ -2903,6 +2946,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the label to delete",
"name": "id",
"in": "path",
@@ -2944,6 +2988,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the label to edit",
"name": "id",
"in": "path",
@@ -3065,6 +3110,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the milestone",
"name": "id",
"in": "path",
@@ -3100,6 +3146,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the milestone to delete",
"name": "id",
"in": "path",
@@ -3141,6 +3188,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the milestone",
"name": "id",
"in": "path",
@@ -3218,6 +3266,55 @@
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Page number",
"name": "page",
"in": "query"
},
{
"enum": [
"closed",
"open",
"all"
],
"type": "string",
"description": "State of pull request: open or closed (optional)",
"name": "state",
"in": "query"
},
{
"enum": [
"oldest",
"recentupdate",
"leastupdate",
"mostcomment",
"leastcomment",
"priority"
],
"type": "string",
"description": "Type of sort",
"name": "sort",
"in": "query"
},
{
"type": "integer",
"format": "int64",
"description": "ID of the milestone",
"name": "milestone",
"in": "query"
},
{
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi",
"description": "Label IDs",
"name": "labels",
"in": "query"
}
],
"responses": {
@@ -3295,6 +3392,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the pull request to get",
"name": "index",
"in": "path",
@@ -3336,6 +3434,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the pull request to edit",
"name": "index",
"in": "path",
@@ -3383,6 +3482,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the pull request",
"name": "index",
"in": "path",
@@ -3391,16 +3491,10 @@
],
"responses": {
"204": {
"description": "pull request has been merged",
"schema": {
"$ref": "#/responses/empty"
}
"description": "pull request has been merged"
},
"404": {
"description": "pull request has not been merged",
"schema": {
"$ref": "#/responses/empty"
}
"description": "pull request has not been merged"
}
}
},
@@ -3430,6 +3524,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "index of the pull request to merge",
"name": "index",
"in": "path",
@@ -3587,6 +3682,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the release to get",
"name": "id",
"in": "path",
@@ -3622,6 +3718,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the release to delete",
"name": "id",
"in": "path",
@@ -3663,6 +3760,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the release to edit",
"name": "id",
"in": "path",
@@ -3710,6 +3808,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the release",
"name": "id",
"in": "path",
@@ -3751,6 +3850,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the release",
"name": "id",
"in": "path",
@@ -3804,6 +3904,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the release",
"name": "id",
"in": "path",
@@ -3811,6 +3912,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the attachment to get",
"name": "attachment_id",
"in": "path",
@@ -3849,6 +3951,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the release",
"name": "id",
"in": "path",
@@ -3856,6 +3959,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the attachment to delete",
"name": "attachment_id",
"in": "path",
@@ -3897,6 +4001,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the release",
"name": "id",
"in": "path",
@@ -3904,6 +4009,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "id of the attachment to edit",
"name": "attachment_id",
"in": "path",
@@ -4247,6 +4353,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of the repo to get",
"name": "id",
"in": "path",
@@ -4273,6 +4380,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of the team to get",
"name": "id",
"in": "path",
@@ -4294,6 +4402,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of the team to delete",
"name": "id",
"in": "path",
@@ -4302,10 +4411,7 @@
],
"responses": {
"204": {
"description": "team deleted",
"schema": {
"$ref": "#/responses/empty"
}
"description": "team deleted"
}
}
},
@@ -4357,6 +4463,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of the team",
"name": "id",
"in": "path",
@@ -4383,6 +4490,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of the team",
"name": "id",
"in": "path",
@@ -4414,6 +4522,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of the team",
"name": "id",
"in": "path",
@@ -4447,6 +4556,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of the team",
"name": "id",
"in": "path",
@@ -4473,6 +4583,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of the team",
"name": "id",
"in": "path",
@@ -4512,6 +4623,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of the team",
"name": "id",
"in": "path",
@@ -4809,6 +4921,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of key to get",
"name": "id",
"in": "path",
@@ -4836,6 +4949,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of key to delete",
"name": "id",
"in": "path",
@@ -4912,6 +5026,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of key to get",
"name": "id",
"in": "path",
@@ -4939,6 +5054,7 @@
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of key to delete",
"name": "id",
"in": "path",
@@ -5205,6 +5321,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "ID of the user to search for",
"name": "uid",
"in": "query"
@@ -5526,6 +5643,21 @@
"name": "username",
"in": "path",
"required": true
},
{
"name": "accessToken",
"in": "body",
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
}
}
],
"responses": {
@@ -5555,6 +5687,7 @@
},
{
"type": "integer",
"format": "int64",
"description": "token to be deleted",
"name": "token",
"in": "path",