2017-05-02 21:35:59 +08:00
{
"consumes": [
"application/json",
"text/plain"
],
"produces": [
"application/json",
"text/html"
],
"schemes": [
"http",
"https"
],
"swagger": "2.0",
"info": {
2017-11-13 15:02:25 +08:00
"description": "This documentation describes the Gitea API.",
2017-05-02 21:35:59 +08:00
"title": "Gitea API.",
"license": {
"name": "MIT",
"url": "http://opensource.org/licenses/MIT"
},
"version": "1.1.1"
},
2018-07-28 08:19:01 +08:00
"basePath": "{{AppSubUrl}}/api/v1",
2017-05-02 21:35:59 +08:00
"paths": {
2019-01-24 06:30:19 +08:00
"/admin/orgs": {
"get": {
"produces": [
"application/json"
],
"tags": [
"admin"
],
"summary": "List all organizations",
"operationId": "adminGetAllOrgs",
2019-08-05 02:33:36 +08:00
"parameters": [
{
"type": "integer",
"description": "page number of results to return (1-based)",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size of results, maximum page size is 50",
"name": "limit",
"in": "query"
}
],
2019-01-24 06:30:19 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/OrganizationList"
},
"403": {
" $ ref ": " #/responses/forbidden"
}
}
}
},
2017-08-21 19:13:47 +08:00
"/admin/users": {
2019-01-24 06:30:19 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"admin"
],
"summary": "List all users",
"operationId": "adminGetAllUsers",
"responses": {
"200": {
" $ ref ": " #/responses/UserList"
},
"403": {
" $ ref ": " #/responses/forbidden"
}
}
},
2017-05-02 21:35:59 +08:00
"post": {
"consumes": [
"application/json"
],
"produces": [
2017-08-21 19:13:47 +08:00
"application/json"
2017-05-02 21:35:59 +08:00
],
2017-08-21 19:13:47 +08:00
"tags": [
"admin"
],
2017-11-13 15:02:25 +08:00
"summary": "Create a user",
2017-08-21 19:13:47 +08:00
"operationId": "adminCreateUser",
2017-05-02 21:35:59 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-08-21 19:13:47 +08:00
"in": "body",
"schema": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/CreateUserOption"
2017-08-21 19:13:47 +08:00
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/User"
},
2019-12-21 01:07:12 +08:00
"400": {
" $ ref ": " #/responses/error"
},
2017-08-21 19:13:47 +08:00
"403": {
" $ ref ": " #/responses/forbidden"
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
"/admin/users/{username}": {
"delete": {
"produces": [
"application/json"
],
"tags": [
"admin"
],
2017-11-13 15:02:25 +08:00
"summary": "Delete a user",
2017-08-21 19:13:47 +08:00
"operationId": "adminDeleteUser",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "username of user to delete",
"name": "username",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
},
"patch": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"admin"
],
2017-11-13 15:02:25 +08:00
"summary": "Edit an existing user",
2017-08-21 19:13:47 +08:00
"operationId": "adminEditUser",
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "username of user to edit",
"name": "username",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-08-21 19:13:47 +08:00
"in": "body",
"schema": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/EditUserOption"
2017-08-21 19:13:47 +08:00
}
2017-05-02 21:35:59 +08:00
}
],
"responses": {
"200": {
2017-08-21 19:13:47 +08:00
" $ ref ": " #/responses/User"
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-05-02 21:35:59 +08:00
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
2017-08-21 19:13:47 +08:00
"/admin/users/{username}/keys": {
2017-05-02 21:35:59 +08:00
"post": {
"consumes": [
2017-08-21 19:13:47 +08:00
"application/json"
2017-05-02 21:35:59 +08:00
],
"produces": [
2017-08-21 19:13:47 +08:00
"application/json"
],
"tags": [
"admin"
],
2017-11-13 15:02:25 +08:00
"summary": "Add a public key on behalf of a user",
2017-08-21 19:13:47 +08:00
"operationId": "adminCreatePublicKey",
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "username of the user",
"name": "username",
"in": "path",
"required": true
2018-10-21 11:40:42 +08:00
},
{
"name": "key",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateKeyOption"
}
2017-08-21 19:13:47 +08:00
}
2017-05-02 21:35:59 +08:00
],
"responses": {
2017-08-21 19:13:47 +08:00
"201": {
" $ ref ": " #/responses/PublicKey"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
2017-12-06 18:27:10 +08:00
"/admin/users/{username}/keys/{id}": {
"delete": {
"produces": [
"application/json"
],
"tags": [
"admin"
],
"summary": "Delete a user's public key",
"operationId": "adminDeleteUserPublicKey",
"parameters": [
{
"type": "string",
"description": "username of user",
"name": "username",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-12-06 18:27:10 +08:00
"description": "id of the key to delete",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
}
},
2017-08-21 19:13:47 +08:00
"/admin/users/{username}/orgs": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"admin"
],
2017-11-13 15:02:25 +08:00
"summary": "Create an organization",
2017-08-21 19:13:47 +08:00
"operationId": "adminCreateOrg",
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "username of the user that will own the created organization",
2017-08-21 19:13:47 +08:00
"name": "username",
2017-11-13 15:02:25 +08:00
"in": "path",
"required": true
2018-10-21 11:40:42 +08:00
},
{
"name": "organization",
"in": "body",
"required": true,
"schema": {
" $ ref ": " #/definitions/CreateOrgOption"
}
2017-08-21 19:13:47 +08:00
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Organization"
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-05-02 21:35:59 +08:00
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
2017-08-21 19:13:47 +08:00
"/admin/users/{username}/repos": {
2017-05-02 21:35:59 +08:00
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
"admin"
],
2017-11-13 15:02:25 +08:00
"summary": "Create a repository on behalf a user",
2017-08-21 19:13:47 +08:00
"operationId": "adminCreateRepo",
2017-05-02 21:35:59 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "username of the user. This user will own the created repository",
"name": "username",
"in": "path",
"required": true
2018-10-21 11:40:42 +08:00
},
{
"name": "repository",
"in": "body",
"required": true,
"schema": {
" $ ref ": " #/definitions/CreateRepoOption"
}
2017-05-02 21:35:59 +08:00
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Repository"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
2019-12-21 01:07:12 +08:00
"404": {
" $ ref ": " #/responses/notFound"
},
"409": {
" $ ref ": " #/responses/error"
},
2017-05-02 21:35:59 +08:00
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
2017-08-21 19:13:47 +08:00
"/markdown": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"text/html"
],
"tags": [
"miscellaneous"
],
2017-11-13 15:02:25 +08:00
"summary": "Render a markdown document as HTML",
2017-08-21 19:13:47 +08:00
"operationId": "renderMarkdown",
"parameters": [
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-08-21 19:13:47 +08:00
"in": "body",
"schema": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/MarkdownOption"
2017-08-21 19:13:47 +08:00
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/MarkdownRender"
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
"/markdown/raw": {
"post": {
"consumes": [
"text/plain"
],
"produces": [
"text/html"
],
"tags": [
"miscellaneous"
],
2017-11-13 15:02:25 +08:00
"summary": "Render raw markdown as HTML",
2017-08-21 19:13:47 +08:00
"operationId": "renderMarkdownRaw",
2017-11-13 15:02:25 +08:00
"parameters": [
{
2018-06-12 22:59:22 +08:00
"description": "Request body to render",
2017-11-13 15:02:25 +08:00
"name": "body",
2018-06-12 22:59:22 +08:00
"in": "body",
"required": true,
"schema": {
"type": "string"
}
2017-11-13 15:02:25 +08:00
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/MarkdownRender"
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
2020-01-09 19:56:32 +08:00
"/notifications": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"notification"
],
"summary": "List users's notification threads",
"operationId": "notifyGetList",
"parameters": [
{
"type": "string",
"description": "If true, show notifications marked as read. Default value is false",
"name": "all",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
"name": "since",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
"name": "before",
"in": "query"
}
],
"responses": {
"200": {
" $ ref ": " #/responses/NotificationThreadList"
}
}
},
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"notification"
],
"summary": "Mark notification threads as read",
"operationId": "notifyReadList",
"parameters": [
{
"type": "string",
"format": "date-time",
"description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
"name": "last_read_at",
"in": "query"
}
],
"responses": {
"205": {
" $ ref ": " #/responses/empty"
}
}
}
},
2020-01-14 23:37:19 +08:00
"/notifications/new": {
"get": {
"tags": [
"notification"
],
"summary": "Check if unread notifications exist",
"operationId": "notifyNewAvailable",
"responses": {
"200": {
" $ ref ": " #/responses/NotificationCount"
},
"204": {
"description": "No unread notification"
}
}
}
},
2020-01-09 19:56:32 +08:00
"/notifications/threads/{id}": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"notification"
],
"summary": "Get notification thread by ID",
"operationId": "notifyGetThread",
"parameters": [
{
"type": "string",
"description": "id of notification thread",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/NotificationThread"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
},
"patch": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"notification"
],
"summary": "Mark notification thread as read by ID",
"operationId": "notifyReadThread",
"parameters": [
{
"type": "string",
"description": "id of notification thread",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"205": {
" $ ref ": " #/responses/empty"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
}
},
2017-08-21 19:13:47 +08:00
"/org/{org}/repos": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Create a repository in an organization",
2020-01-10 00:40:01 +08:00
"operationId": "createOrgRepoDeprecated",
"deprecated": true,
2017-08-21 19:13:47 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "name of organization",
"name": "org",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-08-21 19:13:47 +08:00
"in": "body",
"schema": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/CreateRepoOption"
2017-08-21 19:13:47 +08:00
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Repository"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
2018-11-21 01:31:30 +08:00
"/orgs": {
2020-01-12 23:43:44 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Get list of organizations",
"operationId": "orgGetAll",
"parameters": [
{
"type": "integer",
"description": "page number of results to return (1-based)",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size of results, maximum page size is 50",
"name": "limit",
"in": "query"
}
],
"responses": {
"200": {
" $ ref ": " #/responses/OrganizationList"
}
}
},
2018-11-21 01:31:30 +08:00
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Create an organization",
"operationId": "orgCreate",
"parameters": [
{
"name": "organization",
"in": "body",
"required": true,
"schema": {
" $ ref ": " #/definitions/CreateOrgOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Organization"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/orgs/{org}": {
2017-08-21 19:13:47 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Get an organization",
"operationId": "orgGet",
"parameters": [
{
"type": "string",
"description": "name of the organization to get",
"name": "org",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Organization"
2017-08-21 19:13:47 +08:00
}
}
2017-11-13 15:02:25 +08:00
},
2018-12-27 23:36:58 +08:00
"delete": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Delete an organization",
"operationId": "orgDelete",
"parameters": [
{
"type": "string",
"description": "organization that is to be deleted",
"name": "org",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
},
2017-11-13 15:02:25 +08:00
"patch": {
2017-08-21 19:13:47 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Edit an organization",
"operationId": "orgEdit",
2017-08-21 19:13:47 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "name of the organization to edit",
"name": "org",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-08-21 19:13:47 +08:00
"in": "body",
2019-05-31 01:57:55 +08:00
"required": true,
2017-08-21 19:13:47 +08:00
"schema": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/EditOrgOption"
2017-08-21 19:13:47 +08:00
}
}
],
2017-11-13 15:02:25 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/Organization"
}
}
}
},
"/orgs/{org}/hooks": {
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "List an organization's webhooks",
"operationId": "orgListHooks",
2018-06-12 22:59:22 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
}
],
2017-11-13 15:02:25 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/HookList"
}
}
}
},
"/orgs/{org}/hooks/": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Create a hook",
"operationId": "orgCreateHook",
2018-06-12 22:59:22 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
2018-10-21 11:40:42 +08:00
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
" $ ref ": " #/definitions/CreateHookOption"
}
2018-06-12 22:59:22 +08:00
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"201": {
" $ ref ": " #/responses/Hook"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/orgs/{org}/hooks/{id}": {
2017-08-21 19:13:47 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Get a hook",
2017-08-21 19:13:47 +08:00
"operationId": "orgGetHook",
2018-06-12 22:59:22 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-06-12 22:59:22 +08:00
"description": "id of the hook to get",
"name": "id",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/Hook"
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Delete a hook",
2017-08-21 19:13:47 +08:00
"operationId": "orgDeleteHook",
2018-06-12 22:59:22 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-06-12 22:59:22 +08:00
"description": "id of the hook to delete",
"name": "id",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
},
"patch": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Update a hook",
2017-08-21 19:13:47 +08:00
"operationId": "orgEditHook",
2018-06-12 22:59:22 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-06-12 22:59:22 +08:00
"description": "id of the hook to update",
"name": "id",
"in": "path",
"required": true
2018-10-21 11:40:42 +08:00
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditHookOption"
}
2018-06-12 22:59:22 +08:00
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/Hook"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/orgs/{org}/members": {
2017-08-21 19:13:47 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "List an organization's members",
2017-08-21 19:13:47 +08:00
"operationId": "orgListMembers",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/UserList"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/orgs/{org}/members/{username}": {
2017-08-21 19:13:47 +08:00
"get": {
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Check if a user is a member of an organization",
2017-08-21 19:13:47 +08:00
"operationId": "orgIsMember",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of the user",
"name": "username",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"204": {
2018-10-21 11:40:42 +08:00
"description": "user is a member"
2017-08-21 19:13:47 +08:00
},
2019-12-21 01:07:12 +08:00
"302": {
"description": "redirection to /orgs/{org}/public_members/{username}"
},
2017-08-21 19:13:47 +08:00
"404": {
2018-10-21 11:40:42 +08:00
"description": "user is not a member"
2017-08-21 19:13:47 +08:00
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Remove a member from an organization",
2017-08-21 19:13:47 +08:00
"operationId": "orgDeleteMember",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of the user",
"name": "username",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"204": {
2018-10-21 11:40:42 +08:00
"description": "member removed"
2017-08-21 19:13:47 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/orgs/{org}/public_members": {
2017-08-21 19:13:47 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "List an organization's public members",
2017-08-21 19:13:47 +08:00
"operationId": "orgListPublicMembers",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/UserList"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/orgs/{org}/public_members/{username}": {
2017-08-21 19:13:47 +08:00
"get": {
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Check if a user is a public member of an organization",
2017-08-21 19:13:47 +08:00
"operationId": "orgIsPublicMember",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of the user",
"name": "username",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"204": {
2018-10-21 11:40:42 +08:00
"description": "user is a public member"
2017-08-21 19:13:47 +08:00
},
"404": {
2018-10-21 11:40:42 +08:00
"description": "user is not a public member"
2017-08-21 19:13:47 +08:00
}
}
},
"put": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Publicize a user's membership",
2017-08-21 19:13:47 +08:00
"operationId": "orgPublicizeMember",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of the user",
"name": "username",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"204": {
2018-10-21 11:40:42 +08:00
"description": "membership publicized"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-08-21 19:13:47 +08:00
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "Conceal a user's membership",
2017-08-21 19:13:47 +08:00
"operationId": "orgConcealMember",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of the user",
"name": "username",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-08-21 19:13:47 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/orgs/{org}/repos": {
2017-08-21 19:13:47 +08:00
"get": {
"produces": [
2017-07-13 19:14:15 +08:00
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
"organization"
],
2017-11-13 15:02:25 +08:00
"summary": "List an organization's repos",
2017-07-13 19:14:15 +08:00
"operationId": "orgListRepos",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
}
],
2017-07-13 19:14:15 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/RepositoryList"
}
}
2020-01-10 00:40:01 +08:00
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Create a repository in an organization",
"operationId": "createOrgRepo",
"parameters": [
{
"type": "string",
"description": "name of organization",
"name": "org",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateRepoOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Repository"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
2017-07-13 19:14:15 +08:00
}
},
2017-11-13 15:02:25 +08:00
"/orgs/{org}/teams": {
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "List an organization's teams",
"operationId": "orgListTeams",
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/TeamList"
}
}
},
2017-08-21 19:13:47 +08:00
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2017-11-13 15:02:25 +08:00
"organization"
2017-08-21 19:13:47 +08:00
],
2017-11-13 15:02:25 +08:00
"summary": "Create a team",
"operationId": "orgCreateTeam",
2017-08-21 19:13:47 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-08-21 19:13:47 +08:00
"in": "body",
"schema": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/CreateTeamOption"
2017-08-21 19:13:47 +08:00
}
2017-11-13 15:02:25 +08:00
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Team"
2019-12-21 01:07:12 +08:00
},
"422": {
" $ ref ": " #/responses/validationError"
2017-11-13 15:02:25 +08:00
}
}
}
},
2019-10-01 13:32:28 +08:00
"/orgs/{org}/teams/search": {
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Search for teams within an organization",
"operationId": "teamSearch",
"parameters": [
{
"type": "string",
"description": "name of the organization",
"name": "org",
"in": "path",
"required": true
},
{
"type": "string",
"description": "keywords to search",
"name": "q",
"in": "query"
},
{
"type": "boolean",
"description": "include search within team description (defaults to true)",
"name": "include_desc",
"in": "query"
},
{
"type": "integer",
"description": "limit size of results",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"description": "page number of results to return (1-based)",
"name": "page",
"in": "query"
}
],
"responses": {
"200": {
"description": "SearchResults of a successful search",
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Team"
}
},
"ok": {
"type": "boolean"
}
}
}
}
}
}
},
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 13:06:10 +08:00
"/repos/issues/search": {
"get": {
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Search for issues across the repositories that the user has access to",
"operationId": "issueSearchIssues",
"parameters": [
{
"type": "string",
"description": "whether issue is open or closed",
"name": "state",
"in": "query"
},
{
"type": "string",
"description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
"name": "labels",
"in": "query"
},
{
"type": "integer",
"description": "page number of requested issues",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "search string",
"name": "q",
"in": "query"
},
{
"type": "integer",
"format": "int64",
"description": "repository to prioritize in the results",
"name": "priority_repo_id",
"in": "query"
2020-01-19 14:43:38 +08:00
},
{
"type": "string",
"description": "filter by type (issues / pulls) if set",
"name": "type",
"in": "query"
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 13:06:10 +08:00
}
],
"responses": {
"200": {
" $ ref ": " #/responses/IssueList"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/migrate": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Migrate a remote git repository",
"operationId": "repoMigrate",
"parameters": [
2017-08-21 19:13:47 +08:00
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-08-21 19:13:47 +08:00
"in": "body",
"schema": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/MigrateRepoForm"
2017-08-21 19:13:47 +08:00
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Repository"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"422": {
" $ ref ": " #/responses/validationError"
2017-08-21 19:13:47 +08:00
}
}
}
},
2017-05-02 21:35:59 +08:00
"/repos/search": {
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "Search for repositories",
2017-05-02 21:35:59 +08:00
"operationId": "repoSearch",
"parameters": [
{
"type": "string",
2017-11-13 15:02:25 +08:00
"description": "keyword",
2017-05-02 21:35:59 +08:00
"name": "q",
"in": "query"
},
2019-08-24 11:17:10 +08:00
{
"type": "boolean",
"description": "Limit search to repositories with keyword as topic",
"name": "topic",
"in": "query"
},
2019-08-26 01:06:36 +08:00
{
"type": "boolean",
"description": "include search of keyword within repository description",
"name": "includeDesc",
"in": "query"
},
2017-05-02 21:35:59 +08:00
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-15 16:10:26 +08:00
"description": "search only for repos that the user with the given id owns or contributes to",
2017-05-02 21:35:59 +08:00
"name": "uid",
"in": "query"
},
2019-11-11 23:15:29 +08:00
{
"type": "integer",
"format": "int64",
"description": "repo owner to prioritize in the results",
"name": "priority_owner_id",
"in": "query"
},
2019-05-15 23:24:39 +08:00
{
"type": "integer",
"format": "int64",
"description": "search only for repos that the user with the given id has starred",
"name": "starredBy",
"in": "query"
},
{
"type": "boolean",
"description": "include private repositories this user has access to (defaults to true)",
"name": "private",
"in": "query"
},
2019-11-11 23:15:29 +08:00
{
"type": "boolean",
"description": "include template repositories this user has access to (defaults to true)",
"name": "template",
"in": "query"
},
2017-05-02 21:35:59 +08:00
{
"type": "integer",
2017-11-15 16:10:26 +08:00
"description": "page number of results to return (1-based)",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size of results, maximum page size is 50",
2017-05-02 21:35:59 +08:00
"name": "limit",
"in": "query"
2017-10-27 05:16:13 +08:00
},
{
"type": "string",
2017-11-13 15:02:25 +08:00
"description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
2017-10-27 05:16:13 +08:00
"name": "mode",
"in": "query"
},
{
"type": "boolean",
2017-11-15 16:10:26 +08:00
"description": "if `uid` is given, search only for repos that the user owns",
2017-10-27 05:16:13 +08:00
"name": "exclusive",
"in": "query"
2018-08-02 16:10:02 +08:00
},
{
"type": "string",
"description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
"name": "sort",
"in": "query"
},
{
"type": "string",
"description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
"name": "order",
"in": "query"
2017-05-02 21:35:59 +08:00
}
],
"responses": {
"200": {
" $ ref ": " #/responses/SearchResults"
},
2017-10-27 05:16:13 +08:00
"422": {
" $ ref ": " #/responses/validationError"
2017-08-21 19:13:47 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}": {
2017-08-21 19:13:47 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "Get a repository",
"operationId": "repoGet",
"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
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Repository"
2017-08-21 19:13:47 +08:00
}
}
},
2017-11-13 15:02:25 +08:00
"delete": {
2017-08-21 19:13:47 +08:00
"produces": [
"application/json"
],
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "Delete a repository",
"operationId": "repoDelete",
2017-08-21 19:13:47 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "owner of the repo to delete",
"name": "owner",
"in": "path",
"required": true
},
{
"type": "string",
"description": "name of the repo to delete",
"name": "repo",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
}
],
"responses": {
2017-11-13 15:02:25 +08:00
"204": {
" $ ref ": " #/responses/empty"
2017-08-21 19:13:47 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
}
}
2019-05-30 23:09:05 +08:00
},
"patch": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Edit a repository's properties. Only fields that are set will be changed.",
"operationId": "repoEdit",
"parameters": [
{
"type": "string",
"description": "owner of the repo to edit",
"name": "owner",
"in": "path",
"required": true
},
{
"type": "string",
"description": "name of the repo to edit",
"name": "repo",
"in": "path",
"required": true
},
{
"description": "Properties of a repo that you can edit",
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditRepoOption"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Repository"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
2017-08-21 19:13:47 +08:00
}
},
2018-06-12 22:59:22 +08:00
"/repos/{owner}/{repo}/archive/{archive}": {
2017-08-21 19:13:47 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "Get an archive of a repository",
"operationId": "repoGetArchive",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "string",
"description": "archive to download, consisting of a git reference and archive",
"name": "archive",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
}
2017-11-13 15:02:25 +08:00
],
"responses": {
2018-06-01 13:51:49 +08:00
"200": {
"description": "success"
2019-12-21 01:07:12 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2018-06-01 13:51:49 +08:00
}
2017-08-21 19:13:47 +08:00
}
2017-11-13 15:02:25 +08:00
}
},
"/repos/{owner}/{repo}/branches": {
"get": {
2017-08-21 19:13:47 +08:00
"produces": [
"application/json"
],
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "List a repository's branches",
"operationId": "repoListBranches",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/BranchList"
2017-08-21 19:13:47 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/branches/{branch}": {
2017-08-21 19:13:47 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
2019-11-17 03:39:18 +08:00
"summary": "Retrieve a specific branch from a repository, including its effective branch protection",
2017-11-13 15:02:25 +08:00
"operationId": "repoGetBranch",
"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": "string",
"description": "branch to get",
"name": "branch",
"in": "path",
"required": true
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Branch"
2017-08-21 19:13:47 +08:00
}
}
2017-11-13 15:02:25 +08:00
}
},
"/repos/{owner}/{repo}/collaborators": {
"get": {
2017-08-21 19:13:47 +08:00
"produces": [
"application/json"
],
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "List a repository's collaborators",
"operationId": "repoListCollaborators",
2017-08-21 19:13:47 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
}
],
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/UserList"
2017-05-02 21:35:59 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/collaborators/{collaborator}": {
"get": {
2017-06-12 08:59:51 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "Check if a user is a collaborator of a repository",
"operationId": "repoCheckCollaborator",
"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": "string",
"description": "username of the collaborator",
"name": "collaborator",
"in": "path",
"required": true
}
],
2017-06-12 08:59:51 +08:00
"responses": {
2017-08-21 19:13:47 +08:00
"204": {
" $ ref ": " #/responses/empty"
},
"404": {
2019-12-21 01:07:12 +08:00
" $ ref ": " #/responses/notFound"
},
"422": {
" $ ref ": " #/responses/validationError"
2017-06-12 08:59:51 +08:00
}
}
},
2017-11-13 15:02:25 +08:00
"put": {
2017-06-12 08:59:51 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "Add a collaborator to a repository",
"operationId": "repoAddCollaborator",
2017-08-21 19:13:47 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-06-12 08:59:51 +08:00
},
2017-08-21 19:13:47 +08:00
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of the collaborator to add",
"name": "collaborator",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-08-21 19:13:47 +08:00
"in": "body",
"schema": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/AddCollaboratorOption"
2017-08-21 19:13:47 +08:00
}
}
],
"responses": {
2017-11-13 15:02:25 +08:00
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"422": {
" $ ref ": " #/responses/validationError"
2017-06-12 08:59:51 +08:00
}
}
2017-11-13 15:02:25 +08:00
},
"delete": {
2017-09-12 14:48:13 +08:00
"produces": [
"application/json"
],
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "Delete a collaborator from a repository",
"operationId": "repoDeleteCollaborator",
"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": "string",
"description": "username of the collaborator to delete",
"name": "collaborator",
"in": "path",
"required": true
}
],
2017-09-12 14:48:13 +08:00
"responses": {
2017-11-13 15:02:25 +08:00
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"422": {
" $ ref ": " #/responses/validationError"
2017-11-13 15:02:25 +08:00
}
}
}
},
2019-08-26 22:09:10 +08:00
"/repos/{owner}/{repo}/commits": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get a list of all commits from a repository",
"operationId": "repoGetAllCommits",
"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": "string",
"description": "SHA or branch to start listing commits from (usually 'master')",
"name": "sha",
"in": "query"
},
{
"type": "integer",
"description": "page number of requested commits",
"name": "page",
"in": "query"
}
],
"responses": {
"200": {
" $ ref ": " #/responses/CommitList"
},
"404": {
" $ ref ": " #/responses/notFound"
},
"409": {
" $ ref ": " #/responses/EmptyRepository"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/commits/{ref}/statuses": {
"get": {
2017-05-19 08:20:06 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "Get a commit's combined status, by branch/tag/commit reference",
"operationId": "repoGetCombinedStatusByRef",
"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": "string",
"description": "name of branch/tag/commit",
"name": "ref",
"in": "path",
"required": true
2019-07-25 18:55:06 +08:00
},
{
"type": "integer",
"description": "page number of results",
"name": "page",
"in": "query"
2017-11-13 15:02:25 +08:00
}
],
2017-05-19 08:20:06 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Status"
2019-12-21 01:07:12 +08:00
},
"400": {
" $ ref ": " #/responses/error"
2017-05-19 08:20:06 +08:00
}
}
}
},
2019-06-30 04:51:10 +08:00
"/repos/{owner}/{repo}/contents": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Gets the metadata of all the entries of the root dir",
"operationId": "repoGetContentsList",
"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": "string",
"description": "The name of the commit/branch/tag. Default the repository’
"name": "ref",
"in": "query"
}
],
"responses": {
"200": {
" $ ref ": " #/responses/ContentsListResponse"
}
}
}
},
2019-04-18 00:06:35 +08:00
"/repos/{owner}/{repo}/contents/{filepath}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
2019-06-30 04:51:10 +08:00
"summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
"operationId": "repoGetContents",
2019-04-18 00:06:35 +08:00
"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": "string",
2019-06-30 04:51:10 +08:00
"description": "path of the dir, file, symlink or submodule in the repo",
2019-04-18 00:06:35 +08:00
"name": "filepath",
"in": "path",
"required": true
},
{
"type": "string",
"description": "The name of the commit/branch/tag. Default the repository’
"name": "ref",
"in": "query"
}
],
"responses": {
"200": {
2019-06-30 04:51:10 +08:00
" $ ref ": " #/responses/ContentsResponse"
2019-04-18 00:06:35 +08:00
}
}
},
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Update a file in a repository",
"operationId": "repoUpdateFile",
"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": "string",
"description": "path of the file to update",
"name": "filepath",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
2019-05-31 01:57:55 +08:00
"required": true,
2019-04-18 00:06:35 +08:00
"schema": {
" $ ref ": " #/definitions/UpdateFileOptions"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/FileResponse"
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Create a file in a repository",
"operationId": "repoCreateFile",
"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": "string",
"description": "path of the file to create",
"name": "filepath",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
2019-05-31 01:57:55 +08:00
"required": true,
2019-04-18 00:06:35 +08:00
"schema": {
" $ ref ": " #/definitions/CreateFileOptions"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/FileResponse"
}
}
},
"delete": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Delete a file in a repository",
"operationId": "repoDeleteFile",
"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": "string",
"description": "path of the file to delete",
"name": "filepath",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
2019-05-31 01:57:55 +08:00
"required": true,
2019-04-18 00:06:35 +08:00
"schema": {
" $ ref ": " #/definitions/DeleteFileOptions"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/FileDeleteResponse"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/editorconfig/{filepath}": {
2017-05-02 21:35:59 +08:00
"get": {
2017-11-13 15:02:25 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "Get the EditorConfig definitions of a file in a repository",
"operationId": "repoGetEditorConfig",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "filepath of file to get",
"name": "filepath",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
2018-06-01 13:51:49 +08:00
"200": {
"description": "success"
2019-12-21 01:07:12 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2018-06-01 13:51:49 +08:00
}
2017-05-02 21:35:59 +08:00
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/forks": {
2017-09-12 14:48:13 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "List a repository's forks",
"operationId": "listForks",
"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
}
],
2017-09-12 14:48:13 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/RepositoryList"
2017-09-12 14:48:13 +08:00
}
}
2017-11-13 15:02:25 +08:00
},
"post": {
2017-09-12 14:48:13 +08:00
"produces": [
"application/json"
],
"tags": [
2017-11-13 15:02:25 +08:00
"repository"
2017-09-12 14:48:13 +08:00
],
2017-11-13 15:02:25 +08:00
"summary": "Fork a repository",
"operationId": "createFork",
"parameters": [
{
"type": "string",
"description": "owner of the repo to fork",
"name": "owner",
"in": "path",
"required": true
2017-09-12 14:48:13 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo to fork",
"name": "repo",
"in": "path",
"required": true
2017-09-12 14:48:13 +08:00
},
2017-11-13 15:02:25 +08:00
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateForkOption"
}
}
],
"responses": {
"202": {
" $ ref ": " #/responses/Repository"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"422": {
" $ ref ": " #/responses/validationError"
2017-09-12 14:48:13 +08:00
}
}
}
},
2019-04-18 00:06:35 +08:00
"/repos/{owner}/{repo}/git/blobs/{sha}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Gets the blob of a repository.",
"operationId": "GetBlob",
"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": "string",
"description": "sha of the commit",
"name": "sha",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/GitBlobResponse"
2019-12-21 01:07:12 +08:00
},
"400": {
" $ ref ": " #/responses/error"
2019-04-18 00:06:35 +08:00
}
}
}
},
2019-02-03 11:35:17 +08:00
"/repos/{owner}/{repo}/git/commits/{sha}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get a single commit from a repository",
"operationId": "repoGetSingleCommit",
"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": "string",
"description": "the commit hash",
"name": "sha",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Commit"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
}
},
2018-11-28 05:52:20 +08:00
"/repos/{owner}/{repo}/git/refs": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get specified ref or filtered repository's refs",
"operationId": "repoListAllGitRefs",
"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
}
],
"responses": {
"200": {
" $ ref ": " #/responses/ReferenceList"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
}
},
"/repos/{owner}/{repo}/git/refs/{ref}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get specified ref or filtered repository's refs",
"operationId": "repoListGitRefs",
"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": "string",
"description": "part or full name of the ref",
"name": "ref",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/ReferenceList"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
}
},
2019-06-08 22:31:11 +08:00
"/repos/{owner}/{repo}/git/tags/{sha}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
2019-08-27 03:52:04 +08:00
"summary": "Gets the tag object of an annotated tag (not lightweight tags)",
2019-06-08 22:31:11 +08:00
"operationId": "GetTag",
"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": "string",
2019-08-27 03:52:04 +08:00
"description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
2019-06-08 22:31:11 +08:00
"name": "sha",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/AnnotatedTag"
2019-12-21 01:07:12 +08:00
},
"400": {
" $ ref ": " #/responses/error"
2019-06-08 22:31:11 +08:00
}
}
}
},
2019-01-25 02:13:30 +08:00
"/repos/{owner}/{repo}/git/trees/{sha}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Gets the tree of a repository.",
"operationId": "GetTree",
"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": "string",
"description": "sha of the commit",
"name": "sha",
"in": "path",
"required": true
2019-02-07 02:19:26 +08:00
},
{
"type": "boolean",
"description": "show all directories and files",
"name": "recursive",
"in": "query"
},
{
"type": "integer",
"description": "page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
"name": "per_page",
"in": "query"
2019-01-25 02:13:30 +08:00
}
],
"responses": {
"200": {
" $ ref ": " #/responses/GitTreeResponse"
2019-12-21 01:07:12 +08:00
},
"400": {
" $ ref ": " #/responses/error"
2019-01-25 02:13:30 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/hooks": {
2017-08-21 19:13:47 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
2017-11-13 15:02:25 +08:00
"summary": "List the hooks in a repository",
"operationId": "repoListHooks",
"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
}
],
2017-08-21 19:13:47 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/HookList"
2017-08-21 19:13:47 +08:00
}
}
2017-11-13 15:02:25 +08:00
},
"post": {
"consumes": [
"application/json"
],
2017-05-02 21:35:59 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"repository"
],
"summary": "Create a hook",
"operationId": "repoCreateHook",
"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
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateHookOption"
}
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
2017-11-20 15:00:53 +08:00
"201": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Hook"
2017-05-02 21:35:59 +08:00
}
}
}
},
2019-04-17 13:31:08 +08:00
"/repos/{owner}/{repo}/hooks/git": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "List the Git hooks in a repository",
"operationId": "repoListGitHooks",
"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
}
],
"responses": {
"200": {
" $ ref ": " #/responses/GitHookList"
}
}
}
},
"/repos/{owner}/{repo}/hooks/git/{id}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get a Git hook",
"operationId": "repoGetGitHook",
"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": "string",
"description": "id of the hook to get",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/GitHook"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Delete a Git hook in a repository",
"operationId": "repoDeleteGitHook",
"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": "string",
"description": "id of the hook to get",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
},
"patch": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Edit a Git hook in a repository",
"operationId": "repoEditGitHook",
"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": "string",
"description": "id of the hook to get",
"name": "id",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditGitHookOption"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/GitHook"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/hooks/{id}": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"repository"
],
"summary": "Get a hook",
"operationId": "repoGetHook",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the hook to get",
"name": "id",
"in": "path",
"required": true
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Hook"
2019-12-21 01:07:12 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2017-05-02 21:35:59 +08:00
}
}
2017-11-13 15:02:25 +08:00
},
2018-06-12 22:59:22 +08:00
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-06-12 22:59:22 +08:00
"description": "id of the hook to delete",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
},
2017-11-13 15:02:25 +08:00
"patch": {
2017-05-02 21:35:59 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"repository"
],
"summary": "Edit a hook in a repository",
"operationId": "repoEditHook",
"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
},
2018-06-12 22:59:22 +08:00
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-06-12 22:59:22 +08:00
"description": "index of the hook",
"name": "id",
"in": "path",
"required": true
},
2017-11-13 15:02:25 +08:00
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditHookOption"
}
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Hook"
2017-05-02 21:35:59 +08:00
}
}
}
},
2018-04-29 14:21:33 +08:00
"/repos/{owner}/{repo}/hooks/{id}/tests": {
"post": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Test a push webhook",
"operationId": "repoTestHook",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-04-29 14:21:33 +08:00
"description": "id of the hook to test",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
}
},
2018-05-08 14:05:18 +08:00
"/repos/{owner}/{repo}/issues": {
2017-05-02 21:35:59 +08:00
"get": {
2017-11-13 15:02:25 +08:00
"produces": [
"application/json"
2017-08-21 19:13:47 +08:00
],
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
2017-08-21 19:13:47 +08:00
],
2018-05-08 14:05:18 +08:00
"summary": "List a repository's issues",
"operationId": "issueListIssues",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
2018-05-08 14:05:18 +08:00
{
"type": "string",
"description": "whether issue is open or closed",
"name": "state",
"in": "query"
},
2019-02-04 23:20:44 +08:00
{
"type": "string",
"description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
"name": "labels",
"in": "query"
},
2017-11-13 15:02:25 +08:00
{
"type": "integer",
2018-05-08 14:05:18 +08:00
"description": "page number of requested issues",
"name": "page",
"in": "query"
2017-11-13 15:02:25 +08:00
},
{
"type": "string",
2018-05-08 14:05:18 +08:00
"description": "search string",
"name": "q",
2017-11-13 15:02:25 +08:00
"in": "query"
2020-01-20 20:00:32 +08:00
},
{
"type": "string",
"description": "filter by type (issues / pulls) if set",
"name": "type",
"in": "query"
2017-05-02 21:35:59 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
2017-11-13 15:02:25 +08:00
"200": {
2018-05-08 14:05:18 +08:00
" $ ref ": " #/responses/IssueList"
2017-05-02 21:35:59 +08:00
}
}
2018-05-08 14:05:18 +08:00
},
"post": {
2017-11-13 15:02:25 +08:00
"consumes": [
"application/json"
],
2017-05-02 21:35:59 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
],
2019-01-02 01:56:47 +08:00
"summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
2018-05-08 14:05:18 +08:00
"operationId": "issueCreateIssue",
2017-11-13 15:02:25 +08:00
"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
},
{
"name": "body",
"in": "body",
"schema": {
2018-05-08 14:05:18 +08:00
" $ ref ": " #/definitions/CreateIssueOption"
2017-11-13 15:02:25 +08:00
}
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
2018-05-08 14:05:18 +08:00
"201": {
" $ ref ": " #/responses/Issue"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"412": {
" $ ref ": " #/responses/error"
},
"422": {
" $ ref ": " #/responses/validationError"
2017-05-02 21:35:59 +08:00
}
}
2018-05-08 14:05:18 +08:00
}
},
"/repos/{owner}/{repo}/issues/comments": {
"get": {
2017-05-02 21:35:59 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
2017-08-21 19:13:47 +08:00
],
2018-05-08 14:05:18 +08:00
"summary": "List all comments in a repository",
"operationId": "issueGetRepoComments",
2017-05-02 21:35:59 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"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
},
{
2018-05-08 14:05:18 +08:00
"type": "string",
2020-01-14 00:02:24 +08:00
"format": "date-time",
2018-05-08 14:05:18 +08:00
"description": "if provided, only comments updated since the provided time are returned.",
2018-07-12 21:40:41 +08:00
"name": "since",
2018-05-08 14:05:18 +08:00
"in": "query"
2020-01-14 00:02:24 +08:00
},
{
"type": "string",
"format": "date-time",
"description": "if provided, only comments updated before the provided time are returned.",
"name": "before",
"in": "query"
2017-05-02 21:35:59 +08:00
}
],
"responses": {
2017-11-13 15:02:25 +08:00
"200": {
2018-05-08 14:05:18 +08:00
" $ ref ": " #/responses/CommentList"
2017-05-02 21:35:59 +08:00
}
}
2018-05-08 14:05:18 +08:00
}
},
"/repos/{owner}/{repo}/issues/comments/{id}": {
2020-01-08 15:00:59 +08:00
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Get a comment",
"operationId": "issueGetComment",
"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",
"format": "int64",
"description": "id of the comment",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Comment"
},
"204": {
" $ ref ": " #/responses/empty"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
},
2017-11-13 15:02:25 +08:00
"delete": {
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
2017-08-21 19:13:47 +08:00
],
2018-05-08 14:05:18 +08:00
"summary": "Delete a comment",
"operationId": "issueDeleteComment",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "id of comment to delete",
"name": "id",
2017-11-13 15:02:25 +08:00
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2020-01-08 15:00:59 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2017-05-02 21:35:59 +08:00
}
}
2018-05-08 14:05:18 +08:00
},
"patch": {
"consumes": [
"application/json"
],
2017-05-02 21:35:59 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
],
2018-05-08 14:05:18 +08:00
"summary": "Edit a comment",
"operationId": "issueEditComment",
2017-11-13 15:02:25 +08:00
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "id of the comment to edit",
"name": "id",
2017-11-13 15:02:25 +08:00
"in": "path",
"required": true
},
{
2018-05-08 14:05:18 +08:00
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditIssueCommentOption"
}
2017-11-13 15:02:25 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
2018-05-08 14:05:18 +08:00
"200": {
" $ ref ": " #/responses/Comment"
2020-01-08 15:00:59 +08:00
},
"204": {
" $ ref ": " #/responses/empty"
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"404": {
" $ ref ": " #/responses/notFound"
2017-05-02 21:35:59 +08:00
}
}
}
},
2019-12-08 06:04:19 +08:00
"/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
2020-01-06 12:58:13 +08:00
"summary": "Get a list of reactions from a comment of an issue",
2019-12-08 06:04:19 +08:00
"operationId": "issueGetCommentReactions",
"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",
"format": "int64",
"description": "id of the comment to edit",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
2019-12-31 16:21:21 +08:00
" $ ref ": " #/responses/ReactionList"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2019-12-08 06:04:19 +08:00
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
2020-01-06 12:58:13 +08:00
"summary": "Add a reaction to a comment of an issue",
2019-12-08 06:04:19 +08:00
"operationId": "issuePostCommentReaction",
"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",
"format": "int64",
"description": "id of the comment to edit",
"name": "id",
"in": "path",
"required": true
},
{
"name": "content",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditReactionOption"
}
}
],
"responses": {
2019-12-31 16:21:21 +08:00
"200": {
" $ ref ": " #/responses/Reaction"
},
2019-12-08 06:04:19 +08:00
"201": {
2019-12-31 16:21:21 +08:00
" $ ref ": " #/responses/Reaction"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2019-12-08 06:04:19 +08:00
}
}
},
"delete": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
2020-01-06 12:58:13 +08:00
"summary": "Remove a reaction from a comment of an issue",
2019-12-08 06:04:19 +08:00
"operationId": "issueDeleteCommentReaction",
"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",
"format": "int64",
"description": "id of the comment to edit",
"name": "id",
"in": "path",
"required": true
},
{
"name": "content",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditReactionOption"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2019-12-08 06:04:19 +08:00
}
}
}
},
2018-05-08 14:05:18 +08:00
"/repos/{owner}/{repo}/issues/{index}": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
],
2018-05-08 14:05:18 +08:00
"summary": "Get an issue",
"operationId": "issueGetIssue",
2017-11-13 15:02:25 +08:00
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "index of the issue to get",
"name": "index",
"in": "path",
"required": true
2017-11-13 15:02:25 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2018-05-08 14:05:18 +08:00
" $ ref ": " #/responses/Issue"
2019-12-21 01:07:12 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2017-05-02 21:35:59 +08:00
}
}
},
2018-05-08 14:05:18 +08:00
"patch": {
2017-05-02 21:35:59 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
2017-08-21 19:13:47 +08:00
],
2019-01-02 01:56:47 +08:00
"summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
2018-05-08 14:05:18 +08:00
"operationId": "issueEditIssue",
2017-05-02 21:35:59 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"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
2017-05-02 21:35:59 +08:00
},
2018-05-08 14:05:18 +08:00
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "index of the issue to edit",
"name": "index",
"in": "path",
"required": true
},
2017-05-02 21:35:59 +08:00
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-05-02 21:35:59 +08:00
"in": "body",
"schema": {
2018-05-08 14:05:18 +08:00
" $ ref ": " #/definitions/EditIssueOption"
2017-05-02 21:35:59 +08:00
}
}
],
"responses": {
"201": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Issue"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"404": {
" $ ref ": " #/responses/notFound"
},
"412": {
" $ ref ": " #/responses/error"
2017-05-02 21:35:59 +08:00
}
}
}
},
2018-05-08 14:05:18 +08:00
"/repos/{owner}/{repo}/issues/{index}/comments": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
2017-08-21 19:13:47 +08:00
],
2018-05-08 14:05:18 +08:00
"summary": "List all comments on an issue",
"operationId": "issueGetComments",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2018-05-08 14:05:18 +08:00
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "index of the issue",
2018-06-12 22:59:22 +08:00
"name": "index",
2018-05-08 14:05:18 +08:00
"in": "path",
"required": true
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
2020-01-14 00:02:24 +08:00
"format": "date-time",
2018-05-08 14:05:18 +08:00
"description": "if provided, only comments updated since the specified time are returned.",
2018-07-12 21:40:41 +08:00
"name": "since",
2017-11-13 15:02:25 +08:00
"in": "query"
2020-01-14 00:02:24 +08:00
},
{
"type": "string",
"format": "date-time",
"description": "if provided, only comments updated before the provided time are returned.",
"name": "before",
"in": "query"
2017-05-02 21:35:59 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
2017-11-13 15:02:25 +08:00
"200": {
" $ ref ": " #/responses/CommentList"
2017-05-02 21:35:59 +08:00
}
}
2018-05-08 14:05:18 +08:00
},
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "index of the issue",
2018-06-12 22:59:22 +08:00
"name": "index",
2018-05-08 14:05:18 +08:00
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
2018-06-15 15:47:13 +08:00
" $ ref ": " #/definitions/CreateIssueCommentOption"
2018-05-08 14:05:18 +08:00
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Comment"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2018-05-08 14:05:18 +08:00
}
}
2017-05-02 21:35:59 +08:00
}
},
2018-05-08 14:05:18 +08:00
"/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
2017-11-20 15:24:07 +08:00
"delete": {
"tags": [
"issue"
],
"summary": "Delete a comment",
2018-05-08 14:05:18 +08:00
"operationId": "issueDeleteCommentDeprecated",
"deprecated": true,
2017-11-20 15:24:07 +08:00
"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
},
2018-05-08 14:05:18 +08:00
{
"type": "integer",
"description": "this parameter is ignored",
"name": "index",
"in": "path",
"required": true
},
2017-11-20 15:24:07 +08:00
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-20 15:24:07 +08:00
"description": "id of comment to delete",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2020-01-08 15:00:59 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2017-11-20 15:24:07 +08:00
}
}
},
"patch": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Edit a comment",
2018-05-08 14:05:18 +08:00
"operationId": "issueEditCommentDeprecated",
"deprecated": true,
2017-11-20 15:24:07 +08:00
"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
},
2018-05-08 14:05:18 +08:00
{
"type": "integer",
"description": "this parameter is ignored",
"name": "index",
"in": "path",
"required": true
},
2017-11-20 15:24:07 +08:00
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-20 15:24:07 +08:00
"description": "id of the comment to edit",
"name": "id",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditIssueCommentOption"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Comment"
2019-12-21 01:07:12 +08:00
},
"204": {
" $ ref ": " #/responses/empty"
},
"403": {
" $ ref ": " #/responses/forbidden"
2020-01-08 15:00:59 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2017-11-20 15:24:07 +08:00
}
}
}
},
2018-07-16 20:43:00 +08:00
"/repos/{owner}/{repo}/issues/{index}/deadline": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
2019-01-02 01:56:47 +08:00
"summary": "Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.",
2018-07-16 20:43:00 +08:00
"operationId": "issueEditIssueDeadline",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-07-16 20:43:00 +08:00
"description": "index of the issue to create or update a deadline on",
"name": "index",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditDeadlineOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/IssueDeadline"
},
"403": {
2019-12-21 01:07:12 +08:00
" $ ref ": " #/responses/forbidden"
2018-07-16 20:43:00 +08:00
},
"404": {
2019-12-21 01:07:12 +08:00
" $ ref ": " #/responses/notFound"
2018-07-16 20:43:00 +08:00
}
}
}
},
2018-05-08 14:05:18 +08:00
"/repos/{owner}/{repo}/issues/{index}/labels": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
],
2018-05-08 14:05:18 +08:00
"summary": "Get an issue's labels",
"operationId": "issueGetLabels",
2017-11-13 15:02:25 +08:00
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "index of the issue",
2018-01-04 14:31:40 +08:00
"name": "index",
2017-11-13 15:02:25 +08:00
"in": "path",
"required": true
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2018-05-08 14:05:18 +08:00
" $ ref ": " #/responses/LabelList"
},
"404": {
" $ ref ": " #/responses/notFound"
2017-05-02 21:35:59 +08:00
}
}
2017-08-21 19:13:47 +08:00
},
2018-05-08 14:05:18 +08:00
"put": {
2017-08-21 19:13:47 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
2017-08-21 19:13:47 +08:00
],
2018-05-08 14:05:18 +08:00
"summary": "Replace an issue's labels",
"operationId": "issueReplaceLabels",
2017-08-21 19:13:47 +08:00
"parameters": [
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "index of the issue",
2018-01-04 14:31:40 +08:00
"name": "index",
2017-11-13 15:02:25 +08:00
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-08-21 19:13:47 +08:00
"in": "body",
"schema": {
2018-05-08 14:05:18 +08:00
" $ ref ": " #/definitions/IssueLabelsOption"
2017-08-21 19:13:47 +08:00
}
2017-11-13 15:02:25 +08:00
}
],
"responses": {
2018-05-08 14:05:18 +08:00
"200": {
" $ ref ": " #/responses/LabelList"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-11-13 15:02:25 +08:00
}
}
2018-05-08 14:05:18 +08:00
},
2017-11-13 15:02:25 +08:00
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
2018-05-08 14:05:18 +08:00
"summary": "Add a label to an issue",
"operationId": "issueAddLabel",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "index of the issue",
2018-05-08 14:05:18 +08:00
"name": "index",
2017-11-13 15:02:25 +08:00
"in": "path",
"required": true
2017-08-21 19:13:47 +08:00
},
{
2017-11-13 15:02:25 +08:00
"name": "body",
2017-08-21 19:13:47 +08:00
"in": "body",
"schema": {
2018-05-08 14:05:18 +08:00
" $ ref ": " #/definitions/IssueLabelsOption"
2017-08-21 19:13:47 +08:00
}
}
],
"responses": {
2018-05-08 14:05:18 +08:00
"200": {
" $ ref ": " #/responses/LabelList"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-08-21 19:13:47 +08:00
}
}
2018-05-08 14:05:18 +08:00
},
2017-11-20 15:24:07 +08:00
"delete": {
2018-05-08 14:05:18 +08:00
"produces": [
"application/json"
],
2017-11-20 15:24:07 +08:00
"tags": [
"issue"
],
2018-05-08 14:05:18 +08:00
"summary": "Remove all labels from an issue",
"operationId": "issueClearLabels",
2017-11-20 15:24:07 +08:00
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "index of the issue",
2017-11-20 15:24:07 +08:00
"name": "index",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-11-20 15:24:07 +08:00
}
}
2018-05-08 14:05:18 +08:00
}
},
"/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
"delete": {
2017-11-20 15:24:07 +08:00
"produces": [
"application/json"
],
"tags": [
"issue"
],
2018-05-08 14:05:18 +08:00
"summary": "Remove a label from an issue",
"operationId": "issueRemoveLabel",
2017-11-20 15:24:07 +08:00
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "index of the issue",
2017-11-20 15:24:07 +08:00
"name": "index",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-05-08 14:05:18 +08:00
"description": "id of the label to remove",
2017-11-20 15:24:07 +08:00
"name": "id",
"in": "path",
"required": true
2017-11-13 15:02:25 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
2018-05-08 14:05:18 +08:00
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"422": {
" $ ref ": " #/responses/validationError"
2017-05-02 21:35:59 +08:00
}
}
}
},
2019-12-08 06:04:19 +08:00
"/repos/{owner}/{repo}/issues/{index}/reactions": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
2020-01-06 12:58:13 +08:00
"summary": "Get a list reactions of an issue",
2019-12-08 06:04:19 +08:00
"operationId": "issueGetIssueReactions",
"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",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
}
],
"responses": {
"200": {
2019-12-31 16:21:21 +08:00
" $ ref ": " #/responses/ReactionList"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2019-12-08 06:04:19 +08:00
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
2020-01-06 12:58:13 +08:00
"summary": "Add a reaction to an issue",
2019-12-08 06:04:19 +08:00
"operationId": "issuePostIssueReaction",
"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",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
},
{
"name": "content",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditReactionOption"
}
}
],
"responses": {
2019-12-31 16:21:21 +08:00
"200": {
" $ ref ": " #/responses/Reaction"
},
2019-12-08 06:04:19 +08:00
"201": {
2019-12-31 16:21:21 +08:00
" $ ref ": " #/responses/Reaction"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2019-12-08 06:04:19 +08:00
}
}
},
"delete": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
2020-01-06 12:58:13 +08:00
"summary": "Remove a reaction from an issue",
2019-12-08 06:04:19 +08:00
"operationId": "issueDeleteIssueReaction",
"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",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
},
{
"name": "content",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditReactionOption"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2019-12-08 06:04:19 +08:00
}
}
}
},
2019-12-12 12:23:05 +08:00
"/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
"delete": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Delete an issue's existing stopwatch.",
"operationId": "issueDeleteStopWatch",
"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",
"format": "int64",
"description": "index of the issue to stop the stopwatch on",
"name": "index",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"403": {
"description": "Not repo writer, user does not have rights to toggle stopwatch"
},
"404": {
2019-12-21 01:07:12 +08:00
" $ ref ": " #/responses/notFound"
2019-12-12 12:23:05 +08:00
},
"409": {
"description": "Cannot cancel a non existent stopwatch"
}
}
}
},
2019-02-07 10:57:25 +08:00
"/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Start stopwatch on an issue.",
"operationId": "issueStartStopWatch",
"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",
"format": "int64",
"description": "index of the issue to create the stopwatch on",
"name": "index",
"in": "path",
"required": true
}
],
"responses": {
"201": {
" $ ref ": " #/responses/empty"
},
"403": {
"description": "Not repo writer, user does not have rights to toggle stopwatch"
},
"404": {
2019-12-21 01:07:12 +08:00
" $ ref ": " #/responses/notFound"
2019-02-07 10:57:25 +08:00
},
"409": {
"description": "Cannot start a stopwatch again if it already exists"
}
}
}
},
"/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Stop an issue's existing stopwatch.",
2019-12-12 12:23:05 +08:00
"operationId": "issueStopStopWatch",
2019-02-07 10:57:25 +08:00
"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",
"format": "int64",
"description": "index of the issue to stop the stopwatch on",
"name": "index",
"in": "path",
"required": true
}
],
"responses": {
"201": {
" $ ref ": " #/responses/empty"
},
"403": {
"description": "Not repo writer, user does not have rights to toggle stopwatch"
},
"404": {
2019-12-21 01:07:12 +08:00
" $ ref ": " #/responses/notFound"
2019-02-07 10:57:25 +08:00
},
"409": {
"description": "Cannot stop a non existent stopwatch"
}
}
}
},
2019-11-02 23:27:49 +08:00
"/repos/{owner}/{repo}/issues/{index}/subscriptions": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Get users who subscribed on an issue.",
"operationId": "issueSubscriptions",
"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",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
}
],
"responses": {
2019-11-20 22:50:54 +08:00
"200": {
" $ ref ": " #/responses/UserList"
2019-11-02 23:27:49 +08:00
},
"404": {
2019-12-21 01:07:12 +08:00
" $ ref ": " #/responses/notFound"
2019-11-02 23:27:49 +08:00
}
}
}
},
"/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Subscribe user to issue",
"operationId": "issueAddSubscription",
"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",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
},
{
"type": "string",
"description": "user to subscribe",
"name": "user",
"in": "path",
"required": true
}
],
"responses": {
"201": {
" $ ref ": " #/responses/empty"
},
"304": {
"description": "User can only subscribe itself if he is no admin"
},
"404": {
2019-12-21 01:07:12 +08:00
" $ ref ": " #/responses/notFound"
2019-11-02 23:27:49 +08:00
}
}
},
"delete": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Unsubscribe user from issue",
"operationId": "issueDeleteSubscription",
"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",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
},
{
"type": "string",
"description": "user witch unsubscribe",
"name": "user",
"in": "path",
"required": true
}
],
"responses": {
"201": {
" $ ref ": " #/responses/empty"
},
"304": {
"description": "User can only subscribe itself if he is no admin"
},
"404": {
2019-12-21 01:07:12 +08:00
" $ ref ": " #/responses/notFound"
2019-11-02 23:27:49 +08:00
}
}
}
},
2019-12-28 04:30:58 +08:00
"/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",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
2020-01-09 05:14:00 +08:00
},
{
"type": "string",
"format": "date-time",
"description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
"name": "since",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
"name": "before",
"in": "query"
2019-12-28 04:30:58 +08:00
}
],
"responses": {
"200": {
" $ ref ": " #/responses/TrackedTimeList"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Add 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",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/AddTimeOption"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/TrackedTime"
},
"400": {
" $ ref ": " #/responses/error"
},
"403": {
" $ ref ": " #/responses/forbidden"
}
}
},
"delete": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Reset a tracked time of an issue",
"operationId": "issueResetTime",
"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",
"format": "int64",
"description": "index of the issue to add tracked time to",
"name": "index",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"400": {
" $ ref ": " #/responses/error"
},
"403": {
2020-01-09 05:14:00 +08:00
" $ ref ": " #/responses/forbidden"
2019-12-28 04:30:58 +08:00
}
}
}
},
"/repos/{owner}/{repo}/issues/{index}/times/{id}": {
"delete": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Delete specific tracked time",
"operationId": "issueDeleteTime",
"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",
"format": "int64",
"description": "index of the issue",
"name": "index",
"in": "path",
"required": true
},
{
"type": "integer",
"format": "int64",
"description": "id of time to delete",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"400": {
" $ ref ": " #/responses/error"
},
"403": {
2020-01-09 05:14:00 +08:00
" $ ref ": " #/responses/forbidden"
2019-12-28 04:30:58 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/keys": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"repository"
],
"summary": "List a repository's keys",
"operationId": "repoListKeys",
"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
2018-11-01 11:40:49 +08:00
},
{
"type": "integer",
"description": "the key_id to search for",
"name": "key_id",
"in": "query"
},
{
"type": "string",
"description": "fingerprint of the key",
"name": "fingerprint",
"in": "query"
2017-11-13 15:02:25 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/DeployKeyList"
2017-09-12 14:48:13 +08:00
}
}
2017-11-13 15:02:25 +08:00
},
"post": {
"consumes": [
"application/json"
],
2017-09-12 14:48:13 +08:00
"produces": [
"application/json"
],
"tags": [
2017-11-13 15:02:25 +08:00
"repository"
2017-09-12 14:48:13 +08:00
],
2017-11-13 15:02:25 +08:00
"summary": "Add a key to a repository",
"operationId": "repoCreateKey",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-09-12 14:48:13 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateKeyOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/DeployKey"
2019-12-21 01:07:12 +08:00
},
"422": {
" $ ref ": " #/responses/validationError"
2017-05-02 21:35:59 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/keys/{id}": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"repository"
],
"summary": "Get a repository's key by id",
"operationId": "repoGetKey",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the key to get",
"name": "id",
"in": "path",
"required": true
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/DeployKey"
}
}
},
"delete": {
"tags": [
"repository"
],
"summary": "Delete a key from a repository",
"operationId": "repoDeleteKey",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the key to delete",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-05-02 21:35:59 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/labels": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
],
"summary": "Get all of a repository's labels",
"operationId": "issueListLabels",
"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
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/LabelList"
2017-05-02 21:35:59 +08:00
}
}
2017-11-13 15:02:25 +08:00
},
"post": {
"consumes": [
"application/json"
],
2017-05-02 21:35:59 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
2017-08-21 19:13:47 +08:00
],
2017-11-13 15:02:25 +08:00
"summary": "Create a label",
"operationId": "issueCreateLabel",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateLabelOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Label"
2017-05-02 21:35:59 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/labels/{id}": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
],
"summary": "Get a single label",
"operationId": "issueGetLabel",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the label to get",
"name": "id",
"in": "path",
"required": true
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Label"
2017-05-02 21:35:59 +08:00
}
}
2017-11-13 15:02:25 +08:00
},
"delete": {
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
],
"summary": "Delete a label",
"operationId": "issueDeleteLabel",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the label to delete",
"name": "id",
"in": "path",
"required": true
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
2017-11-13 15:02:25 +08:00
},
"patch": {
"consumes": [
"application/json"
],
2017-05-02 21:35:59 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
2017-08-21 19:13:47 +08:00
],
2017-11-13 15:02:25 +08:00
"summary": "Update a label",
"operationId": "issueEditLabel",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the label to edit",
"name": "id",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditLabelOption"
}
2017-05-02 21:35:59 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Label"
2017-05-02 21:35:59 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/milestones": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
],
2018-11-26 16:45:42 +08:00
"summary": "Get all of a repository's opened milestones",
2018-06-12 22:59:22 +08:00
"operationId": "issueGetMilestonesList",
2017-11-13 15:02:25 +08:00
"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
2019-06-06 08:37:45 +08:00
},
{
"type": "string",
"description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
"name": "state",
"in": "query"
2017-11-13 15:02:25 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/MilestoneList"
2017-05-02 21:35:59 +08:00
}
}
2017-11-13 15:02:25 +08:00
},
"post": {
"consumes": [
"application/json"
],
2017-05-02 21:35:59 +08:00
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"issue"
2017-08-21 19:13:47 +08:00
],
2017-11-13 15:02:25 +08:00
"summary": "Create a milestone",
"operationId": "issueCreateMilestone",
"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
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateMilestoneOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Milestone"
}
}
}
},
"/repos/{owner}/{repo}/milestones/{id}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Get a milestone",
"operationId": "issueGetMilestone",
2018-06-12 22:59:22 +08:00
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-06-12 22:59:22 +08:00
"description": "id of the milestone",
"name": "id",
"in": "path",
"required": true
}
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/Milestone"
}
}
},
"delete": {
"tags": [
"issue"
],
"summary": "Delete a milestone",
"operationId": "issueDeleteMilestone",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the milestone to delete",
2018-06-12 22:59:22 +08:00
"name": "id",
2017-11-13 15:02:25 +08:00
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
},
"patch": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"issue"
],
"summary": "Update a milestone",
"operationId": "issueEditMilestone",
"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
},
2018-06-12 22:59:22 +08:00
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-06-12 22:59:22 +08:00
"description": "id of the milestone",
"name": "id",
"in": "path",
"required": true
},
2017-11-13 15:02:25 +08:00
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditMilestoneOption"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Milestone"
2017-05-02 21:35:59 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/mirror-sync": {
"post": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Sync a mirrored repository",
"operationId": "repoMirrorSync",
"parameters": [
{
"type": "string",
"description": "owner of the repo to sync",
"name": "owner",
"in": "path",
"required": true
},
{
"type": "string",
"description": "name of the repo to sync",
"name": "repo",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-11-13 15:02:25 +08:00
}
}
}
},
2020-01-09 19:56:32 +08:00
"/repos/{owner}/{repo}/notifications": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"notification"
],
"summary": "List users's notification threads on a specific repo",
"operationId": "notifyGetRepoList",
"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": "string",
"description": "If true, show notifications marked as read. Default value is false",
"name": "all",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
"name": "since",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
"name": "before",
"in": "query"
}
],
"responses": {
"200": {
" $ ref ": " #/responses/NotificationThreadList"
}
}
},
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"notification"
],
"summary": "Mark notification threads as read on a specific repo",
"operationId": "notifyReadRepoList",
"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": "string",
"format": "date-time",
"description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
"name": "last_read_at",
"in": "query"
}
],
"responses": {
"205": {
" $ ref ": " #/responses/empty"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/pulls": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"repository"
],
"summary": "List a repo's pull requests",
"operationId": "repoListPullRequests",
"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
2018-10-21 11:40:42 +08:00
},
{
"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"
2017-11-13 15:02:25 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/PullRequestList"
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Create a pull request",
"operationId": "repoCreatePullRequest",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreatePullRequestOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/PullRequest"
2019-12-21 01:07:12 +08:00
},
"409": {
" $ ref ": " #/responses/error"
},
"422": {
" $ ref ": " #/responses/validationError"
2017-05-02 21:35:59 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/pulls/{index}": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"repository"
],
"summary": "Get a pull request",
"operationId": "repoGetPullRequest",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "index of the pull request to get",
"name": "index",
"in": "path",
"required": true
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/PullRequest"
2020-01-09 19:56:32 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2017-11-13 15:02:25 +08:00
}
}
},
"patch": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
2019-11-03 22:46:32 +08:00
"summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
2017-11-13 15:02:25 +08:00
"operationId": "repoEditPullRequest",
"parameters": [
{
"type": "string",
"description": "owner of the repo",
"name": "owner",
"in": "path",
"required": true
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
{
"type": "string",
"description": "name of the repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "index of the pull request to edit",
"name": "index",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditPullRequestOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/PullRequest"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
},
"412": {
" $ ref ": " #/responses/error"
},
"422": {
" $ ref ": " #/responses/validationError"
2017-05-02 21:35:59 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/pulls/{index}/merge": {
2017-05-02 21:35:59 +08:00
"get": {
"produces": [
"application/json"
],
2017-08-21 19:13:47 +08:00
"tags": [
2017-11-13 15:02:25 +08:00
"repository"
],
"summary": "Check if a pull request has been merged",
"operationId": "repoPullRequestIsMerged",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "index of the pull request",
"name": "index",
"in": "path",
"required": true
}
],
"responses": {
"204": {
2018-10-21 11:40:42 +08:00
"description": "pull request has been merged"
2017-11-13 15:02:25 +08:00
},
"404": {
2018-10-21 11:40:42 +08:00
"description": "pull request has not been merged"
2017-11-13 15:02:25 +08:00
}
}
},
"post": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Merge a pull request",
"operationId": "repoMergePullRequest",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "index of the pull request to merge",
"name": "index",
"in": "path",
"required": true
2019-02-08 16:08:38 +08:00
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/MergePullRequestOption"
}
2017-11-13 15:02:25 +08:00
}
2017-08-21 19:13:47 +08:00
],
2017-05-02 21:35:59 +08:00
"responses": {
"200": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/responses/empty"
},
"405": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"409": {
" $ ref ": " #/responses/error"
2017-05-02 21:35:59 +08:00
}
}
}
2017-11-13 15:02:25 +08:00
},
"/repos/{owner}/{repo}/raw/{filepath}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get a file from a repository",
"operationId": "repoGetRawFile",
"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": "string",
"description": "filepath of the file to get",
"name": "filepath",
"in": "path",
"required": true
}
],
"responses": {
2018-06-01 13:51:49 +08:00
"200": {
"description": "success"
2019-12-21 01:07:12 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2018-06-01 13:51:49 +08:00
}
2017-11-13 15:02:25 +08:00
}
}
},
"/repos/{owner}/{repo}/releases": {
"get": {
2018-03-06 09:22:16 +08:00
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "List a repo's releases",
"operationId": "repoListReleases",
"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
2019-01-25 15:10:50 +08:00
},
{
"type": "integer",
"description": "page wants to load",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "items count every page wants to load",
"name": "per_page",
"in": "query"
2018-03-06 09:22:16 +08:00
}
],
"responses": {
"200": {
" $ ref ": " #/responses/ReleaseList"
}
}
},
"post": {
2017-11-13 15:02:25 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Create a release",
"operationId": "repoCreateRelease",
"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
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateReleaseOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Release"
2019-12-21 01:07:12 +08:00
},
"409": {
" $ ref ": " #/responses/error"
2017-11-13 15:02:25 +08:00
}
}
}
},
"/repos/{owner}/{repo}/releases/{id}": {
2018-03-06 09:22:16 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get a release",
"operationId": "repoGetRelease",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-03-06 09:22:16 +08:00
"description": "id of the release to get",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Release"
}
}
},
2017-11-13 15:02:25 +08:00
"delete": {
"tags": [
"repository"
],
"summary": "Delete a release",
"operationId": "repoDeleteRelease",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the release to delete",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
},
"patch": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Update a release",
"operationId": "repoEditRelease",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the release to edit",
"name": "id",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditReleaseOption"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Release"
}
}
}
},
2018-03-06 09:22:16 +08:00
"/repos/{owner}/{repo}/releases/{id}/assets": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "List release's attachments",
"operationId": "repoListReleaseAttachments",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-03-06 09:22:16 +08:00
"description": "id of the release",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/AttachmentList"
}
}
},
"post": {
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Create a release attachment",
"operationId": "repoCreateReleaseAttachment",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-03-06 09:22:16 +08:00
"description": "id of the release",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "name of the attachment",
"name": "name",
"in": "query"
},
{
"type": "file",
"description": "attachment to upload",
"name": "attachment",
"in": "formData",
"required": true
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Attachment"
2019-12-21 01:07:12 +08:00
},
"400": {
" $ ref ": " #/responses/error"
2018-03-06 09:22:16 +08:00
}
}
}
},
"/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get a release attachment",
"operationId": "repoGetReleaseAttachment",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-03-06 09:22:16 +08:00
"description": "id of the release",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-03-06 09:22:16 +08:00
"description": "id of the attachment to get",
"name": "attachment_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Attachment"
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Delete a release attachment",
"operationId": "repoDeleteReleaseAttachment",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-03-06 09:22:16 +08:00
"description": "id of the release",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-03-06 09:22:16 +08:00
"description": "id of the attachment to delete",
"name": "attachment_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
},
"patch": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Edit a release attachment",
"operationId": "repoEditReleaseAttachment",
"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",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-03-06 09:22:16 +08:00
"description": "id of the release",
"name": "id",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-03-06 09:22:16 +08:00
"description": "id of the attachment to edit",
"name": "attachment_id",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditAttachmentOptions"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Attachment"
}
}
}
},
2019-10-16 21:42:42 +08:00
"/repos/{owner}/{repo}/signing-key.gpg": {
"get": {
"produces": [
"text/plain"
],
"tags": [
"repository"
],
"summary": "Get signing-key.gpg for given repository",
"operationId": "repoSigningKey",
"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
}
],
"responses": {
"200": {
"description": "GPG armored public key",
"schema": {
"type": "string"
}
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/stargazers": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "List a repo's stargazers",
"operationId": "repoListStargazers",
"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
}
],
"responses": {
"200": {
" $ ref ": " #/responses/UserList"
}
}
}
},
"/repos/{owner}/{repo}/statuses/{sha}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get a commit's statuses",
"operationId": "repoListStatuses",
"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": "string",
"description": "sha of the commit",
"name": "sha",
"in": "path",
"required": true
2019-07-25 18:55:06 +08:00
},
{
"type": "integer",
"description": "page number of results",
"name": "page",
"in": "query"
},
{
"enum": [
"oldest",
"recentupdate",
"leastupdate",
"leastindex",
"highestindex"
],
"type": "string",
"description": "type of sort",
"name": "sort",
"in": "query"
},
{
"enum": [
"pending",
"success",
"error",
"failure",
"warning"
],
"type": "string",
"description": "type of state",
"name": "state",
"in": "query"
2017-11-13 15:02:25 +08:00
}
],
"responses": {
"200": {
" $ ref ": " #/responses/StatusList"
2019-12-21 01:07:12 +08:00
},
"400": {
" $ ref ": " #/responses/error"
2017-11-13 15:02:25 +08:00
}
}
},
"post": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Create a commit status",
"operationId": "repoCreateStatus",
"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": "string",
"description": "sha of the commit",
"name": "sha",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateStatusOption"
}
}
],
"responses": {
2019-12-20 05:46:53 +08:00
"201": {
" $ ref ": " #/responses/Status"
2019-12-21 01:07:12 +08:00
},
"400": {
" $ ref ": " #/responses/error"
2017-11-13 15:02:25 +08:00
}
}
}
},
"/repos/{owner}/{repo}/subscribers": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "List a repo's watchers",
"operationId": "repoListSubscribers",
"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
}
],
"responses": {
"200": {
" $ ref ": " #/responses/UserList"
}
}
}
},
"/repos/{owner}/{repo}/subscription": {
"get": {
"tags": [
"repository"
],
"summary": "Check if the current user is watching a repo",
"operationId": "userCurrentCheckSubscription",
"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
}
],
"responses": {
"200": {
" $ ref ": " #/responses/WatchInfo"
}
}
},
"put": {
"tags": [
"repository"
],
"summary": "Watch a repo",
"operationId": "userCurrentPutSubscription",
"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
}
],
"responses": {
"200": {
" $ ref ": " #/responses/WatchInfo"
}
}
},
"delete": {
"tags": [
"repository"
],
"summary": "Unwatch a repo",
"operationId": "userCurrentDeleteSubscription",
"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
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
}
},
2019-02-07 20:00:52 +08:00
"/repos/{owner}/{repo}/tags": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "List a repository's tags",
"operationId": "repoListTags",
"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
}
],
"responses": {
"200": {
" $ ref ": " #/responses/TagList"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repos/{owner}/{repo}/times": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "List a repo's tracked times",
"operationId": "repoTrackedTimes",
"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
2020-01-09 05:14:00 +08:00
},
{
"type": "string",
"description": "optional filter by user",
"name": "user",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
"name": "since",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
"name": "before",
"in": "query"
2017-11-13 15:02:25 +08:00
}
],
"responses": {
"200": {
" $ ref ": " #/responses/TrackedTimeList"
2019-12-21 01:07:12 +08:00
},
"400": {
" $ ref ": " #/responses/error"
2020-01-09 05:14:00 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-11-13 15:02:25 +08:00
}
}
}
},
2018-06-12 22:59:22 +08:00
"/repos/{owner}/{repo}/times/{user}": {
2017-11-13 15:02:25 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
2020-01-09 05:14:00 +08:00
"repository"
2017-11-13 15:02:25 +08:00
],
"summary": "List a user's tracked times in a repo",
"operationId": "userTrackedTimes",
2020-01-09 05:14:00 +08:00
"deprecated": true,
2017-11-13 15:02:25 +08:00
"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": "string",
"description": "username of user",
"name": "user",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/TrackedTimeList"
2019-12-21 01:07:12 +08:00
},
"400": {
" $ ref ": " #/responses/error"
2020-01-09 05:14:00 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-11-13 15:02:25 +08:00
}
}
}
},
2019-09-03 23:46:24 +08:00
"/repos/{owner}/{repo}/topics": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get list of topics that a repository has",
"operationId": "repoListTopics",
"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
}
],
"responses": {
"200": {
" $ ref ": " #/responses/TopicNames"
}
}
},
"put": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Replace list of topics for a repository",
"operationId": "repoUpdateTopics",
"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
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/RepoTopicOptions"
}
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"422": {
" $ ref ": " #/responses/invalidTopicsError"
2019-09-03 23:46:24 +08:00
}
}
}
},
"/repos/{owner}/{repo}/topics/{topic}": {
"put": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Add a topic to a repository",
"operationId": "repoAddTopíc",
"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": "string",
"description": "name of the topic to add",
"name": "topic",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"422": {
" $ ref ": " #/responses/invalidTopicsError"
2019-09-03 23:46:24 +08:00
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Delete a topic from a repository",
"operationId": "repoDeleteTopic",
"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": "string",
"description": "name of the topic to delete",
"name": "topic",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"422": {
" $ ref ": " #/responses/invalidTopicsError"
2019-09-03 23:46:24 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/repositories/{id}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "Get a repository by id",
"operationId": "repoGetByID",
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the repo to get",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Repository"
}
}
}
},
2019-10-16 21:42:42 +08:00
"/signing-key.gpg": {
"get": {
"produces": [
"text/plain"
],
"tags": [
"miscellaneous"
],
"summary": "Get default signing-key.gpg",
"operationId": "getSigningKey",
"responses": {
"200": {
"description": "GPG armored public key",
"schema": {
"type": "string"
}
}
}
}
},
2017-11-13 15:02:25 +08:00
"/teams/{id}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Get a team",
"operationId": "orgGetTeam",
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the team to get",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Team"
}
}
},
"delete": {
"tags": [
"organization"
],
"summary": "Delete a team",
"operationId": "orgDeleteTeam",
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the team to delete",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
2018-10-21 11:40:42 +08:00
"description": "team deleted"
2017-11-13 15:02:25 +08:00
}
}
},
"patch": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Edit a team",
"operationId": "orgEditTeam",
"parameters": [
{
"type": "integer",
"description": "id of the team to edit",
"name": "id",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/EditTeamOption"
}
}
],
"responses": {
"200": {
" $ ref ": " #/responses/Team"
}
}
}
},
"/teams/{id}/members": {
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "List a team's members",
"operationId": "orgListTeamMembers",
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the team",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/UserList"
}
}
}
},
"/teams/{id}/members/{username}": {
2019-01-17 08:39:50 +08:00
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "List a particular member of team",
"operationId": "orgListTeamMember",
"parameters": [
{
"type": "integer",
"format": "int64",
"description": "id of the team",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of the member to list",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/User"
2019-12-21 01:07:12 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2019-01-17 08:39:50 +08:00
}
}
},
2017-11-13 15:02:25 +08:00
"put": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Add a team member",
"operationId": "orgAddTeamMember",
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the team",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of the user to add",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2017-11-13 15:02:25 +08:00
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Remove a team member",
2018-06-12 22:59:22 +08:00
"operationId": "orgRemoveTeamMember",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the team",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of the user to remove",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2017-11-13 15:02:25 +08:00
}
}
}
},
"/teams/{id}/repos": {
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "List a team's repos",
"operationId": "orgListTeamRepos",
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the team",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/RepositoryList"
}
}
}
},
"/teams/{id}/repos/{org}/{repo}": {
"put": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Add a repository to a team",
2018-06-12 22:59:22 +08:00
"operationId": "orgAddTeamRepository",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the team",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "organization that owns the repo to add",
"name": "org",
"in": "path",
"required": true
},
{
"type": "string",
"description": "name of the repo to add",
"name": "repo",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-11-13 15:02:25 +08:00
}
}
},
"delete": {
"description": "This does not delete the repository, it only removes the repository from the team.",
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "Remove a repository from a team",
2018-06-12 22:59:22 +08:00
"operationId": "orgRemoveTeamRepository",
2017-11-13 15:02:25 +08:00
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of the team",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "organization that owns the repo to remove",
"name": "org",
"in": "path",
"required": true
},
{
"type": "string",
"description": "name of the repo to remove",
"name": "repo",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-11-13 15:02:25 +08:00
}
}
}
},
2018-04-20 17:13:50 +08:00
"/topics/search": {
"get": {
"produces": [
"application/json"
],
"tags": [
"repository"
],
"summary": "search topics via keyword",
"operationId": "topicSearch",
"parameters": [
{
2018-06-12 22:59:22 +08:00
"type": "string",
"description": "keywords to search",
"name": "q",
"in": "query",
2018-04-20 17:13:50 +08:00
"required": true
}
],
"responses": {
"200": {
2019-09-03 23:46:24 +08:00
" $ ref ": " #/responses/TopicListResponse"
2019-12-21 01:07:12 +08:00
},
"403": {
" $ ref ": " #/responses/forbidden"
2018-04-20 17:13:50 +08:00
}
}
}
},
2017-11-13 15:02:25 +08:00
"/user": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get the authenticated user",
"operationId": "userGetCurrent",
"responses": {
"200": {
" $ ref ": " #/responses/User"
}
}
}
},
"/user/emails": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the authenticated user's email addresses",
"operationId": "userListEmails",
"responses": {
"200": {
" $ ref ": " #/responses/EmailList"
}
}
},
"post": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Add email addresses",
"operationId": "userAddEmail",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateEmailOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/EmailList"
2019-12-21 01:07:12 +08:00
},
"422": {
" $ ref ": " #/responses/validationError"
2017-11-13 15:02:25 +08:00
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Delete email addresses",
"operationId": "userDeleteEmail",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/DeleteEmailOption"
}
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
}
},
"/user/followers": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the authenticated user's followers",
"operationId": "userCurrentListFollowers",
"responses": {
"200": {
" $ ref ": " #/responses/UserList"
}
}
}
},
"/user/following": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the users that the authenticated user is following",
"operationId": "userCurrentListFollowing",
"responses": {
"200": {
" $ ref ": " #/responses/UserList"
}
}
}
},
2018-06-12 22:59:22 +08:00
"/user/following/{username}": {
2017-11-13 15:02:25 +08:00
"get": {
"tags": [
"user"
],
"summary": "Check whether a user is followed by the authenticated user",
"operationId": "userCurrentCheckFollowing",
"parameters": [
{
"type": "string",
"description": "username of followed user",
2018-06-12 22:59:22 +08:00
"name": "username",
2017-11-13 15:02:25 +08:00
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
2018-06-12 22:59:22 +08:00
},
2017-11-13 15:02:25 +08:00
"put": {
"tags": [
"user"
],
"summary": "Follow a user",
"operationId": "userCurrentPutFollow",
"parameters": [
{
"type": "string",
"description": "username of user to follow",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
},
"delete": {
"tags": [
"user"
],
"summary": "Unfollow a user",
"operationId": "userCurrentDeleteFollow",
"parameters": [
{
"type": "string",
"description": "username of user to unfollow",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
}
},
"/user/gpg_keys": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the authenticated user's GPG keys",
"operationId": "userCurrentListGPGKeys",
"responses": {
"200": {
" $ ref ": " #/responses/GPGKeyList"
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Create a GPG key",
"operationId": "userCurrentPostGPGKey",
"parameters": [
{
"name": "Form",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateGPGKeyOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/GPGKey"
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
"/user/gpg_keys/{id}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get a GPG key",
"operationId": "userCurrentGetGPGKey",
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of key to get",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/GPGKey"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Remove a GPG key",
"operationId": "userCurrentDeleteGPGKey",
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of key to delete",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"403": {
" $ ref ": " #/responses/forbidden"
}
}
}
},
"/user/keys": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the authenticated user's public keys",
"operationId": "userCurrentListKeys",
2018-11-01 11:40:49 +08:00
"parameters": [
{
"type": "string",
"description": "fingerprint of the key",
"name": "fingerprint",
"in": "query"
}
],
2017-11-13 15:02:25 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/PublicKeyList"
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Create a public key",
"operationId": "userCurrentPostKey",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateKeyOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/PublicKey"
},
"422": {
" $ ref ": " #/responses/validationError"
}
}
}
},
"/user/keys/{id}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get a public key",
"operationId": "userCurrentGetKey",
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of key to get",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/PublicKey"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
},
"delete": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Delete a public key",
"operationId": "userCurrentDeleteKey",
"parameters": [
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2017-11-13 15:02:25 +08:00
"description": "id of key to delete",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"403": {
" $ ref ": " #/responses/forbidden"
2017-12-06 18:27:10 +08:00
},
"404": {
" $ ref ": " #/responses/notFound"
2017-11-13 15:02:25 +08:00
}
}
}
},
"/user/orgs": {
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "List the current user's organizations",
"operationId": "orgListCurrentUserOrgs",
"responses": {
"200": {
" $ ref ": " #/responses/OrganizationList"
}
}
}
},
"/user/repos": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the repos that the authenticated user owns or has access to",
"operationId": "userCurrentListRepos",
"responses": {
"200": {
" $ ref ": " #/responses/RepositoryList"
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"repository",
"user"
],
"summary": "Create a repository",
"operationId": "createCurrentUserRepo",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
" $ ref ": " #/definitions/CreateRepoOption"
}
}
],
"responses": {
"201": {
" $ ref ": " #/responses/Repository"
2019-05-30 23:09:05 +08:00
},
"409": {
"description": "The repository with the same name already exists."
},
"422": {
" $ ref ": " #/responses/validationError"
2017-11-13 15:02:25 +08:00
}
}
}
},
"/user/starred": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "The repos that the authenticated user has starred",
"operationId": "userCurrentListStarred",
"responses": {
"200": {
" $ ref ": " #/responses/RepositoryList"
}
}
}
},
"/user/starred/{owner}/{repo}": {
"get": {
"tags": [
"user"
],
"summary": "Whether the authenticated is starring the repo",
"operationId": "userCurrentCheckStarring",
"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
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
},
"put": {
"tags": [
"user"
],
"summary": "Star the given repo",
"operationId": "userCurrentPutStar",
"parameters": [
{
"type": "string",
"description": "owner of the repo to star",
"name": "owner",
"in": "path",
"required": true
},
{
"type": "string",
"description": "name of the repo to star",
"name": "repo",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
},
"delete": {
"tags": [
"user"
],
"summary": "Unstar the given repo",
"operationId": "userCurrentDeleteStar",
"parameters": [
{
"type": "string",
"description": "owner of the repo to unstar",
"name": "owner",
"in": "path",
"required": true
},
{
"type": "string",
"description": "name of the repo to unstar",
"name": "repo",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
}
},
2019-12-12 12:23:05 +08:00
"/user/stopwatches": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get list of all existing stopwatches",
"operationId": "userGetStopWatches",
"responses": {
"200": {
" $ ref ": " #/responses/StopWatchList"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/user/subscriptions": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List repositories watched by the authenticated user",
"operationId": "userCurrentListSubscriptions",
"responses": {
"200": {
" $ ref ": " #/responses/RepositoryList"
}
}
}
},
2019-01-17 08:39:50 +08:00
"/user/teams": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List all the teams a user belongs to",
"operationId": "userListTeams",
"responses": {
"200": {
" $ ref ": " #/responses/TeamList"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/user/times": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the current user's tracked times",
"operationId": "userCurrentTrackedTimes",
2020-01-09 05:14:00 +08:00
"parameters": [
{
"type": "string",
"format": "date-time",
"description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
"name": "since",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
"name": "before",
"in": "query"
}
],
2017-11-13 15:02:25 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/TrackedTimeList"
}
}
}
},
"/users/search": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Search for users",
"operationId": "userSearch",
"parameters": [
{
"type": "string",
"description": "keyword",
"name": "q",
"in": "query"
},
2018-10-18 16:44:51 +08:00
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-10-18 16:44:51 +08:00
"description": "ID of the user to search for",
"name": "uid",
"in": "query"
},
2017-11-13 15:02:25 +08:00
{
"type": "integer",
"description": "maximum number of users to return",
"name": "limit",
"in": "query"
}
],
"responses": {
"200": {
2018-09-21 16:56:26 +08:00
"description": "SearchResults of a successful search",
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
" $ ref ": " #/definitions/User"
}
},
"ok": {
"type": "boolean"
}
}
}
2017-11-13 15:02:25 +08:00
}
}
}
},
"/users/{follower}/following/{followee}": {
"get": {
"tags": [
"user"
],
"summary": "Check if one user is following another user",
"operationId": "userCheckFollowing",
"parameters": [
{
"type": "string",
"description": "username of following user",
"name": "follower",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of followed user",
"name": "followee",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
}
},
"/users/{username}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get a user",
"operationId": "userGet",
"parameters": [
{
"type": "string",
"description": "username of user to get",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/User"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
}
},
"/users/{username}/followers": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the given user's followers",
"operationId": "userListFollowers",
"parameters": [
{
"type": "string",
"description": "username of user",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/UserList"
}
}
}
},
"/users/{username}/following": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the users that the given user is following",
"operationId": "userListFollowing",
"parameters": [
{
"type": "string",
"description": "username of user",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/UserList"
}
}
}
},
"/users/{username}/gpg_keys": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the given user's GPG keys",
"operationId": "userListGPGKeys",
"parameters": [
{
"type": "string",
"description": "username of user",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/GPGKeyList"
}
}
}
},
2018-10-23 10:57:42 +08:00
"/users/{username}/heatmap": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get a user's heatmap",
"operationId": "userGetHeatmapData",
"parameters": [
{
"type": "string",
"description": "username of user to get",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/UserHeatmapData"
},
"404": {
" $ ref ": " #/responses/notFound"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/users/{username}/keys": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the given user's public keys",
"operationId": "userListKeys",
"parameters": [
{
"type": "string",
"description": "username of user",
"name": "username",
"in": "path",
"required": true
2018-11-01 11:40:49 +08:00
},
{
"type": "string",
"description": "fingerprint of the key",
"name": "fingerprint",
"in": "query"
2017-11-13 15:02:25 +08:00
}
],
"responses": {
"200": {
" $ ref ": " #/responses/PublicKeyList"
}
}
}
},
2018-12-27 03:13:49 +08:00
"/users/{username}/orgs": {
"get": {
"produces": [
"application/json"
],
"tags": [
"organization"
],
"summary": "List a user's organizations",
"operationId": "orgListUserOrgs",
"parameters": [
{
"type": "string",
"description": "username of user",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/OrganizationList"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/users/{username}/repos": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the repos owned by the given user",
"operationId": "userListRepos",
"parameters": [
{
"type": "string",
"description": "username of user",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/RepositoryList"
}
}
}
},
"/users/{username}/starred": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "The repos that the given user has starred",
"operationId": "userListStarred",
"parameters": [
{
"type": "string",
"description": "username of user",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"200": {
" $ ref ": " #/responses/RepositoryList"
}
}
}
},
"/users/{username}/subscriptions": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the repositories watched by a user",
"operationId": "userListSubscriptions",
"parameters": [
{
"type": "string",
"description": "username of the user",
"name": "username",
2018-06-02 23:20:28 +08:00
"in": "path",
"required": true
2017-11-13 15:02:25 +08:00
}
],
"responses": {
"200": {
" $ ref ": " #/responses/RepositoryList"
}
}
}
},
"/users/{username}/tokens": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List the authenticated user's access tokens",
"operationId": "userGetTokens",
2018-06-12 22:59:22 +08:00
"parameters": [
{
"type": "string",
"description": "username of user",
"name": "username",
"in": "path",
"required": true
}
],
2017-11-13 15:02:25 +08:00
"responses": {
"200": {
" $ ref ": " #/responses/AccessTokenList"
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Create an access token",
"operationId": "userCreateToken",
"parameters": [
{
"type": "string",
"x-go-name": "Name",
2018-06-12 22:59:22 +08:00
"description": "username of user",
"name": "username",
"in": "path",
"required": true
2018-10-21 11:40:42 +08:00
},
{
"name": "accessToken",
"in": "body",
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
}
2017-11-13 15:02:25 +08:00
}
],
"responses": {
"200": {
" $ ref ": " #/responses/AccessToken"
}
}
}
},
2018-07-07 09:54:30 +08:00
"/users/{username}/tokens/{token}": {
"delete": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "delete an access token",
"operationId": "userDeleteAccessToken",
"parameters": [
{
"type": "string",
"description": "username of user",
"name": "username",
"in": "path",
"required": true
},
{
"type": "integer",
2018-10-21 11:40:42 +08:00
"format": "int64",
2018-07-07 09:54:30 +08:00
"description": "token to be deleted",
"name": "token",
"in": "path",
"required": true
}
],
"responses": {
"204": {
" $ ref ": " #/responses/empty"
}
}
}
},
2017-11-13 15:02:25 +08:00
"/version": {
"get": {
"produces": [
"application/json"
],
"tags": [
"miscellaneous"
],
"summary": "Returns the version of the Gitea application",
"operationId": "getVersion",
"responses": {
"200": {
" $ ref ": " #/responses/ServerVersion"
}
}
}
}
},
"definitions": {
2019-08-26 22:09:10 +08:00
"APIError": {
"description": "APIError is an api error with a message",
"type": "object",
"properties": {
"message": {
"type": "string",
"x-go-name": "Message"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2019-08-28 14:55:22 +08:00
"AccessToken": {
"type": "object",
"title": "AccessToken represents an API access token.",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"name": {
"type": "string",
"x-go-name": "Name"
},
"sha1": {
"type": "string",
"x-go-name": "Token"
},
"token_last_eight": {
"type": "string",
"x-go-name": "TokenLastEight"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2017-11-13 15:02:25 +08:00
"AddCollaboratorOption": {
"description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
"type": "object",
"properties": {
"permission": {
"type": "string",
"x-go-name": "Permission"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"AddTimeOption": {
"description": "AddTimeOption options for adding time to an issue",
"type": "object",
"required": [
"time"
],
"properties": {
2019-12-28 04:30:58 +08:00
"created": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
2017-11-13 15:02:25 +08:00
"time": {
"description": "time in seconds",
"type": "integer",
"format": "int64",
"x-go-name": "Time"
2019-12-28 04:30:58 +08:00
},
"user_name": {
"description": "User who spent the time (optional)",
"type": "string",
"x-go-name": "User"
2017-11-13 15:02:25 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-06-08 22:31:11 +08:00
"AnnotatedTag": {
"description": "AnnotatedTag represents an annotated tag",
"type": "object",
"properties": {
"message": {
"type": "string",
"x-go-name": "Message"
},
"object": {
" $ ref ": " #/definitions/AnnotatedTagObject"
},
"sha": {
"type": "string",
"x-go-name": "SHA"
},
"tag": {
"type": "string",
"x-go-name": "Tag"
},
"tagger": {
" $ ref ": " #/definitions/CommitUser"
},
"url": {
"type": "string",
"x-go-name": "URL"
},
"verification": {
" $ ref ": " #/definitions/PayloadCommitVerification"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
"AnnotatedTagObject": {
"description": "AnnotatedTagObject contains meta information of the tag object",
"type": "object",
"properties": {
"sha": {
"type": "string",
"x-go-name": "SHA"
},
"type": {
"type": "string",
"x-go-name": "Type"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2018-03-06 09:22:16 +08:00
"Attachment": {
"description": "Attachment a generic attachment",
"type": "object",
"properties": {
"browser_download_url": {
"type": "string",
"x-go-name": "DownloadURL"
},
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
"download_count": {
"type": "integer",
"format": "int64",
"x-go-name": "DownloadCount"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"name": {
"type": "string",
"x-go-name": "Name"
},
"size": {
"type": "integer",
"format": "int64",
"x-go-name": "Size"
},
"uuid": {
"type": "string",
"x-go-name": "UUID"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2018-03-06 09:22:16 +08:00
},
2017-11-13 15:02:25 +08:00
"Branch": {
"description": "Branch represents a repository branch",
"type": "object",
"properties": {
"commit": {
" $ ref ": " #/definitions/PayloadCommit"
},
2019-11-17 03:39:18 +08:00
"enable_status_check": {
"type": "boolean",
"x-go-name": "EnableStatusCheck"
},
2017-11-13 15:02:25 +08:00
"name": {
"type": "string",
"x-go-name": "Name"
2019-11-17 03:39:18 +08:00
},
"protected": {
"type": "boolean",
"x-go-name": "Protected"
},
"required_approvals": {
"type": "integer",
"format": "int64",
"x-go-name": "RequiredApprovals"
},
"status_check_contexts": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "StatusCheckContexts"
},
"user_can_merge": {
"type": "boolean",
"x-go-name": "UserCanMerge"
},
"user_can_push": {
"type": "boolean",
"x-go-name": "UserCanPush"
2017-11-13 15:02:25 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"Comment": {
"description": "Comment represents a comment on a commit or issue",
"type": "object",
"properties": {
"body": {
"type": "string",
"x-go-name": "Body"
},
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
"html_url": {
"type": "string",
"x-go-name": "HTMLURL"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"issue_url": {
"type": "string",
"x-go-name": "IssueURL"
},
2019-07-08 10:14:12 +08:00
"original_author": {
"type": "string",
"x-go-name": "OriginalAuthor"
},
"original_author_id": {
"type": "integer",
"format": "int64",
"x-go-name": "OriginalAuthorID"
},
2017-11-13 15:02:25 +08:00
"pull_request_url": {
"type": "string",
"x-go-name": "PRURL"
},
"updated_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Updated"
},
"user": {
" $ ref ": " #/definitions/User"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-02-03 11:35:17 +08:00
"Commit": {
"type": "object",
"title": "Commit contains information generated from a Git commit.",
"properties": {
"author": {
" $ ref ": " #/definitions/User"
},
"commit": {
" $ ref ": " #/definitions/RepoCommit"
},
"committer": {
" $ ref ": " #/definitions/User"
},
"html_url": {
"type": "string",
"x-go-name": "HTMLURL"
},
"parents": {
"type": "array",
"items": {
" $ ref ": " #/definitions/CommitMeta"
},
"x-go-name": "Parents"
},
"sha": {
"type": "string",
"x-go-name": "SHA"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-02-03 11:35:17 +08:00
},
2019-12-24 10:33:52 +08:00
"CommitDateOptions": {
"description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
"type": "object",
"properties": {
"author": {
"type": "string",
"format": "date-time",
"x-go-name": "Author"
},
"committer": {
"type": "string",
"format": "date-time",
"x-go-name": "Committer"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2019-02-03 11:35:17 +08:00
"CommitMeta": {
"type": "object",
"title": "CommitMeta contains meta information of a commit in terms of API.",
"properties": {
"sha": {
"type": "string",
"x-go-name": "SHA"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-02-03 11:35:17 +08:00
},
"CommitUser": {
"type": "object",
"title": "CommitUser contains information of a user in the context of a commit.",
"properties": {
"date": {
"type": "string",
"x-go-name": "Date"
},
"email": {
"type": "string",
2019-03-22 23:38:49 +08:00
"format": "email",
2019-02-03 11:35:17 +08:00
"x-go-name": "Email"
},
"name": {
"type": "string",
"x-go-name": "Name"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-02-03 11:35:17 +08:00
},
2019-06-30 04:51:10 +08:00
"ContentsResponse": {
"description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
"type": "object",
"properties": {
"_links": {
" $ ref ": " #/definitions/FileLinksResponse"
},
"content": {
"description": "`content` is populated when `type` is `file`, otherwise null",
"type": "string",
"x-go-name": "Content"
},
"download_url": {
"type": "string",
"x-go-name": "DownloadURL"
},
"encoding": {
"description": "`encoding` is populated when `type` is `file`, otherwise null",
"type": "string",
"x-go-name": "Encoding"
},
"git_url": {
"type": "string",
"x-go-name": "GitURL"
},
"html_url": {
"type": "string",
"x-go-name": "HTMLURL"
},
"name": {
"type": "string",
"x-go-name": "Name"
},
"path": {
"type": "string",
"x-go-name": "Path"
},
"sha": {
"type": "string",
"x-go-name": "SHA"
},
"size": {
"type": "integer",
"format": "int64",
"x-go-name": "Size"
},
"submodule_git_url": {
"description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
"type": "string",
"x-go-name": "SubmoduleGitURL"
},
"target": {
"description": "`target` is populated when `type` is `symlink`, otherwise null",
"type": "string",
"x-go-name": "Target"
},
"type": {
"description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
"type": "string",
"x-go-name": "Type"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2017-11-13 15:02:25 +08:00
"CreateEmailOption": {
"description": "CreateEmailOption options when creating email addresses",
"type": "object",
"properties": {
"emails": {
"description": "email addresses to add",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Emails"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-04-18 00:06:35 +08:00
"CreateFileOptions": {
2019-05-31 01:57:55 +08:00
"description": "CreateFileOptions options for creating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
2019-04-18 00:06:35 +08:00
"type": "object",
2019-05-31 01:57:55 +08:00
"required": [
"content"
],
2019-04-18 00:06:35 +08:00
"properties": {
"author": {
" $ ref ": " #/definitions/Identity"
},
"branch": {
2019-05-31 01:57:55 +08:00
"description": "branch (optional) to base this file from. if not given, the default branch is used",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "BranchName"
},
"committer": {
" $ ref ": " #/definitions/Identity"
},
"content": {
2019-05-31 01:57:55 +08:00
"description": "content must be base64 encoded",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "Content"
},
2019-12-24 10:33:52 +08:00
"dates": {
" $ ref ": " #/definitions/CommitDateOptions"
},
2019-04-18 00:06:35 +08:00
"message": {
2019-05-31 01:57:55 +08:00
"description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "Message"
},
"new_branch": {
2019-05-31 01:57:55 +08:00
"description": "new_branch (optional) will make a new branch from `branch` before creating the file",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "NewBranchName"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-18 00:06:35 +08:00
},
2017-11-13 15:02:25 +08:00
"CreateForkOption": {
"description": "CreateForkOption options for creating a fork",
"type": "object",
"properties": {
"organization": {
"description": "organization name, if forking into an organization",
"type": "string",
"x-go-name": "Organization"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateGPGKeyOption": {
"description": "CreateGPGKeyOption options create user GPG key",
"type": "object",
"required": [
"armored_public_key"
],
"properties": {
"armored_public_key": {
"description": "An armored GPG key to add",
"type": "string",
"uniqueItems": true,
"x-go-name": "ArmoredKey"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateHookOption": {
"description": "CreateHookOption options when create a hook",
"type": "object",
"required": [
"type",
"config"
],
"properties": {
"active": {
"type": "boolean",
"default": false,
"x-go-name": "Active"
},
2019-09-09 13:48:21 +08:00
"branch_filter": {
"type": "string",
"x-go-name": "BranchFilter"
},
2017-11-13 15:02:25 +08:00
"config": {
2019-12-31 12:11:15 +08:00
" $ ref ": " #/definitions/CreateHookOptionConfig"
2017-11-13 15:02:25 +08:00
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Events"
},
"type": {
"type": "string",
"enum": [
2019-12-31 12:11:15 +08:00
"dingtalk",
"discord",
2017-11-13 15:02:25 +08:00
"gitea",
"gogs",
2019-12-31 12:11:15 +08:00
"msteams",
2017-11-13 15:02:25 +08:00
"slack",
2019-12-31 12:11:15 +08:00
"telegram"
2017-11-13 15:02:25 +08:00
],
"x-go-name": "Type"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-12-31 12:11:15 +08:00
"CreateHookOptionConfig": {
"description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
"type": "object",
"additionalProperties": {
"type": "string"
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2017-11-13 15:02:25 +08:00
"CreateIssueCommentOption": {
"description": "CreateIssueCommentOption options for creating a comment on an issue",
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"type": "string",
"x-go-name": "Body"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateIssueOption": {
"description": "CreateIssueOption options to create one issue",
"type": "object",
"required": [
"title"
],
"properties": {
"assignee": {
"description": "username of assignee",
"type": "string",
"x-go-name": "Assignee"
},
2018-05-02 03:05:28 +08:00
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Assignees"
},
2017-11-13 15:02:25 +08:00
"body": {
"type": "string",
"x-go-name": "Body"
},
"closed": {
"type": "boolean",
"x-go-name": "Closed"
},
2018-05-02 03:05:28 +08:00
"due_date": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
},
2017-11-13 15:02:25 +08:00
"labels": {
"description": "list of label ids",
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"x-go-name": "Labels"
},
"milestone": {
"description": "milestone id",
"type": "integer",
"format": "int64",
"x-go-name": "Milestone"
},
"title": {
"type": "string",
"x-go-name": "Title"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateKeyOption": {
"description": "CreateKeyOption options when creating a key",
"type": "object",
"required": [
"title",
"key"
],
"properties": {
"key": {
"description": "An armored SSH key to add",
"type": "string",
"uniqueItems": true,
"x-go-name": "Key"
},
2018-03-06 09:22:16 +08:00
"read_only": {
"description": "Describe if the key has only read access or read/write",
"type": "boolean",
"x-go-name": "ReadOnly"
},
2017-11-13 15:02:25 +08:00
"title": {
"description": "Title of the key to add",
"type": "string",
"uniqueItems": true,
"x-go-name": "Title"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateLabelOption": {
"description": "CreateLabelOption options for creating a label",
"type": "object",
"required": [
"name",
"color"
],
"properties": {
"color": {
"type": "string",
"x-go-name": "Color",
"example": " #00aabb"
},
2019-06-16 20:39:52 +08:00
"description": {
"type": "string",
"x-go-name": "Description"
},
2017-11-13 15:02:25 +08:00
"name": {
"type": "string",
"x-go-name": "Name"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateMilestoneOption": {
"description": "CreateMilestoneOption options for creating a milestone",
"type": "object",
"properties": {
"description": {
"type": "string",
"x-go-name": "Description"
},
"due_on": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
},
"title": {
"type": "string",
"x-go-name": "Title"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateOrgOption": {
"description": "CreateOrgOption options for creating an organization",
"type": "object",
"required": [
"username"
],
"properties": {
"description": {
"type": "string",
"x-go-name": "Description"
},
"full_name": {
"type": "string",
"x-go-name": "FullName"
},
"location": {
"type": "string",
"x-go-name": "Location"
},
2019-09-24 04:08:03 +08:00
"repo_admin_change_team_access": {
"type": "boolean",
"x-go-name": "RepoAdminChangeTeamAccess"
},
2017-11-13 15:02:25 +08:00
"username": {
"type": "string",
"x-go-name": "UserName"
},
2019-05-11 04:49:29 +08:00
"visibility": {
2019-05-31 01:57:55 +08:00
"description": "possible values are `public` (default), `limited` or `private`",
"type": "string",
"enum": [
"public",
"limited",
"private"
],
"x-go-name": "Visibility"
2019-05-11 04:49:29 +08:00
},
2017-11-13 15:02:25 +08:00
"website": {
"type": "string",
"x-go-name": "Website"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreatePullRequestOption": {
"description": "CreatePullRequestOption options when creating a pull request",
"type": "object",
"properties": {
"assignee": {
"type": "string",
"x-go-name": "Assignee"
},
2018-05-02 03:05:28 +08:00
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Assignees"
},
2017-11-13 15:02:25 +08:00
"base": {
"type": "string",
"x-go-name": "Base"
},
"body": {
"type": "string",
"x-go-name": "Body"
},
2018-05-02 03:05:28 +08:00
"due_date": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
},
2017-11-13 15:02:25 +08:00
"head": {
"type": "string",
"x-go-name": "Head"
},
"labels": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"x-go-name": "Labels"
},
"milestone": {
"type": "integer",
"format": "int64",
"x-go-name": "Milestone"
},
"title": {
"type": "string",
"x-go-name": "Title"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateReleaseOption": {
"description": "CreateReleaseOption options when creating a release",
"type": "object",
"required": [
"tag_name"
],
"properties": {
"body": {
"type": "string",
"x-go-name": "Note"
},
"draft": {
"type": "boolean",
"x-go-name": "IsDraft"
},
"name": {
"type": "string",
"x-go-name": "Title"
},
"prerelease": {
"type": "boolean",
"x-go-name": "IsPrerelease"
},
"tag_name": {
"type": "string",
"x-go-name": "TagName"
},
"target_commitish": {
"type": "string",
"x-go-name": "Target"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateRepoOption": {
"description": "CreateRepoOption options when creating repository",
"type": "object",
"required": [
"name"
],
"properties": {
"auto_init": {
"description": "Whether the repository should be auto-intialized?",
"type": "boolean",
"x-go-name": "AutoInit"
},
"description": {
"description": "Description of the repository to create",
"type": "string",
"x-go-name": "Description"
},
"gitignores": {
"description": "Gitignores to use",
"type": "string",
"x-go-name": "Gitignores"
},
2019-09-08 16:28:40 +08:00
"issue_labels": {
"description": "Issue Label set to use",
"type": "string",
"x-go-name": "IssueLabels"
},
2017-11-13 15:02:25 +08:00
"license": {
"description": "License to use",
"type": "string",
"x-go-name": "License"
},
"name": {
"description": "Name of the repository to create",
"type": "string",
"uniqueItems": true,
"x-go-name": "Name"
},
"private": {
"description": "Whether the repository is private",
"type": "boolean",
"x-go-name": "Private"
},
"readme": {
"description": "Readme of the repository to create",
"type": "string",
"x-go-name": "Readme"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateStatusOption": {
"description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
"type": "object",
"properties": {
"context": {
"type": "string",
"x-go-name": "Context"
},
"description": {
"type": "string",
"x-go-name": "Description"
},
"state": {
" $ ref ": " #/definitions/StatusState"
},
"target_url": {
"type": "string",
"x-go-name": "TargetURL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateTeamOption": {
"description": "CreateTeamOption options for creating a team",
"type": "object",
"required": [
"name"
],
"properties": {
2019-11-20 19:27:49 +08:00
"can_create_org_repo": {
"type": "boolean",
"x-go-name": "CanCreateOrgRepo"
},
2017-11-13 15:02:25 +08:00
"description": {
"type": "string",
"x-go-name": "Description"
},
2019-11-06 17:37:14 +08:00
"includes_all_repositories": {
"type": "boolean",
"x-go-name": "IncludesAllRepositories"
},
2017-11-13 15:02:25 +08:00
"name": {
"type": "string",
"x-go-name": "Name"
},
"permission": {
"type": "string",
"enum": [
"read",
"write",
"admin"
],
"x-go-name": "Permission"
2018-11-11 03:45:32 +08:00
},
"units": {
"type": "array",
2019-08-27 02:13:10 +08:00
"items": {
"type": "string"
},
"x-go-name": "Units",
"example": [
2018-11-11 03:45:32 +08:00
"repo.code",
"repo.issues",
"repo.ext_issues",
"repo.wiki",
"repo.pulls",
"repo.releases",
"repo.ext_wiki"
2019-08-27 02:13:10 +08:00
]
2017-11-13 15:02:25 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"CreateUserOption": {
"description": "CreateUserOption create user options",
"type": "object",
"required": [
"username",
"email",
"password"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"x-go-name": "Email"
},
"full_name": {
"type": "string",
"x-go-name": "FullName"
},
"login_name": {
"type": "string",
"x-go-name": "LoginName"
},
2019-02-26 02:56:47 +08:00
"must_change_password": {
"type": "boolean",
"x-go-name": "MustChangePassword"
},
2017-11-13 15:02:25 +08:00
"password": {
"type": "string",
"x-go-name": "Password"
},
"send_notify": {
"type": "boolean",
"x-go-name": "SendNotify"
},
"source_id": {
"type": "integer",
"format": "int64",
"x-go-name": "SourceID"
},
"username": {
"type": "string",
"x-go-name": "Username"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"DeleteEmailOption": {
"description": "DeleteEmailOption options when deleting email addresses",
"type": "object",
"properties": {
"emails": {
"description": "email addresses to delete",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Emails"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-04-18 00:06:35 +08:00
"DeleteFileOptions": {
2019-05-31 01:57:55 +08:00
"description": "DeleteFileOptions options for deleting files (used for other File structs below)\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
2019-04-18 00:06:35 +08:00
"type": "object",
2019-05-31 01:57:55 +08:00
"required": [
"sha"
],
2019-04-18 00:06:35 +08:00
"properties": {
"author": {
" $ ref ": " #/definitions/Identity"
},
"branch": {
2019-05-31 01:57:55 +08:00
"description": "branch (optional) to base this file from. if not given, the default branch is used",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "BranchName"
},
"committer": {
" $ ref ": " #/definitions/Identity"
},
2019-12-24 10:33:52 +08:00
"dates": {
" $ ref ": " #/definitions/CommitDateOptions"
},
2019-04-18 00:06:35 +08:00
"message": {
2019-05-31 01:57:55 +08:00
"description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "Message"
},
"new_branch": {
2019-05-31 01:57:55 +08:00
"description": "new_branch (optional) will make a new branch from `branch` before creating the file",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "NewBranchName"
},
"sha": {
2019-05-31 01:57:55 +08:00
"description": "sha is the SHA for the file that already exists",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "SHA"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-18 00:06:35 +08:00
},
2017-11-13 15:02:25 +08:00
"DeployKey": {
"description": "DeployKey a deploy key",
"type": "object",
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
2018-10-29 06:03:02 +08:00
"fingerprint": {
"type": "string",
"x-go-name": "Fingerprint"
},
2017-11-13 15:02:25 +08:00
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"key": {
"type": "string",
"x-go-name": "Key"
},
2018-10-29 06:03:02 +08:00
"key_id": {
"type": "integer",
"format": "int64",
"x-go-name": "KeyID"
},
2017-11-13 15:02:25 +08:00
"read_only": {
"type": "boolean",
"x-go-name": "ReadOnly"
},
2018-10-29 06:03:02 +08:00
"repository": {
" $ ref ": " #/definitions/Repository"
},
2017-11-13 15:02:25 +08:00
"title": {
"type": "string",
"x-go-name": "Title"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2018-03-06 09:22:16 +08:00
"EditAttachmentOptions": {
"description": "EditAttachmentOptions options for editing attachments",
"type": "object",
"properties": {
"name": {
"type": "string",
"x-go-name": "Name"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2018-03-06 09:22:16 +08:00
},
2018-07-16 20:43:00 +08:00
"EditDeadlineOption": {
"description": "EditDeadlineOption options for creating a deadline",
"type": "object",
"required": [
"due_date"
],
"properties": {
"due_date": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2018-07-16 20:43:00 +08:00
},
2019-04-17 13:31:08 +08:00
"EditGitHookOption": {
"description": "EditGitHookOption options when modifying one Git hook",
"type": "object",
"properties": {
"content": {
"type": "string",
"x-go-name": "Content"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-17 13:31:08 +08:00
},
2017-11-13 15:02:25 +08:00
"EditHookOption": {
"description": "EditHookOption options when modify one hook",
"type": "object",
"properties": {
"active": {
"type": "boolean",
"x-go-name": "Active"
},
2019-09-09 13:48:21 +08:00
"branch_filter": {
"type": "string",
"x-go-name": "BranchFilter"
},
2017-11-13 15:02:25 +08:00
"config": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"x-go-name": "Config"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Events"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"EditIssueCommentOption": {
"description": "EditIssueCommentOption options for editing a comment",
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"type": "string",
"x-go-name": "Body"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"EditIssueOption": {
"description": "EditIssueOption options for editing an issue",
"type": "object",
"properties": {
"assignee": {
"type": "string",
"x-go-name": "Assignee"
},
2018-05-02 03:05:28 +08:00
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Assignees"
},
2017-11-13 15:02:25 +08:00
"body": {
"type": "string",
"x-go-name": "Body"
},
2018-05-02 03:05:28 +08:00
"due_date": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
},
2017-11-13 15:02:25 +08:00
"milestone": {
"type": "integer",
"format": "int64",
"x-go-name": "Milestone"
},
"state": {
"type": "string",
"x-go-name": "State"
},
"title": {
"type": "string",
"x-go-name": "Title"
2019-11-03 22:46:32 +08:00
},
"unset_due_date": {
"type": "boolean",
"x-go-name": "RemoveDeadline"
2017-11-13 15:02:25 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"EditLabelOption": {
"description": "EditLabelOption options for editing a label",
"type": "object",
"properties": {
"color": {
"type": "string",
"x-go-name": "Color"
},
2019-06-16 20:39:52 +08:00
"description": {
"type": "string",
"x-go-name": "Description"
},
2017-11-13 15:02:25 +08:00
"name": {
"type": "string",
"x-go-name": "Name"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"EditMilestoneOption": {
"description": "EditMilestoneOption options for editing a milestone",
"type": "object",
"properties": {
"description": {
"type": "string",
"x-go-name": "Description"
},
"due_on": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
},
"state": {
"type": "string",
"x-go-name": "State"
},
"title": {
"type": "string",
"x-go-name": "Title"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"EditOrgOption": {
"description": "EditOrgOption options for editing an organization",
"type": "object",
"properties": {
"description": {
"type": "string",
"x-go-name": "Description"
},
"full_name": {
"type": "string",
"x-go-name": "FullName"
},
"location": {
"type": "string",
"x-go-name": "Location"
},
2019-09-24 04:08:03 +08:00
"repo_admin_change_team_access": {
"type": "boolean",
"x-go-name": "RepoAdminChangeTeamAccess"
},
2019-05-31 01:57:55 +08:00
"visibility": {
"description": "possible values are `public`, `limited` or `private`",
"type": "string",
"enum": [
"public",
"limited",
"private"
],
"x-go-name": "Visibility"
},
2017-11-13 15:02:25 +08:00
"website": {
"type": "string",
"x-go-name": "Website"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"EditPullRequestOption": {
"description": "EditPullRequestOption options when modify pull request",
"type": "object",
"properties": {
"assignee": {
"type": "string",
"x-go-name": "Assignee"
},
2018-05-02 03:05:28 +08:00
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Assignees"
},
2017-11-13 15:02:25 +08:00
"body": {
"type": "string",
"x-go-name": "Body"
},
2018-05-02 03:05:28 +08:00
"due_date": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
},
2017-11-13 15:02:25 +08:00
"labels": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"x-go-name": "Labels"
},
"milestone": {
"type": "integer",
"format": "int64",
"x-go-name": "Milestone"
},
"state": {
"type": "string",
"x-go-name": "State"
},
"title": {
"type": "string",
"x-go-name": "Title"
2019-11-03 22:46:32 +08:00
},
"unset_due_date": {
"type": "boolean",
"x-go-name": "RemoveDeadline"
2017-11-13 15:02:25 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-12-08 06:04:19 +08:00
"EditReactionOption": {
"description": "EditReactionOption contain the reaction type",
"type": "object",
"properties": {
"content": {
"type": "string",
"x-go-name": "Reaction"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2017-11-13 15:02:25 +08:00
"EditReleaseOption": {
"description": "EditReleaseOption options when editing a release",
"type": "object",
"properties": {
"body": {
"type": "string",
"x-go-name": "Note"
},
"draft": {
"type": "boolean",
"x-go-name": "IsDraft"
},
"name": {
"type": "string",
"x-go-name": "Title"
},
"prerelease": {
"type": "boolean",
"x-go-name": "IsPrerelease"
},
"tag_name": {
"type": "string",
"x-go-name": "TagName"
},
"target_commitish": {
"type": "string",
"x-go-name": "Target"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-05-30 23:09:05 +08:00
"EditRepoOption": {
"description": "EditRepoOption options when editing a repository's properties",
"type": "object",
"properties": {
"allow_merge_commits": {
"description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`.",
"type": "boolean",
"x-go-name": "AllowMerge"
},
"allow_rebase": {
"description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
"type": "boolean",
"x-go-name": "AllowRebase"
},
"allow_rebase_explicit": {
"description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`.",
"type": "boolean",
"x-go-name": "AllowRebaseMerge"
},
"allow_squash_merge": {
"description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
"type": "boolean",
"x-go-name": "AllowSquash"
},
"archived": {
"description": "set to `true` to archive this repository.",
"type": "boolean",
"x-go-name": "Archived"
},
"default_branch": {
"description": "sets the default branch for this repository.",
"type": "string",
"x-go-name": "DefaultBranch"
},
"description": {
"description": "a short description of the repository.",
"type": "string",
"x-go-name": "Description"
},
2019-10-02 17:30:41 +08:00
"external_tracker": {
" $ ref ": " #/definitions/ExternalTracker"
},
"external_wiki": {
" $ ref ": " #/definitions/ExternalWiki"
},
2019-05-30 23:09:05 +08:00
"has_issues": {
"description": "either `true` to enable issues for this repository or `false` to disable them.",
"type": "boolean",
"x-go-name": "HasIssues"
},
"has_pull_requests": {
"description": "either `true` to allow pull requests, or `false` to prevent pull request.",
"type": "boolean",
"x-go-name": "HasPullRequests"
},
"has_wiki": {
"description": "either `true` to enable the wiki for this repository or `false` to disable it.",
"type": "boolean",
"x-go-name": "HasWiki"
},
"ignore_whitespace_conflicts": {
"description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
"type": "boolean",
"x-go-name": "IgnoreWhitespaceConflicts"
},
2019-10-02 17:30:41 +08:00
"internal_tracker": {
" $ ref ": " #/definitions/InternalTracker"
},
2019-05-30 23:09:05 +08:00
"name": {
"description": "name of the repository",
"type": "string",
"uniqueItems": true,
"x-go-name": "Name"
},
"private": {
"description": "either `true` to make the repository private or `false` to make it public.\nNote: you will get a 422 error if the organization restricts changing repository visibility to organization\nowners and a non-owner tries to change the value of private.",
"type": "boolean",
"x-go-name": "Private"
},
2019-11-11 23:15:29 +08:00
"template": {
"description": "either `true` to make this repository a template or `false` to make it a normal repository",
"type": "boolean",
"x-go-name": "Template"
},
2019-05-30 23:09:05 +08:00
"website": {
"description": "a URL with more information about the repository.",
"type": "string",
"x-go-name": "Website"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2017-11-13 15:02:25 +08:00
"EditTeamOption": {
"description": "EditTeamOption options for editing a team",
"type": "object",
"required": [
"name"
],
"properties": {
2019-11-20 19:27:49 +08:00
"can_create_org_repo": {
"type": "boolean",
"x-go-name": "CanCreateOrgRepo"
},
2017-11-13 15:02:25 +08:00
"description": {
"type": "string",
"x-go-name": "Description"
},
2019-11-06 17:37:14 +08:00
"includes_all_repositories": {
"type": "boolean",
"x-go-name": "IncludesAllRepositories"
},
2017-11-13 15:02:25 +08:00
"name": {
"type": "string",
"x-go-name": "Name"
},
"permission": {
"type": "string",
"enum": [
"read",
"write",
"admin"
],
"x-go-name": "Permission"
2018-11-11 03:45:32 +08:00
},
"units": {
"type": "array",
2019-08-27 02:13:10 +08:00
"items": {
"type": "string"
},
"x-go-name": "Units",
"example": [
2018-11-11 03:45:32 +08:00
"repo.code",
"repo.issues",
"repo.ext_issues",
"repo.wiki",
"repo.pulls",
"repo.releases",
"repo.ext_wiki"
2019-08-27 02:13:10 +08:00
]
2017-11-13 15:02:25 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"EditUserOption": {
"description": "EditUserOption edit user options",
"type": "object",
"required": [
"email"
],
"properties": {
"active": {
"type": "boolean",
"x-go-name": "Active"
},
"admin": {
"type": "boolean",
"x-go-name": "Admin"
},
2018-08-24 07:59:47 +08:00
"allow_create_organization": {
"type": "boolean",
"x-go-name": "AllowCreateOrganization"
},
2017-11-13 15:02:25 +08:00
"allow_git_hook": {
"type": "boolean",
"x-go-name": "AllowGitHook"
},
"allow_import_local": {
"type": "boolean",
"x-go-name": "AllowImportLocal"
},
"email": {
"type": "string",
"format": "email",
"x-go-name": "Email"
},
"full_name": {
"type": "string",
"x-go-name": "FullName"
},
"location": {
"type": "string",
"x-go-name": "Location"
},
"login_name": {
"type": "string",
"x-go-name": "LoginName"
},
"max_repo_creation": {
"type": "integer",
"format": "int64",
"x-go-name": "MaxRepoCreation"
},
2019-02-26 02:56:47 +08:00
"must_change_password": {
"type": "boolean",
"x-go-name": "MustChangePassword"
},
2017-11-13 15:02:25 +08:00
"password": {
"type": "string",
"x-go-name": "Password"
},
2018-08-24 07:59:47 +08:00
"prohibit_login": {
"type": "boolean",
"x-go-name": "ProhibitLogin"
},
2017-11-13 15:02:25 +08:00
"source_id": {
"type": "integer",
"format": "int64",
"x-go-name": "SourceID"
},
"website": {
"type": "string",
"x-go-name": "Website"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"Email": {
"description": "Email an email address belonging to a user",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"x-go-name": "Email"
},
"primary": {
"type": "boolean",
"x-go-name": "Primary"
},
"verified": {
"type": "boolean",
"x-go-name": "Verified"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-10-02 17:30:41 +08:00
"ExternalTracker": {
"description": "ExternalTracker represents settings for external tracker",
"type": "object",
"properties": {
"external_tracker_format": {
"description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
"type": "string",
"x-go-name": "ExternalTrackerFormat"
},
"external_tracker_style": {
"description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
"type": "string",
"x-go-name": "ExternalTrackerStyle"
},
"external_tracker_url": {
"description": "URL of external issue tracker.",
"type": "string",
"x-go-name": "ExternalTrackerURL"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
"ExternalWiki": {
"description": "ExternalWiki represents setting for external wiki",
"type": "object",
"properties": {
"external_wiki_url": {
"description": "URL of external wiki.",
"type": "string",
"x-go-name": "ExternalWikiURL"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2019-04-18 00:06:35 +08:00
"FileCommitResponse": {
"type": "object",
"title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
"properties": {
"author": {
" $ ref ": " #/definitions/CommitUser"
},
"committer": {
" $ ref ": " #/definitions/CommitUser"
},
"html_url": {
"type": "string",
"x-go-name": "HTMLURL"
},
"message": {
"type": "string",
"x-go-name": "Message"
},
"parents": {
"type": "array",
"items": {
" $ ref ": " #/definitions/CommitMeta"
},
"x-go-name": "Parents"
},
"sha": {
"type": "string",
"x-go-name": "SHA"
},
"tree": {
" $ ref ": " #/definitions/CommitMeta"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-18 00:06:35 +08:00
},
"FileDeleteResponse": {
"description": "FileDeleteResponse contains information about a repo's file that was deleted",
"type": "object",
"properties": {
"commit": {
" $ ref ": " #/definitions/FileCommitResponse"
},
"content": {
"type": "object",
"x-go-name": "Content"
},
"verification": {
" $ ref ": " #/definitions/PayloadCommitVerification"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-18 00:06:35 +08:00
},
"FileLinksResponse": {
"description": "FileLinksResponse contains the links for a repo's file",
"type": "object",
"properties": {
2019-06-30 04:51:10 +08:00
"git": {
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "GitURL"
},
2019-06-30 04:51:10 +08:00
"html": {
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "HTMLURL"
},
2019-06-30 04:51:10 +08:00
"self": {
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "Self"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-18 00:06:35 +08:00
},
"FileResponse": {
"description": "FileResponse contains information about a repo's file",
"type": "object",
"properties": {
"commit": {
" $ ref ": " #/definitions/FileCommitResponse"
},
"content": {
2019-06-30 04:51:10 +08:00
" $ ref ": " #/definitions/ContentsResponse"
2019-04-18 00:06:35 +08:00
},
"verification": {
" $ ref ": " #/definitions/PayloadCommitVerification"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-18 00:06:35 +08:00
},
2017-11-13 15:02:25 +08:00
"GPGKey": {
"description": "GPGKey a user GPG key to sign commit and tag in repository",
"type": "object",
"properties": {
"can_certify": {
"type": "boolean",
"x-go-name": "CanCertify"
},
"can_encrypt_comms": {
"type": "boolean",
"x-go-name": "CanEncryptComms"
},
"can_encrypt_storage": {
"type": "boolean",
"x-go-name": "CanEncryptStorage"
},
"can_sign": {
"type": "boolean",
"x-go-name": "CanSign"
},
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
"emails": {
"type": "array",
"items": {
" $ ref ": " #/definitions/GPGKeyEmail"
},
"x-go-name": "Emails"
},
"expires_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Expires"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"key_id": {
"type": "string",
"x-go-name": "KeyID"
},
"primary_key_id": {
"type": "string",
"x-go-name": "PrimaryKeyID"
},
"public_key": {
"type": "string",
"x-go-name": "PublicKey"
},
"subkeys": {
"type": "array",
"items": {
" $ ref ": " #/definitions/GPGKey"
},
"x-go-name": "SubsKey"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"GPGKeyEmail": {
"description": "GPGKeyEmail an email attached to a GPGKey",
"type": "object",
"properties": {
"email": {
"type": "string",
"x-go-name": "Email"
},
"verified": {
"type": "boolean",
"x-go-name": "Verified"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-04-18 00:06:35 +08:00
"GitBlobResponse": {
"description": "GitBlobResponse represents a git blob",
"type": "object",
"properties": {
"content": {
"type": "string",
"x-go-name": "Content"
},
"encoding": {
"type": "string",
"x-go-name": "Encoding"
},
"sha": {
"type": "string",
"x-go-name": "SHA"
},
"size": {
"type": "integer",
"format": "int64",
"x-go-name": "Size"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-18 00:06:35 +08:00
},
2019-01-25 02:13:30 +08:00
"GitEntry": {
"description": "GitEntry represents a git tree",
"type": "object",
"properties": {
"mode": {
"type": "string",
"x-go-name": "Mode"
},
"path": {
"type": "string",
"x-go-name": "Path"
},
"sha": {
"type": "string",
"x-go-name": "SHA"
},
"size": {
"type": "integer",
"format": "int64",
"x-go-name": "Size"
},
"type": {
"type": "string",
"x-go-name": "Type"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-01-25 02:13:30 +08:00
},
2019-04-17 13:31:08 +08:00
"GitHook": {
"description": "GitHook represents a Git repository hook",
"type": "object",
"properties": {
"content": {
"type": "string",
"x-go-name": "Content"
},
"is_active": {
"type": "boolean",
"x-go-name": "IsActive"
},
"name": {
"type": "string",
"x-go-name": "Name"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-17 13:31:08 +08:00
},
2018-11-28 05:52:20 +08:00
"GitObject": {
"type": "object",
"title": "GitObject represents a Git object.",
"properties": {
"sha": {
"type": "string",
"x-go-name": "SHA"
},
"type": {
"type": "string",
"x-go-name": "Type"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2018-11-28 05:52:20 +08:00
},
2019-01-25 02:13:30 +08:00
"GitTreeResponse": {
"description": "GitTreeResponse returns a git tree",
"type": "object",
"properties": {
2019-02-07 02:19:26 +08:00
"page": {
"type": "integer",
"format": "int64",
"x-go-name": "Page"
},
2019-01-25 02:13:30 +08:00
"sha": {
"type": "string",
"x-go-name": "SHA"
},
2019-02-07 02:19:26 +08:00
"total_count": {
"type": "integer",
"format": "int64",
"x-go-name": "TotalCount"
},
2019-01-25 02:13:30 +08:00
"tree": {
"type": "array",
"items": {
" $ ref ": " #/definitions/GitEntry"
},
"x-go-name": "Entries"
},
"truncated": {
"type": "boolean",
"x-go-name": "Truncated"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-01-25 02:13:30 +08:00
},
2019-03-27 03:41:17 +08:00
"Hook": {
"description": "Hook a hook is a web hook when one repository changed",
"type": "object",
"properties": {
"active": {
"type": "boolean",
"x-go-name": "Active"
},
"config": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"x-go-name": "Config"
},
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Events"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"type": {
"type": "string",
"x-go-name": "Type"
},
"updated_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Updated"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-03-27 03:41:17 +08:00
},
2019-04-18 00:06:35 +08:00
"Identity": {
"description": "Identity for a person's identity like an author or committer",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"x-go-name": "Email"
},
"name": {
"type": "string",
"x-go-name": "Name"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-18 00:06:35 +08:00
},
2019-10-02 17:30:41 +08:00
"InternalTracker": {
"description": "InternalTracker represents settings for internal tracker",
"type": "object",
"properties": {
"allow_only_contributors_to_track_time": {
"description": "Let only contributors track time (Built-in issue tracker)",
"type": "boolean",
"x-go-name": "AllowOnlyContributorsToTrackTime"
},
"enable_issue_dependencies": {
"description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
"type": "boolean",
"x-go-name": "EnableIssueDependencies"
},
"enable_time_tracker": {
"description": "Enable time tracking (Built-in issue tracker)",
"type": "boolean",
"x-go-name": "EnableTimeTracker"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2017-11-13 15:02:25 +08:00
"Issue": {
"description": "Issue represents an issue in a repository",
"type": "object",
"properties": {
"assignee": {
" $ ref ": " #/definitions/User"
},
2018-05-02 03:05:28 +08:00
"assignees": {
"type": "array",
"items": {
" $ ref ": " #/definitions/User"
},
"x-go-name": "Assignees"
},
2017-11-13 15:02:25 +08:00
"body": {
"type": "string",
"x-go-name": "Body"
},
2018-05-02 03:05:28 +08:00
"closed_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Closed"
},
2017-11-13 15:02:25 +08:00
"comments": {
"type": "integer",
"format": "int64",
"x-go-name": "Comments"
},
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
2018-05-02 03:05:28 +08:00
"due_date": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
},
2020-01-09 07:10:34 +08:00
"html_url": {
"type": "string",
"x-go-name": "HTMLURL"
},
2017-11-13 15:02:25 +08:00
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"labels": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Label"
},
"x-go-name": "Labels"
},
"milestone": {
" $ ref ": " #/definitions/Milestone"
},
"number": {
"type": "integer",
"format": "int64",
"x-go-name": "Index"
},
2019-07-08 10:14:12 +08:00
"original_author": {
"type": "string",
"x-go-name": "OriginalAuthor"
},
"original_author_id": {
"type": "integer",
"format": "int64",
"x-go-name": "OriginalAuthorID"
},
2017-11-13 15:02:25 +08:00
"pull_request": {
" $ ref ": " #/definitions/PullRequestMeta"
},
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 13:06:10 +08:00
"repository": {
" $ ref ": " #/definitions/RepositoryMeta"
},
2017-11-13 15:02:25 +08:00
"state": {
" $ ref ": " #/definitions/StateType"
},
"title": {
"type": "string",
"x-go-name": "Title"
},
"updated_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Updated"
},
"url": {
"type": "string",
"x-go-name": "URL"
},
"user": {
" $ ref ": " #/definitions/User"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2018-07-16 20:43:00 +08:00
"IssueDeadline": {
"description": "IssueDeadline represents an issue deadline",
"type": "object",
"properties": {
"due_date": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2018-07-16 20:43:00 +08:00
},
2017-11-13 15:02:25 +08:00
"IssueLabelsOption": {
"description": "IssueLabelsOption a collection of labels",
"type": "object",
"properties": {
"labels": {
"description": "list of label IDs",
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"x-go-name": "Labels"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"Label": {
"description": "Label a label to an issue or a pr",
"type": "object",
"properties": {
"color": {
"type": "string",
"x-go-name": "Color",
"example": "00aabb"
},
2019-06-16 20:39:52 +08:00
"description": {
"type": "string",
"x-go-name": "Description"
},
2017-11-13 15:02:25 +08:00
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"name": {
"type": "string",
"x-go-name": "Name"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"MarkdownOption": {
"description": "MarkdownOption markdown options",
"type": "object",
"properties": {
"Context": {
"description": "Context to render\n\nin: body",
"type": "string"
},
"Mode": {
"description": "Mode to render\n\nin: body",
"type": "string"
},
"Text": {
"description": "Text markdown to render\n\nin: body",
"type": "string"
},
"Wiki": {
"description": "Is it a wiki page ?\n\nin: body",
"type": "boolean"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-02-08 16:08:38 +08:00
"MergePullRequestOption": {
"description": "MergePullRequestForm form for merging Pull Request",
"type": "object",
"required": [
"Do"
],
"properties": {
"Do": {
"type": "string",
"enum": [
"merge",
2019-02-09 20:48:28 +08:00
"rebase",
"rebase-merge",
"squash"
2019-02-08 16:08:38 +08:00
]
},
"MergeMessageField": {
"type": "string"
},
"MergeTitleField": {
"type": "string"
2020-01-11 15:29:34 +08:00
},
"force_merge": {
"type": "boolean",
"x-go-name": "ForceMerge"
2019-02-08 16:08:38 +08:00
}
},
"x-go-name": "MergePullRequestForm",
"x-go-package": "code.gitea.io/gitea/modules/auth"
},
2017-11-13 15:02:25 +08:00
"MigrateRepoForm": {
"description": "MigrateRepoForm form for migrating repository",
"type": "object",
"required": [
"clone_addr",
"uid",
"repo_name"
],
"properties": {
"auth_password": {
"type": "string",
"x-go-name": "AuthPassword"
},
"auth_username": {
"type": "string",
"x-go-name": "AuthUsername"
},
"clone_addr": {
"type": "string",
"x-go-name": "CloneAddr"
},
"description": {
"type": "string",
"x-go-name": "Description"
},
2019-05-07 09:12:51 +08:00
"issues": {
"type": "boolean",
"x-go-name": "Issues"
},
"labels": {
"type": "boolean",
"x-go-name": "Labels"
},
"milestones": {
"type": "boolean",
"x-go-name": "Milestones"
},
2017-11-13 15:02:25 +08:00
"mirror": {
"type": "boolean",
"x-go-name": "Mirror"
},
"private": {
"type": "boolean",
"x-go-name": "Private"
},
2019-05-07 09:12:51 +08:00
"pull_requests": {
"type": "boolean",
"x-go-name": "PullRequests"
},
"releases": {
"type": "boolean",
"x-go-name": "Releases"
},
2017-11-13 15:02:25 +08:00
"repo_name": {
"type": "string",
"x-go-name": "RepoName"
},
"uid": {
"type": "integer",
"format": "int64",
"x-go-name": "UID"
2019-05-07 09:12:51 +08:00
},
"wiki": {
"type": "boolean",
"x-go-name": "Wiki"
2017-11-13 15:02:25 +08:00
}
},
"x-go-package": "code.gitea.io/gitea/modules/auth"
},
"Milestone": {
"description": "Milestone milestone is a collection of issues on one repository",
"type": "object",
"properties": {
"closed_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Closed"
},
"closed_issues": {
"type": "integer",
"format": "int64",
"x-go-name": "ClosedIssues"
},
"description": {
"type": "string",
"x-go-name": "Description"
},
"due_on": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"open_issues": {
"type": "integer",
"format": "int64",
"x-go-name": "OpenIssues"
},
"state": {
" $ ref ": " #/definitions/StateType"
},
"title": {
"type": "string",
"x-go-name": "Title"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2020-01-14 23:37:19 +08:00
"NotificationCount": {
"description": "NotificationCount number of unread notifications",
"type": "object",
"properties": {
"new": {
"type": "integer",
"format": "int64",
"x-go-name": "New"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2020-01-09 19:56:32 +08:00
"NotificationSubject": {
"description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
"type": "object",
"properties": {
"latest_comment_url": {
"type": "string",
"x-go-name": "LatestCommentURL"
},
"title": {
"type": "string",
"x-go-name": "Title"
},
"type": {
"type": "string",
"x-go-name": "Type"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
"NotificationThread": {
"description": "NotificationThread expose Notification on API",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"pinned": {
"type": "boolean",
"x-go-name": "Pinned"
},
"repository": {
" $ ref ": " #/definitions/Repository"
},
"subject": {
" $ ref ": " #/definitions/NotificationSubject"
},
"unread": {
"type": "boolean",
"x-go-name": "Unread"
},
"updated_at": {
"type": "string",
"format": "date-time",
"x-go-name": "UpdatedAt"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2017-11-13 15:02:25 +08:00
"Organization": {
"description": "Organization represents an organization",
"type": "object",
"properties": {
"avatar_url": {
"type": "string",
"x-go-name": "AvatarURL"
},
"description": {
"type": "string",
"x-go-name": "Description"
},
"full_name": {
"type": "string",
"x-go-name": "FullName"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"location": {
"type": "string",
"x-go-name": "Location"
},
2019-09-24 04:08:03 +08:00
"repo_admin_change_team_access": {
"type": "boolean",
"x-go-name": "RepoAdminChangeTeamAccess"
},
2017-11-13 15:02:25 +08:00
"username": {
"type": "string",
"x-go-name": "UserName"
},
2019-05-11 04:49:29 +08:00
"visibility": {
2019-05-31 01:57:55 +08:00
"type": "string",
"x-go-name": "Visibility"
2019-05-11 04:49:29 +08:00
},
2017-11-13 15:02:25 +08:00
"website": {
"type": "string",
"x-go-name": "Website"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"PRBranchInfo": {
"description": "PRBranchInfo information about a branch",
"type": "object",
"properties": {
"label": {
"type": "string",
"x-go-name": "Name"
},
"ref": {
"type": "string",
"x-go-name": "Ref"
},
"repo": {
" $ ref ": " #/definitions/Repository"
},
"repo_id": {
"type": "integer",
"format": "int64",
"x-go-name": "RepoID"
},
"sha": {
"type": "string",
"x-go-name": "Sha"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"PayloadCommit": {
"description": "PayloadCommit represents a commit",
"type": "object",
"properties": {
2019-01-31 00:33:00 +08:00
"added": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Added"
},
2017-11-13 15:02:25 +08:00
"author": {
" $ ref ": " #/definitions/PayloadUser"
},
"committer": {
" $ ref ": " #/definitions/PayloadUser"
},
"id": {
"description": "sha1 hash of the commit",
"type": "string",
"x-go-name": "ID"
},
"message": {
"type": "string",
"x-go-name": "Message"
},
2019-01-31 00:33:00 +08:00
"modified": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Modified"
},
"removed": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Removed"
},
2017-11-13 15:02:25 +08:00
"timestamp": {
"type": "string",
"format": "date-time",
"x-go-name": "Timestamp"
},
"url": {
"type": "string",
"x-go-name": "URL"
},
"verification": {
" $ ref ": " #/definitions/PayloadCommitVerification"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"PayloadCommitVerification": {
"description": "PayloadCommitVerification represents the GPG verification of a commit",
"type": "object",
"properties": {
"payload": {
"type": "string",
"x-go-name": "Payload"
},
"reason": {
"type": "string",
"x-go-name": "Reason"
},
"signature": {
"type": "string",
"x-go-name": "Signature"
},
2019-10-16 21:42:42 +08:00
"signer": {
" $ ref ": " #/definitions/PayloadUser"
},
2017-11-13 15:02:25 +08:00
"verified": {
"type": "boolean",
"x-go-name": "Verified"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"PayloadUser": {
"description": "PayloadUser represents the author or committer of a commit",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"x-go-name": "Email"
},
"name": {
"description": "Full name of the commit author",
"type": "string",
"x-go-name": "Name"
},
"username": {
"type": "string",
"x-go-name": "UserName"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"Permission": {
"description": "Permission represents a set of permissions",
"type": "object",
"properties": {
"admin": {
"type": "boolean",
"x-go-name": "Admin"
},
"pull": {
"type": "boolean",
"x-go-name": "Pull"
},
"push": {
"type": "boolean",
"x-go-name": "Push"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"PublicKey": {
"description": "PublicKey publickey is a user key to push code to repository",
"type": "object",
"properties": {
2017-05-02 21:35:59 +08:00
"created_at": {
2017-11-13 15:02:25 +08:00
"type": "string",
"format": "date-time",
2017-05-02 21:35:59 +08:00
"x-go-name": "Created"
},
2017-12-06 18:27:10 +08:00
"fingerprint": {
"type": "string",
"x-go-name": "Fingerprint"
},
2017-11-13 15:02:25 +08:00
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"key": {
"type": "string",
"x-go-name": "Key"
},
2018-10-29 06:03:02 +08:00
"key_type": {
"type": "string",
"x-go-name": "KeyType"
},
"read_only": {
"type": "boolean",
"x-go-name": "ReadOnly"
},
2017-11-13 15:02:25 +08:00
"title": {
"type": "string",
"x-go-name": "Title"
},
"url": {
"type": "string",
"x-go-name": "URL"
2018-10-29 06:03:02 +08:00
},
"user": {
" $ ref ": " #/definitions/User"
2017-11-13 15:02:25 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"PullRequest": {
"description": "PullRequest represents a pull request",
"type": "object",
"properties": {
"assignee": {
" $ ref ": " #/definitions/User"
},
2018-05-02 03:05:28 +08:00
"assignees": {
"type": "array",
"items": {
" $ ref ": " #/definitions/User"
},
"x-go-name": "Assignees"
},
2017-11-13 15:02:25 +08:00
"base": {
" $ ref ": " #/definitions/PRBranchInfo"
},
"body": {
"type": "string",
"x-go-name": "Body"
},
2018-05-02 03:05:28 +08:00
"closed_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Closed"
},
2017-11-13 15:02:25 +08:00
"comments": {
"type": "integer",
"format": "int64",
"x-go-name": "Comments"
},
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
"diff_url": {
"type": "string",
"x-go-name": "DiffURL"
},
2018-05-02 03:05:28 +08:00
"due_date": {
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
},
2017-11-13 15:02:25 +08:00
"head": {
" $ ref ": " #/definitions/PRBranchInfo"
},
"html_url": {
"type": "string",
"x-go-name": "HTMLURL"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"labels": {
2017-05-02 21:35:59 +08:00
"type": "array",
"items": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/Label"
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"x-go-name": "Labels"
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"merge_base": {
"type": "string",
"x-go-name": "MergeBase"
},
"merge_commit_sha": {
"type": "string",
"x-go-name": "MergedCommitID"
},
"mergeable": {
"type": "boolean",
"x-go-name": "Mergeable"
},
"merged": {
"type": "boolean",
"x-go-name": "HasMerged"
},
"merged_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Merged"
},
"merged_by": {
" $ ref ": " #/definitions/User"
},
"milestone": {
" $ ref ": " #/definitions/Milestone"
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"number": {
2017-05-02 21:35:59 +08:00
"type": "integer",
"format": "int64",
2017-11-13 15:02:25 +08:00
"x-go-name": "Index"
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"patch_url": {
2017-05-02 21:35:59 +08:00
"type": "string",
2017-11-13 15:02:25 +08:00
"x-go-name": "PatchURL"
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"state": {
" $ ref ": " #/definitions/StateType"
},
"title": {
2017-05-02 21:35:59 +08:00
"type": "string",
2017-11-13 15:02:25 +08:00
"x-go-name": "Title"
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"updated_at": {
2017-05-02 21:35:59 +08:00
"type": "string",
2017-11-13 15:02:25 +08:00
"format": "date-time",
"x-go-name": "Updated"
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"url": {
"type": "string",
"x-go-name": "URL"
},
"user": {
" $ ref ": " #/definitions/User"
2017-05-02 21:35:59 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"PullRequestMeta": {
"description": "PullRequestMeta PR info if an issue is a PR",
2017-05-02 21:35:59 +08:00
"type": "object",
"properties": {
2017-11-13 15:02:25 +08:00
"merged": {
2017-05-02 21:35:59 +08:00
"type": "boolean",
2017-11-13 15:02:25 +08:00
"x-go-name": "HasMerged"
},
"merged_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Merged"
2017-05-02 21:35:59 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-05-02 21:35:59 +08:00
},
2019-12-31 16:21:21 +08:00
"Reaction": {
"description": "Reaction contain one reaction",
2019-12-08 06:04:19 +08:00
"type": "object",
"properties": {
"content": {
"type": "string",
"x-go-name": "Reaction"
},
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
"user": {
" $ ref ": " #/definitions/User"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2018-11-28 05:52:20 +08:00
"Reference": {
"type": "object",
"title": "Reference represents a Git reference.",
"properties": {
"object": {
" $ ref ": " #/definitions/GitObject"
},
"ref": {
"type": "string",
"x-go-name": "Ref"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2018-11-28 05:52:20 +08:00
},
2017-11-13 15:02:25 +08:00
"Release": {
"description": "Release represents a repository release",
2017-05-02 21:35:59 +08:00
"type": "object",
"properties": {
2018-03-06 09:22:16 +08:00
"assets": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Attachment"
},
"x-go-name": "Attachments"
},
2017-11-13 15:02:25 +08:00
"author": {
" $ ref ": " #/definitions/User"
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"body": {
"type": "string",
"x-go-name": "Note"
},
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "CreatedAt"
},
"draft": {
2017-05-02 21:35:59 +08:00
"type": "boolean",
2017-11-13 15:02:25 +08:00
"x-go-name": "IsDraft"
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"name": {
"type": "string",
"x-go-name": "Title"
},
"prerelease": {
2017-05-02 21:35:59 +08:00
"type": "boolean",
2017-11-13 15:02:25 +08:00
"x-go-name": "IsPrerelease"
},
"published_at": {
"type": "string",
"format": "date-time",
"x-go-name": "PublishedAt"
},
"tag_name": {
"type": "string",
"x-go-name": "TagName"
},
"tarball_url": {
"type": "string",
"x-go-name": "TarURL"
},
"target_commitish": {
"type": "string",
"x-go-name": "Target"
},
"url": {
"type": "string",
"x-go-name": "URL"
},
"zipball_url": {
"type": "string",
"x-go-name": "ZipURL"
2017-05-02 21:35:59 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-05-02 21:35:59 +08:00
},
2019-02-03 11:35:17 +08:00
"RepoCommit": {
"type": "object",
"title": "RepoCommit contains information of a commit in the context of a repository.",
"properties": {
"author": {
" $ ref ": " #/definitions/CommitUser"
},
"committer": {
" $ ref ": " #/definitions/CommitUser"
},
"message": {
"type": "string",
"x-go-name": "Message"
},
"tree": {
" $ ref ": " #/definitions/CommitMeta"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-02-03 11:35:17 +08:00
},
2019-09-03 23:46:24 +08:00
"RepoTopicOptions": {
"description": "RepoTopicOptions a collection of repo topic names",
"type": "object",
"properties": {
"topics": {
"description": "list of topic names",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Topics"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2017-05-02 21:35:59 +08:00
"Repository": {
2017-11-13 15:02:25 +08:00
"description": "Repository represents a repository",
2017-05-02 21:35:59 +08:00
"type": "object",
"properties": {
2019-05-30 23:09:05 +08:00
"allow_merge_commits": {
"type": "boolean",
"x-go-name": "AllowMerge"
},
"allow_rebase": {
"type": "boolean",
"x-go-name": "AllowRebase"
},
"allow_rebase_explicit": {
"type": "boolean",
"x-go-name": "AllowRebaseMerge"
},
"allow_squash_merge": {
"type": "boolean",
"x-go-name": "AllowSquash"
},
2018-10-29 06:03:02 +08:00
"archived": {
"type": "boolean",
"x-go-name": "Archived"
},
2019-05-30 10:22:26 +08:00
"avatar_url": {
"type": "string",
"x-go-name": "AvatarURL"
},
2017-05-02 21:35:59 +08:00
"clone_url": {
"type": "string",
"x-go-name": "CloneURL"
},
"created_at": {
2017-11-13 15:02:25 +08:00
"type": "string",
"format": "date-time",
2017-05-02 21:35:59 +08:00
"x-go-name": "Created"
},
"default_branch": {
"type": "string",
"x-go-name": "DefaultBranch"
},
"description": {
"type": "string",
"x-go-name": "Description"
},
2017-05-14 17:37:15 +08:00
"empty": {
"type": "boolean",
"x-go-name": "Empty"
},
2019-10-02 17:30:41 +08:00
"external_tracker": {
" $ ref ": " #/definitions/ExternalTracker"
},
"external_wiki": {
" $ ref ": " #/definitions/ExternalWiki"
},
2017-05-02 21:35:59 +08:00
"fork": {
"type": "boolean",
"x-go-name": "Fork"
},
"forks_count": {
"type": "integer",
"format": "int64",
"x-go-name": "Forks"
},
"full_name": {
"type": "string",
"x-go-name": "FullName"
},
2019-05-30 23:09:05 +08:00
"has_issues": {
"type": "boolean",
"x-go-name": "HasIssues"
},
"has_pull_requests": {
"type": "boolean",
"x-go-name": "HasPullRequests"
},
"has_wiki": {
"type": "boolean",
"x-go-name": "HasWiki"
},
2017-05-02 21:35:59 +08:00
"html_url": {
"type": "string",
"x-go-name": "HTMLURL"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
2019-05-30 23:09:05 +08:00
"ignore_whitespace_conflicts": {
"type": "boolean",
"x-go-name": "IgnoreWhitespaceConflicts"
},
2019-10-02 17:30:41 +08:00
"internal_tracker": {
" $ ref ": " #/definitions/InternalTracker"
},
2017-05-02 21:35:59 +08:00
"mirror": {
"type": "boolean",
"x-go-name": "Mirror"
},
"name": {
"type": "string",
"x-go-name": "Name"
},
"open_issues_count": {
"type": "integer",
"format": "int64",
"x-go-name": "OpenIssues"
},
2019-11-29 23:14:24 +08:00
"open_pr_counter": {
"type": "integer",
"format": "int64",
"x-go-name": "OpenPulls"
},
2019-07-08 10:14:12 +08:00
"original_url": {
"type": "string",
"x-go-name": "OriginalURL"
},
2017-05-02 21:35:59 +08:00
"owner": {
" $ ref ": " #/definitions/User"
},
2017-05-14 17:37:15 +08:00
"parent": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/Repository"
2017-05-14 17:37:15 +08:00
},
2017-05-02 21:35:59 +08:00
"permissions": {
" $ ref ": " #/definitions/Permission"
},
"private": {
"type": "boolean",
"x-go-name": "Private"
},
2019-12-01 03:28:47 +08:00
"release_counter": {
"type": "integer",
"format": "int64",
"x-go-name": "Releases"
},
2017-05-14 17:37:15 +08:00
"size": {
"type": "integer",
"format": "int64",
"x-go-name": "Size"
},
2017-05-02 21:35:59 +08:00
"ssh_url": {
"type": "string",
"x-go-name": "SSHURL"
},
"stars_count": {
"type": "integer",
"format": "int64",
"x-go-name": "Stars"
},
2019-11-11 23:15:29 +08:00
"template": {
"type": "boolean",
"x-go-name": "Template"
},
2017-05-02 21:35:59 +08:00
"updated_at": {
2017-11-13 15:02:25 +08:00
"type": "string",
"format": "date-time",
2017-05-02 21:35:59 +08:00
"x-go-name": "Updated"
},
"watchers_count": {
"type": "integer",
"format": "int64",
"x-go-name": "Watchers"
},
"website": {
"type": "string",
"x-go-name": "Website"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-05-02 21:35:59 +08:00
},
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 13:06:10 +08:00
"RepositoryMeta": {
"description": "RepositoryMeta basic repository information",
"type": "object",
"properties": {
"full_name": {
"type": "string",
"x-go-name": "FullName"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"name": {
"type": "string",
"x-go-name": "Name"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2017-11-13 15:02:25 +08:00
"SearchResults": {
"description": "SearchResults results of a successful search",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Repository"
},
"x-go-name": "Data"
},
"ok": {
"type": "boolean",
"x-go-name": "OK"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"ServerVersion": {
"description": "ServerVersion wraps the version of the server",
"type": "object",
"properties": {
"version": {
"type": "string",
"x-go-name": "Version"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"StateType": {
"description": "StateType issue state type",
"type": "string",
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"Status": {
"description": "Status holds a single Status of a single Commit",
"type": "object",
"properties": {
"context": {
"type": "string",
"x-go-name": "Context"
},
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
"creator": {
" $ ref ": " #/definitions/User"
},
"description": {
"type": "string",
"x-go-name": "Description"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"status": {
" $ ref ": " #/definitions/StatusState"
},
"target_url": {
"type": "string",
"x-go-name": "TargetURL"
},
"updated_at": {
"type": "string",
"format": "date-time",
"x-go-name": "Updated"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
"StatusState": {
"description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
"type": "string",
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-12-12 12:23:05 +08:00
"StopWatch": {
"description": "StopWatch represent a running stopwatch",
"type": "object",
"properties": {
"created": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
"issue_index": {
"type": "integer",
"format": "int64",
"x-go-name": "IssueIndex"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2019-02-07 20:00:52 +08:00
"Tag": {
"description": "Tag represents a repository tag",
"type": "object",
"properties": {
"commit": {
2019-06-08 22:31:11 +08:00
" $ ref ": " #/definitions/CommitMeta"
},
"id": {
"type": "string",
"x-go-name": "ID"
2019-02-07 20:00:52 +08:00
},
"name": {
"type": "string",
"x-go-name": "Name"
},
"tarball_url": {
"type": "string",
"x-go-name": "TarballURL"
},
"zipball_url": {
"type": "string",
"x-go-name": "ZipballURL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-02-07 20:00:52 +08:00
},
2017-11-13 15:02:25 +08:00
"Team": {
"description": "Team represents a team in an organization",
"type": "object",
"properties": {
2019-11-20 19:27:49 +08:00
"can_create_org_repo": {
"type": "boolean",
"x-go-name": "CanCreateOrgRepo"
},
2017-11-13 15:02:25 +08:00
"description": {
"type": "string",
"x-go-name": "Description"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
2019-11-06 17:37:14 +08:00
"includes_all_repositories": {
"type": "boolean",
"x-go-name": "IncludesAllRepositories"
},
2017-11-13 15:02:25 +08:00
"name": {
"type": "string",
"x-go-name": "Name"
},
2019-01-17 08:39:50 +08:00
"organization": {
" $ ref ": " #/definitions/Organization"
},
2017-11-13 15:02:25 +08:00
"permission": {
"type": "string",
"enum": [
"none",
"read",
"write",
"admin",
"owner"
],
"x-go-name": "Permission"
2018-11-11 03:45:32 +08:00
},
"units": {
"type": "array",
2019-08-27 02:13:10 +08:00
"items": {
"type": "string"
},
"x-go-name": "Units",
"example": [
2018-11-11 03:45:32 +08:00
"repo.code",
"repo.issues",
"repo.ext_issues",
"repo.wiki",
"repo.pulls",
"repo.releases",
"repo.ext_wiki"
2019-08-27 02:13:10 +08:00
]
2017-11-13 15:02:25 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2018-10-23 10:57:42 +08:00
"TimeStamp": {
"description": "TimeStamp defines a timestamp",
"type": "integer",
"format": "int64",
2019-08-15 22:46:21 +08:00
"x-go-package": "code.gitea.io/gitea/modules/timeutil"
2018-10-23 10:57:42 +08:00
},
2019-09-03 23:46:24 +08:00
"TopicName": {
"description": "TopicName a list of repo topic names",
"type": "object",
"properties": {
"topics": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "TopicNames"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
"TopicResponse": {
"description": "TopicResponse for returning topics",
"type": "object",
"properties": {
"created": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
"repo_count": {
"type": "integer",
"format": "int64",
"x-go-name": "RepoCount"
},
"topic_name": {
"type": "string",
"x-go-name": "Name"
},
"updated": {
"type": "string",
"format": "date-time",
"x-go-name": "Updated"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
2017-11-13 15:02:25 +08:00
"TrackedTime": {
"description": "TrackedTime worked time for an issue / pr",
"type": "object",
"properties": {
"created": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
"id": {
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
2019-12-28 04:30:58 +08:00
"issue": {
" $ ref ": " #/definitions/Issue"
},
2017-11-13 15:02:25 +08:00
"issue_id": {
2019-12-28 04:30:58 +08:00
"description": "deprecated (only for backwards compatibility)",
2017-11-13 15:02:25 +08:00
"type": "integer",
"format": "int64",
"x-go-name": "IssueID"
},
"time": {
"description": "Time in seconds",
"type": "integer",
"format": "int64",
"x-go-name": "Time"
},
"user_id": {
2019-12-28 04:30:58 +08:00
"description": "deprecated (only for backwards compatibility)",
2017-11-13 15:02:25 +08:00
"type": "integer",
"format": "int64",
"x-go-name": "UserID"
2019-12-28 04:30:58 +08:00
},
"user_name": {
"type": "string",
"x-go-name": "UserName"
2017-11-13 15:02:25 +08:00
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2019-04-18 00:06:35 +08:00
"UpdateFileOptions": {
2019-05-31 01:57:55 +08:00
"description": "UpdateFileOptions options for updating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
2019-04-18 00:06:35 +08:00
"type": "object",
2019-05-31 01:57:55 +08:00
"required": [
"sha",
"content"
],
2019-04-18 00:06:35 +08:00
"properties": {
"author": {
" $ ref ": " #/definitions/Identity"
},
"branch": {
2019-05-31 01:57:55 +08:00
"description": "branch (optional) to base this file from. if not given, the default branch is used",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "BranchName"
},
"committer": {
" $ ref ": " #/definitions/Identity"
},
"content": {
2019-05-31 01:57:55 +08:00
"description": "content must be base64 encoded",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "Content"
},
2019-12-24 10:33:52 +08:00
"dates": {
" $ ref ": " #/definitions/CommitDateOptions"
},
2019-04-18 00:06:35 +08:00
"from_path": {
2019-05-31 01:57:55 +08:00
"description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "FromPath"
},
"message": {
2019-05-31 01:57:55 +08:00
"description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "Message"
},
"new_branch": {
2019-05-31 01:57:55 +08:00
"description": "new_branch (optional) will make a new branch from `branch` before creating the file",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "NewBranchName"
},
"sha": {
2019-05-31 01:57:55 +08:00
"description": "sha is the SHA for the file that already exists",
2019-04-18 00:06:35 +08:00
"type": "string",
"x-go-name": "SHA"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2019-04-18 00:06:35 +08:00
},
2017-05-02 21:35:59 +08:00
"User": {
2017-11-13 15:02:25 +08:00
"description": "User represents a user",
2017-05-02 21:35:59 +08:00
"type": "object",
"properties": {
"avatar_url": {
2017-11-13 15:02:25 +08:00
"description": "URL to the user's avatar",
2017-05-02 21:35:59 +08:00
"type": "string",
"x-go-name": "AvatarURL"
},
2019-06-16 11:28:32 +08:00
"created": {
"type": "string",
"format": "date-time",
"x-go-name": "Created"
},
2017-05-02 21:35:59 +08:00
"email": {
"type": "string",
2017-11-13 15:02:25 +08:00
"format": "email",
2017-05-02 21:35:59 +08:00
"x-go-name": "Email"
},
"full_name": {
2017-11-13 15:02:25 +08:00
"description": "the user's full name",
2017-05-02 21:35:59 +08:00
"type": "string",
"x-go-name": "FullName"
},
"id": {
2017-11-13 15:02:25 +08:00
"description": "the user's id",
2017-05-02 21:35:59 +08:00
"type": "integer",
"format": "int64",
"x-go-name": "ID"
},
2019-03-04 06:57:24 +08:00
"is_admin": {
"description": "Is the user an administrator",
"type": "boolean",
"x-go-name": "IsAdmin"
},
2018-05-05 08:28:30 +08:00
"language": {
"description": "User locale",
"type": "string",
"x-go-name": "Language"
},
2019-06-16 11:28:32 +08:00
"last_login": {
"type": "string",
"format": "date-time",
"x-go-name": "LastLogin"
},
2017-05-02 21:35:59 +08:00
"login": {
2017-11-13 15:02:25 +08:00
"description": "the user's username",
2017-05-02 21:35:59 +08:00
"type": "string",
"x-go-name": "UserName"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-11-13 15:02:25 +08:00
},
2018-10-23 10:57:42 +08:00
"UserHeatmapData": {
"description": "UserHeatmapData represents the data needed to create a heatmap",
"type": "object",
"properties": {
"contributions": {
"type": "integer",
"format": "int64",
"x-go-name": "Contributions"
},
"timestamp": {
" $ ref ": " #/definitions/TimeStamp"
}
},
"x-go-package": "code.gitea.io/gitea/models"
},
2017-11-13 15:02:25 +08:00
"WatchInfo": {
"description": "WatchInfo represents an API watch status of one repository",
"type": "object",
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"x-go-name": "CreatedAt"
},
"ignored": {
"type": "boolean",
"x-go-name": "Ignored"
},
"reason": {
"type": "object",
"x-go-name": "Reason"
},
"repository_url": {
"type": "string",
"x-go-name": "RepositoryURL"
},
"subscribed": {
"type": "boolean",
"x-go-name": "Subscribed"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
2019-05-11 18:21:34 +08:00
"x-go-package": "code.gitea.io/gitea/modules/structs"
2017-05-02 21:35:59 +08:00
}
},
"responses": {
"AccessToken": {
2019-05-04 23:45:34 +08:00
"description": "AccessToken represents an API access token.",
2017-05-02 21:35:59 +08:00
"headers": {
2018-07-07 09:54:30 +08:00
"id": {
"type": "integer",
"format": "int64"
},
2017-05-02 21:35:59 +08:00
"name": {
"type": "string"
},
2019-05-11 04:49:29 +08:00
"sha1": {
2019-05-04 23:45:34 +08:00
"type": "string"
},
"token_last_eight": {
2017-05-02 21:35:59 +08:00
"type": "string"
}
}
},
"AccessTokenList": {
2019-08-28 14:55:22 +08:00
"description": "AccessTokenList represents a list of API access token.",
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/AccessToken"
}
}
2017-05-02 21:35:59 +08:00
},
2019-06-08 22:31:11 +08:00
"AnnotatedTag": {
"description": "AnnotatedTag",
"schema": {
" $ ref ": " #/definitions/AnnotatedTag"
}
},
2018-03-06 09:22:16 +08:00
"Attachment": {
2018-05-31 19:13:55 +08:00
"description": "Attachment",
2018-03-06 09:22:16 +08:00
"schema": {
" $ ref ": " #/definitions/Attachment"
}
},
"AttachmentList": {
2018-05-31 19:13:55 +08:00
"description": "AttachmentList",
2018-03-06 09:22:16 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Attachment"
}
}
},
2017-11-13 15:02:25 +08:00
"Branch": {
2018-05-31 19:13:55 +08:00
"description": "Branch",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/Branch"
}
},
"BranchList": {
2018-05-31 19:13:55 +08:00
"description": "BranchList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Branch"
}
}
},
"Comment": {
2018-05-31 19:13:55 +08:00
"description": "Comment",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/Comment"
}
},
"CommentList": {
2018-05-31 19:13:55 +08:00
"description": "CommentList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Comment"
}
}
},
2019-02-03 11:35:17 +08:00
"Commit": {
"description": "Commit",
"schema": {
" $ ref ": " #/definitions/Commit"
}
},
2019-08-26 22:09:10 +08:00
"CommitList": {
"description": "CommitList",
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Commit"
}
},
"headers": {
"X-HasMore": {
"type": "boolean",
"description": "True if there is another page"
},
"X-Page": {
"type": "integer",
"format": "int64",
"description": "The current page"
},
"X-PageCount": {
"type": "integer",
"format": "int64",
"description": "Total number of pages"
},
"X-PerPage": {
"type": "integer",
"format": "int64",
"description": "Commits per page"
},
"X-Total": {
"type": "integer",
"format": "int64",
"description": "Total commit count"
}
}
},
2019-06-30 04:51:10 +08:00
"ContentsListResponse": {
"description": "ContentsListResponse",
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/ContentsResponse"
}
}
},
"ContentsResponse": {
"description": "ContentsResponse",
"schema": {
" $ ref ": " #/definitions/ContentsResponse"
}
},
2017-11-13 15:02:25 +08:00
"DeployKey": {
2018-05-31 19:13:55 +08:00
"description": "DeployKey",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/DeployKey"
}
},
"DeployKeyList": {
2018-05-31 19:13:55 +08:00
"description": "DeployKeyList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/DeployKey"
}
}
},
"EmailList": {
2018-05-31 19:13:55 +08:00
"description": "EmailList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Email"
2017-05-02 21:35:59 +08:00
}
}
},
2019-08-26 22:09:10 +08:00
"EmptyRepository": {
"description": "EmptyRepository",
"schema": {
" $ ref ": " #/definitions/APIError"
}
},
2019-04-18 00:06:35 +08:00
"FileDeleteResponse": {
"description": "FileDeleteResponse",
"schema": {
" $ ref ": " #/definitions/FileDeleteResponse"
}
},
"FileResponse": {
"description": "FileResponse",
"schema": {
" $ ref ": " #/definitions/FileResponse"
}
},
2017-11-13 15:02:25 +08:00
"GPGKey": {
2018-05-31 19:13:55 +08:00
"description": "GPGKey",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/GPGKey"
}
},
2017-05-02 21:35:59 +08:00
"GPGKeyList": {
2018-05-31 19:13:55 +08:00
"description": "GPGKeyList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/GPGKey"
}
}
2017-05-02 21:35:59 +08:00
},
2019-04-18 00:06:35 +08:00
"GitBlobResponse": {
"description": "GitBlobResponse",
"schema": {
" $ ref ": " #/definitions/GitBlobResponse"
}
},
2019-04-17 13:31:08 +08:00
"GitHook": {
"description": "GitHook",
"schema": {
" $ ref ": " #/definitions/GitHook"
}
},
"GitHookList": {
"description": "GitHookList",
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/GitHook"
}
}
},
2019-01-25 02:13:30 +08:00
"GitTreeResponse": {
"description": "GitTreeResponse",
"schema": {
" $ ref ": " #/definitions/GitTreeResponse"
}
},
2017-08-21 19:13:47 +08:00
"Hook": {
2018-05-31 19:13:55 +08:00
"description": "Hook",
2017-08-21 19:13:47 +08:00
"schema": {
2019-03-27 03:41:17 +08:00
" $ ref ": " #/definitions/Hook"
2017-08-21 19:13:47 +08:00
}
},
"HookList": {
2018-05-31 19:13:55 +08:00
"description": "HookList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
2019-03-27 03:41:17 +08:00
" $ ref ": " #/definitions/Hook"
2017-11-13 15:02:25 +08:00
}
}
},
"Issue": {
2018-05-31 19:13:55 +08:00
"description": "Issue",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/Issue"
}
},
2018-07-16 20:43:00 +08:00
"IssueDeadline": {
"description": "IssueDeadline",
"schema": {
" $ ref ": " #/definitions/IssueDeadline"
}
},
2017-11-13 15:02:25 +08:00
"IssueList": {
2018-05-31 19:13:55 +08:00
"description": "IssueList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Issue"
}
}
},
"Label": {
2018-05-31 19:13:55 +08:00
"description": "Label",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/Label"
}
},
"LabelList": {
2018-05-31 19:13:55 +08:00
"description": "LabelList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Label"
}
}
2017-08-21 19:13:47 +08:00
},
2017-05-02 21:35:59 +08:00
"MarkdownRender": {
2019-08-28 14:55:22 +08:00
"description": "MarkdownRender is a rendered markdown document",
"schema": {
"type": "string"
}
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"Milestone": {
2018-05-31 19:13:55 +08:00
"description": "Milestone",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/Milestone"
}
},
"MilestoneList": {
2018-05-31 19:13:55 +08:00
"description": "MilestoneList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Milestone"
}
}
},
2020-01-14 23:37:19 +08:00
"NotificationCount": {
"description": "Number of unread notifications",
"schema": {
" $ ref ": " #/definitions/NotificationCount"
}
},
2020-01-09 19:56:32 +08:00
"NotificationThread": {
"description": "NotificationThread",
"schema": {
" $ ref ": " #/definitions/NotificationThread"
}
},
"NotificationThreadList": {
"description": "NotificationThreadList",
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/NotificationThread"
}
}
},
2017-08-21 19:13:47 +08:00
"Organization": {
2018-05-31 19:13:55 +08:00
"description": "Organization",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/Organization"
}
},
"OrganizationList": {
2018-05-31 19:13:55 +08:00
"description": "OrganizationList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Organization"
2017-08-21 19:13:47 +08:00
}
}
},
2017-05-02 21:35:59 +08:00
"PublicKey": {
2018-05-31 19:13:55 +08:00
"description": "PublicKey",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/PublicKey"
2017-05-02 21:35:59 +08:00
}
},
"PublicKeyList": {
2018-05-31 19:13:55 +08:00
"description": "PublicKeyList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/PublicKey"
}
}
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"PullRequest": {
2018-05-31 19:13:55 +08:00
"description": "PullRequest",
2017-05-02 21:35:59 +08:00
"schema": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/PullRequest"
}
},
"PullRequestList": {
2018-05-31 19:13:55 +08:00
"description": "PullRequestList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/PullRequest"
2017-05-02 21:35:59 +08:00
}
}
},
2019-12-31 16:21:21 +08:00
"Reaction": {
"description": "Reaction",
2019-12-08 06:04:19 +08:00
"schema": {
2019-12-31 16:21:21 +08:00
" $ ref ": " #/definitions/Reaction"
2019-12-08 06:04:19 +08:00
}
},
2019-12-31 16:21:21 +08:00
"ReactionList": {
"description": "ReactionList",
2019-12-08 06:04:19 +08:00
"schema": {
"type": "array",
"items": {
2019-12-31 16:21:21 +08:00
" $ ref ": " #/definitions/Reaction"
2019-12-08 06:04:19 +08:00
}
}
},
2018-11-28 05:52:20 +08:00
"Reference": {
"description": "Reference",
"schema": {
" $ ref ": " #/definitions/Reference"
}
},
"ReferenceList": {
"description": "ReferenceList",
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Reference"
}
}
},
2017-11-13 15:02:25 +08:00
"Release": {
2018-05-31 19:13:55 +08:00
"description": "Release",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/Release"
}
2017-05-02 21:35:59 +08:00
},
2017-11-13 15:02:25 +08:00
"ReleaseList": {
2018-05-31 19:13:55 +08:00
"description": "ReleaseList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Release"
}
}
},
"Repository": {
2018-05-31 19:13:55 +08:00
"description": "Repository",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/Repository"
}
},
"RepositoryList": {
2018-05-31 19:13:55 +08:00
"description": "RepositoryList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Repository"
2017-05-02 21:35:59 +08:00
}
}
},
"SearchResults": {
2018-05-31 19:13:55 +08:00
"description": "SearchResults",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/SearchResults"
2017-05-02 21:35:59 +08:00
}
},
"ServerVersion": {
2018-05-31 19:13:55 +08:00
"description": "ServerVersion",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/ServerVersion"
}
},
"Status": {
2018-05-31 19:13:55 +08:00
"description": "Status",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/Status"
}
},
"StatusList": {
2018-05-31 19:13:55 +08:00
"description": "StatusList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Status"
2017-05-02 21:35:59 +08:00
}
}
},
2019-12-12 12:23:05 +08:00
"StopWatch": {
"description": "StopWatch",
"schema": {
" $ ref ": " #/definitions/StopWatch"
}
},
"StopWatchList": {
"description": "StopWatchList",
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/StopWatch"
}
}
},
2019-06-08 22:31:11 +08:00
"Tag": {
"description": "Tag",
"schema": {
" $ ref ": " #/definitions/Tag"
}
},
2019-02-07 20:00:52 +08:00
"TagList": {
"description": "TagList",
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Tag"
}
}
},
2017-11-13 15:02:25 +08:00
"Team": {
2018-05-31 19:13:55 +08:00
"description": "Team",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/Team"
}
},
"TeamList": {
2018-05-31 19:13:55 +08:00
"description": "TeamList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/Team"
2017-08-21 19:13:47 +08:00
}
}
},
2019-09-03 23:46:24 +08:00
"TopicListResponse": {
"description": "TopicListResponse",
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/TopicResponse"
}
}
},
"TopicNames": {
"description": "TopicNames",
"schema": {
" $ ref ": " #/definitions/TopicName"
}
},
2017-11-13 15:02:25 +08:00
"TrackedTime": {
2018-05-31 19:13:55 +08:00
"description": "TrackedTime",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/TrackedTime"
}
2017-08-21 19:13:47 +08:00
},
2017-11-13 15:02:25 +08:00
"TrackedTimeList": {
2018-05-31 19:13:55 +08:00
"description": "TrackedTimeList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/TrackedTime"
2017-05-02 21:35:59 +08:00
}
}
},
2017-11-13 15:02:25 +08:00
"User": {
2018-05-31 19:13:55 +08:00
"description": "User",
2017-11-13 15:02:25 +08:00
"schema": {
" $ ref ": " #/definitions/User"
}
},
2018-10-23 10:57:42 +08:00
"UserHeatmapData": {
"description": "UserHeatmapData",
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/UserHeatmapData"
}
}
},
2017-05-02 21:35:59 +08:00
"UserList": {
2018-05-31 19:13:55 +08:00
"description": "UserList",
2017-11-13 15:02:25 +08:00
"schema": {
"type": "array",
"items": {
" $ ref ": " #/definitions/User"
}
}
2017-05-02 21:35:59 +08:00
},
"WatchInfo": {
2018-05-31 19:13:55 +08:00
"description": "WatchInfo",
2017-05-02 21:35:59 +08:00
"schema": {
2017-11-13 15:02:25 +08:00
" $ ref ": " #/definitions/WatchInfo"
2017-05-02 21:35:59 +08:00
}
},
"empty": {
2017-05-18 22:39:42 +08:00
"description": "APIEmpty is an empty response"
2017-05-02 21:35:59 +08:00
},
"error": {
"description": "APIError is error format response",
"headers": {
"message": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"forbidden": {
"description": "APIForbiddenError is a forbidden error response",
"headers": {
"message": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
2019-12-21 01:07:12 +08:00
"invalidTopicsError": {
"description": "APIInvalidTopicsError is error format response to invalid topics",
"headers": {
"invalidTopics": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
}
}
},
2017-05-02 21:35:59 +08:00
"notFound": {
"description": "APINotFound is a not found empty response"
},
2017-11-13 15:02:25 +08:00
"parameterBodies": {
2018-05-31 19:13:55 +08:00
"description": "parameterBodies",
2017-11-13 15:02:25 +08:00
"schema": {
2019-12-31 16:21:21 +08:00
" $ ref ": " #/definitions/EditReactionOption"
2017-11-13 15:02:25 +08:00
}
},
2017-08-21 19:13:47 +08:00
"redirect": {
"description": "APIRedirect is a redirect response"
},
2017-05-02 21:35:59 +08:00
"validationError": {
"description": "APIValidationError is error format response related to input validation",
"headers": {
"message": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
2017-08-21 19:13:47 +08:00
},
"securityDefinitions": {
"AccessToken": {
"type": "apiKey",
"name": "access_token",
"in": "query"
},
"AuthorizationHeaderToken": {
2019-07-24 16:34:11 +08:00
"description": "API tokens must be prepended with \"token\" followed by a space.",
2017-08-21 19:13:47 +08:00
"type": "apiKey",
"name": "Authorization",
"in": "header"
},
"BasicAuth": {
"type": "basic"
},
2018-09-07 11:31:29 +08:00
"SudoHeader": {
"description": "Sudo API request as the user provided as the key. Admin privileges are required.",
"type": "apiKey",
"name": "Sudo",
"in": "header"
},
"SudoParam": {
"description": "Sudo API request as the user provided as the key. Admin privileges are required.",
"type": "apiKey",
"name": "sudo",
"in": "query"
},
2017-08-21 19:13:47 +08:00
"Token": {
"type": "apiKey",
"name": "token",
"in": "query"
}
},
"security": [
{
2018-06-13 07:23:00 +08:00
"BasicAuth": []
2017-08-21 19:13:47 +08:00
},
{
2018-06-13 07:23:00 +08:00
"Token": []
2017-08-21 19:13:47 +08:00
},
{
2018-06-13 07:23:00 +08:00
"AccessToken": []
2017-08-21 19:13:47 +08:00
},
{
2018-06-13 07:23:00 +08:00
"AuthorizationHeaderToken": []
2018-09-07 11:31:29 +08:00
},
{
"SudoParam": []
},
{
"SudoHeader": []
2017-08-21 19:13:47 +08:00
}
]
2019-04-01 23:27:40 +08:00
}
