summaryrefslogtreecommitdiffstats
path: root/public/swagger.v1.json
diff options
context:
space:
mode:
authorAntoine GIRARD <sapk@users.noreply.github.com>2018-06-12 16:59:22 +0200
committerBo-Yi Wu <appleboy.tw@gmail.com>2018-06-12 22:59:22 +0800
commit908e8942ccae5b7966c7084780b3441e2190d9c1 (patch)
tree746fedd2cd4ba4608629f74b7f8a83a4adf48298 /public/swagger.v1.json
parent0ba165e2ea451c67448d584822ce29ddf62a6c7c (diff)
downloadgitea-908e8942ccae5b7966c7084780b3441e2190d9c1.tar.gz
gitea-908e8942ccae5b7966c7084780b3441e2190d9c1.zip
Fix swagger errors (#4220)
Fix all the resting errors to have a valid swagger file. They are still some warnings but nothing blocking. Doing so I found that some request still misses son parameters for some POST/PUT/PATCH request. This means the a client generated from the swagger file will not work completely. Fix #4088 by activating validation in drone Should fix #4010.
Diffstat (limited to 'public/swagger.v1.json')
-rw-r--r--public/swagger.v1.json476
1 files changed, 273 insertions, 203 deletions
diff --git a/public/swagger.v1.json b/public/swagger.v1.json
index 2c263ef1f7..1c381a8297 100644
--- a/public/swagger.v1.json
+++ b/public/swagger.v1.json
@@ -321,9 +321,13 @@
"operationId": "renderMarkdownRaw",
"parameters": [
{
- "type": "string",
+ "description": "Request body to render",
"name": "body",
- "in": "body"
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
}
],
"responses": {
@@ -448,6 +452,15 @@
],
"summary": "List an organization's webhooks",
"operationId": "orgListHooks",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "name of the organization",
+ "name": "org",
+ "in": "path",
+ "required": true
+ }
+ ],
"responses": {
"200": {
"$ref": "#/responses/HookList"
@@ -468,6 +481,15 @@
],
"summary": "Create a hook",
"operationId": "orgCreateHook",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "name of the organization",
+ "name": "org",
+ "in": "path",
+ "required": true
+ }
+ ],
"responses": {
"201": {
"$ref": "#/responses/Hook"
@@ -485,6 +507,22 @@
],
"summary": "Get a hook",
"operationId": "orgGetHook",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "name of the organization",
+ "name": "org",
+ "in": "path",
+ "required": true
+ },
+ {
+ "type": "integer",
+ "description": "id of the hook to get",
+ "name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
"responses": {
"200": {
"$ref": "#/responses/Hook"
@@ -500,6 +538,22 @@
],
"summary": "Delete a hook",
"operationId": "orgDeleteHook",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "name of the organization",
+ "name": "org",
+ "in": "path",
+ "required": true
+ },
+ {
+ "type": "integer",
+ "description": "id of the hook to delete",
+ "name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
"responses": {
"204": {
"$ref": "#/responses/empty"
@@ -518,6 +572,22 @@
],
"summary": "Update a hook",
"operationId": "orgEditHook",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "name of the organization",
+ "name": "org",
+ "in": "path",
+ "required": true
+ },
+ {
+ "type": "integer",
+ "description": "id of the hook to update",
+ "name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
"responses": {
"200": {
"$ref": "#/responses/Hook"
@@ -994,7 +1064,7 @@
}
}
},
- "/repos/{owner}/{repo}/archive/{filepath}": {
+ "/repos/{owner}/{repo}/archive/{archive}": {
"get": {
"produces": [
"application/json"
@@ -1530,6 +1600,47 @@
}
}
},
+ "delete": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "repository"
+ ],
+ "summary": "Delete a hook in a repository",
+ "operationId": "repoDeleteHook",
+ "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": "id of the hook to delete",
+ "name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "$ref": "#/responses/empty"
+ },
+ "404": {
+ "$ref": "#/responses/notFound"
+ }
+ }
+ },
"patch": {
"produces": [
"application/json"
@@ -1555,6 +1666,13 @@
"required": true
},
{
+ "type": "integer",
+ "description": "index of the hook",
+ "name": "id",
+ "in": "path",
+ "required": true
+ },
+ {
"name": "body",
"in": "body",
"schema": {
@@ -1825,6 +1943,100 @@
}
}
},
+ "/repos/{owner}/{repo}/issues/{id}/times": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "issue"
+ ],
+ "summary": "List an issue's tracked times",
+ "operationId": "issueTrackedTimes",
+ "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
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/responses/TrackedTimeList"
+ }
+ }
+ },
+ "post": {
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "issue"
+ ],
+ "summary": "Add a tracked time to a issue",
+ "operationId": "issueAddTime",
+ "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 to add tracked time to",
+ "name": "id",
+ "in": "path",
+ "required": true
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "schema": {
+ "$ref": "#/definitions/AddTimeOption"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/responses/TrackedTime"
+ },
+ "400": {
+ "$ref": "#/responses/error"
+ },
+ "403": {
+ "$ref": "#/responses/error"
+ }
+ }
+ }
+ },
"/repos/{owner}/{repo}/issues/{index}": {
"get": {
"produces": [
@@ -1941,7 +2153,7 @@
{
"type": "integer",
"description": "index of the issue",
- "name": "id",
+ "name": "index",
"in": "path",
"required": true
},
@@ -1988,7 +2200,7 @@
{
"type": "integer",
"description": "index of the issue",
- "name": "id",
+ "name": "index",
"in": "path",
"required": true
},
@@ -2332,100 +2544,6 @@
}
}
},
- "/repos/{owner}/{repo}/issues/{index}/times": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List an issue's tracked times",
- "operationId": "issueTrackedTimes",
- "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": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a tracked time to a issue",
- "operationId": "issueAddTime",
- "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 to add tracked time to",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/AddTimeOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTime"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
"/repos/{owner}/{repo}/keys": {
"get": {
"produces": [
@@ -2781,7 +2899,7 @@
"issue"
],
"summary": "Get all of a repository's milestones",
- "operationId": "issueGetMilestones",
+ "operationId": "issueGetMilestonesList",
"parameters": [
{
"type": "string",
@@ -2796,13 +2914,6 @@
"name": "repo",
"in": "path",
"required": true
- },
- {
- "type": "integer",
- "description": "id of the milestone to get",
- "name": "id",
- "in": "path",
- "required": true
}
],
"responses": {
@@ -2863,6 +2974,29 @@
],
"summary": "Get a milestone",
"operationId": "issueGetMilestone",
+ "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": "id of the milestone",
+ "name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
"responses": {
"200": {
"$ref": "#/responses/Milestone"
@@ -2893,7 +3027,7 @@
{
"type": "integer",
"description": "id of the milestone to delete",
- "name": "body",
+ "name": "id",
"in": "path",
"required": true
}
@@ -2932,6 +3066,13 @@
"required": true
},
{
+ "type": "integer",
+ "description": "id of the milestone",
+ "name": "id",
+ "in": "path",
+ "required": true
+ },
+ {
"name": "body",
"in": "body",
"schema": {
@@ -3979,7 +4120,7 @@
}
}
},
- "/repos/{owner}/{repo}/times/{tracker}": {
+ "/repos/{owner}/{repo}/times/{user}": {
"get": {
"produces": [
"application/json"
@@ -4019,49 +4160,6 @@
}
}
},
- "/repos/{user}/{repo}/hooks/{id}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a hook in a repository",
- "operationId": "repoDeleteHook",
- "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": "id of the hook to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
"/repositories/{id}": {
"get": {
"produces": [
@@ -4238,7 +4336,7 @@
"organization"
],
"summary": "Remove a team member",
- "operationId": "orgAddTeamMember",
+ "operationId": "orgRemoveTeamMember",
"parameters": [
{
"type": "integer",
@@ -4297,7 +4395,7 @@
"organization"
],
"summary": "Add a repository to a team",
- "operationId": "orgAddTeamMember",
+ "operationId": "orgAddTeamRepository",
"parameters": [
{
"type": "integer",
@@ -4336,7 +4434,7 @@
"organization"
],
"summary": "Remove a repository from a team",
- "operationId": "orgAddTeamMember",
+ "operationId": "orgRemoveTeamRepository",
"parameters": [
{
"type": "integer",
@@ -4379,10 +4477,10 @@
"operationId": "topicSearch",
"parameters": [
{
- "type": "integer",
- "description": "id of the repo to get",
- "name": "keyword",
- "in": "path",
+ "type": "string",
+ "description": "keywords to search",
+ "name": "q",
+ "in": "query",
"required": true
}
],
@@ -4509,7 +4607,7 @@
}
}
},
- "/user/following/{followee}": {
+ "/user/following/{username}": {
"get": {
"tags": [
"user"
@@ -4520,7 +4618,7 @@
{
"type": "string",
"description": "username of followed user",
- "name": "followee",
+ "name": "username",
"in": "path",
"required": true
}
@@ -4533,9 +4631,7 @@
"$ref": "#/responses/notFound"
}
}
- }
- },
- "/user/following/{username}": {
+ },
"put": {
"tags": [
"user"
@@ -5301,6 +5397,15 @@
],
"summary": "List the authenticated user's access tokens",
"operationId": "userGetTokens",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "username of user",
+ "name": "username",
+ "in": "path",
+ "required": true
+ }
+ ],
"responses": {
"200": {
"$ref": "#/responses/AccessTokenList"
@@ -5323,8 +5428,10 @@
{
"type": "string",
"x-go-name": "Name",
- "name": "name",
- "in": "query"
+ "description": "username of user",
+ "name": "username",
+ "in": "path",
+ "required": true
}
],
"responses": {
@@ -7612,9 +7719,6 @@
"description": "SearchResults",
"schema": {
"$ref": "#/definitions/SearchResults"
- },
- "headers": {
- "body": {}
}
},
"ServerVersion": {
@@ -7721,40 +7825,6 @@
"description": "parameterBodies",
"schema": {
"$ref": "#/definitions/EditAttachmentOptions"
- },
- "headers": {
- "AddCollaboratorOption": {},
- "AddTimeOption": {},
- "CreateEmailOption": {},
- "CreateForkOption": {},
- "CreateHookOption": {},
- "CreateIssueCommentOption": {},
- "CreateIssueOption": {},
- "CreateKeyOption": {},
- "CreateLabelOption": {},
- "CreateMilestoneOption": {},
- "CreateOrgOption": {},
- "CreatePullRequestOption": {},
- "CreateReleaseOption": {},
- "CreateRepoOption": {},
- "CreateStatusOption": {},
- "CreateTeamOption": {},
- "CreateUserOption": {},
- "DeleteEmailOption": {},
- "EditAttachmentOptions": {},
- "EditHookOption": {},
- "EditIssueCommentOption": {},
- "EditIssueOption": {},
- "EditLabelOption": {},
- "EditMilestoneOption": {},
- "EditOrgOption": {},
- "EditPullRequestOption": {},
- "EditReleaseOption": {},
- "EditTeamOption": {},
- "EditUserOption": {},
- "IssueLabelsOption": {},
- "MarkdownOption": {},
- "MigrateRepoForm": {}
}
},
"redirect": {