2017-05-02 16:35:59 +03:00
{
"consumes" : [
"application/json" ,
"text/plain"
] ,
"produces" : [
"application/json" ,
"text/html"
] ,
"schemes" : [
"http" ,
"https"
] ,
"swagger" : "2.0" ,
"info" : {
2017-11-13 10:02:25 +03:00
"description" : "This documentation describes the Gitea API." ,
2017-05-02 16:35:59 +03:00
"title" : "Gitea API." ,
"license" : {
"name" : "MIT" ,
"url" : "http://opensource.org/licenses/MIT"
} ,
"version" : "1.1.1"
} ,
"basePath" : "/api/v1" ,
"paths" : {
2017-08-21 14:13:47 +03:00
"/admin/users" : {
2017-05-02 16:35:59 +03:00
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
2017-08-21 14:13:47 +03:00
"application/json"
2017-05-02 16:35:59 +03:00
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
"admin"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Create a user" ,
2017-08-21 14:13:47 +03:00
"operationId" : "adminCreateUser" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-05-02 16:35:59 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-08-21 14:13:47 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/CreateUserOption"
2017-08-21 14:13:47 +03:00
}
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/User"
} ,
"403" : {
"$ref" : "#/responses/forbidden"
} ,
"422" : {
"$ref" : "#/responses/validationError"
}
}
}
} ,
"/admin/users/{username}" : {
"delete" : {
"produces" : [
"application/json"
] ,
"tags" : [
"admin"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Delete a user" ,
2017-08-21 14:13:47 +03:00
"operationId" : "adminDeleteUser" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "username of user to delete" ,
"name" : "username" ,
"in" : "path" ,
"required" : true
}
] ,
2017-08-21 14:13:47 +03: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 10:02:25 +03:00
"summary" : "Edit an existing user" ,
2017-08-21 14:13:47 +03:00
"operationId" : "adminEditUser" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "username of user to edit" ,
"name" : "username" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-08-21 14:13:47 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/EditUserOption"
2017-08-21 14:13:47 +03:00
}
2017-05-02 16:35:59 +03:00
}
] ,
"responses" : {
"200" : {
2017-08-21 14:13:47 +03:00
"$ref" : "#/responses/User"
} ,
"403" : {
"$ref" : "#/responses/forbidden"
2017-05-02 16:35:59 +03:00
} ,
"422" : {
"$ref" : "#/responses/validationError"
}
}
}
} ,
2017-08-21 14:13:47 +03:00
"/admin/users/{username}/keys" : {
2017-05-02 16:35:59 +03:00
"post" : {
"consumes" : [
2017-08-21 14:13:47 +03:00
"application/json"
2017-05-02 16:35:59 +03:00
] ,
"produces" : [
2017-08-21 14:13:47 +03:00
"application/json"
] ,
"tags" : [
"admin"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Add a public key on behalf of a user" ,
2017-08-21 14:13:47 +03:00
"operationId" : "adminCreatePublicKey" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "username of the user" ,
"name" : "username" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
}
2017-05-02 16:35:59 +03:00
] ,
"responses" : {
2017-08-21 14:13:47 +03:00
"201" : {
"$ref" : "#/responses/PublicKey"
} ,
"403" : {
"$ref" : "#/responses/forbidden"
} ,
"422" : {
"$ref" : "#/responses/validationError"
}
}
}
} ,
2017-12-06 13:27:10 +03:00
"/admin/users/{username}/keys/{id}" : {
"delete" : {
"produces" : [
"application/json"
] ,
"tags" : [
"admin"
] ,
"summary" : "Delete a user's public key" ,
"operationId" : "adminDeleteUserPublicKey" ,
"security" : null ,
"parameters" : [
{
"type" : "string" ,
"description" : "username of user" ,
"name" : "username" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"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 14:13:47 +03:00
"/admin/users/{username}/orgs" : {
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"admin"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Create an organization" ,
2017-08-21 14:13:47 +03:00
"operationId" : "adminCreateOrg" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "username of the user that will own the created organization" ,
2017-08-21 14:13:47 +03:00
"name" : "username" ,
2017-11-13 10:02:25 +03:00
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/Organization"
} ,
"403" : {
"$ref" : "#/responses/forbidden"
2017-05-02 16:35:59 +03:00
} ,
"422" : {
"$ref" : "#/responses/validationError"
}
}
}
} ,
2017-08-21 14:13:47 +03:00
"/admin/users/{username}/repos" : {
2017-05-02 16:35:59 +03:00
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
"admin"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Create a repository on behalf a user" ,
2017-08-21 14:13:47 +03:00
"operationId" : "adminCreateRepo" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-05-02 16:35:59 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "username of the user. This user will own the created repository" ,
"name" : "username" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/Repository"
} ,
"403" : {
"$ref" : "#/responses/forbidden"
} ,
"422" : {
"$ref" : "#/responses/validationError"
}
}
}
} ,
2017-08-21 14:13:47 +03:00
"/markdown" : {
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"text/html"
] ,
"tags" : [
"miscellaneous"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Render a markdown document as HTML" ,
2017-08-21 14:13:47 +03:00
"operationId" : "renderMarkdown" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-08-21 14:13:47 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/MarkdownOption"
2017-08-21 14:13:47 +03:00
}
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/MarkdownRender"
} ,
"422" : {
"$ref" : "#/responses/validationError"
}
}
}
} ,
"/markdown/raw" : {
"post" : {
"consumes" : [
"text/plain"
] ,
"produces" : [
"text/html"
] ,
"tags" : [
"miscellaneous"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Render raw markdown as HTML" ,
2017-08-21 14:13:47 +03:00
"operationId" : "renderMarkdownRaw" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"name" : "body" ,
"in" : "body"
}
] ,
2017-08-21 14:13:47 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/MarkdownRender"
} ,
"422" : {
"$ref" : "#/responses/validationError"
}
}
}
} ,
"/org/{org}/repos" : {
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Create a repository in an organization" ,
2017-08-21 14:13:47 +03:00
"operationId" : "createOrgRepo" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "name of organization" ,
"name" : "org" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-08-21 14:13:47 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/CreateRepoOption"
2017-08-21 14:13:47 +03:00
}
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/Repository"
} ,
"403" : {
"$ref" : "#/responses/forbidden"
} ,
"422" : {
"$ref" : "#/responses/validationError"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/orgs/{org}" : {
2017-08-21 14:13:47 +03:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Get an organization" ,
"operationId" : "orgGet" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "name of the organization to get" ,
"name" : "org" ,
"in" : "path" ,
"required" : true
}
] ,
2017-08-21 14:13:47 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Organization"
2017-08-21 14:13:47 +03:00
}
}
2017-11-13 10:02:25 +03:00
} ,
"patch" : {
2017-08-21 14:13:47 +03:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Edit an organization" ,
"operationId" : "orgEdit" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "name of the organization to edit" ,
"name" : "org" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-08-21 14:13:47 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/EditOrgOption"
2017-08-21 14:13:47 +03:00
}
}
] ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/Organization"
}
}
}
} ,
"/orgs/{org}/hooks" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
"summary" : "List an organization's webhooks" ,
"operationId" : "orgListHooks" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/HookList"
}
}
}
} ,
"/orgs/{org}/hooks/" : {
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
"summary" : "Create a hook" ,
"operationId" : "orgCreateHook" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"responses" : {
"201" : {
"$ref" : "#/responses/Hook"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/orgs/{org}/hooks/{id}" : {
2017-08-21 14:13:47 +03:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Get a hook" ,
2017-08-21 14:13:47 +03:00
"operationId" : "orgGetHook" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/Hook"
}
}
} ,
"delete" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Delete a hook" ,
2017-08-21 14:13:47 +03:00
"operationId" : "orgDeleteHook" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
}
}
} ,
"patch" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Update a hook" ,
2017-08-21 14:13:47 +03:00
"operationId" : "orgEditHook" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/Hook"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/orgs/{org}/members" : {
2017-08-21 14:13:47 +03:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List an organization's members" ,
2017-08-21 14:13:47 +03:00
"operationId" : "orgListMembers" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "name of the organization" ,
"name" : "org" ,
"in" : "path" ,
"required" : true
}
] ,
2017-08-21 14:13:47 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/UserList"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/orgs/{org}/members/{username}" : {
2017-08-21 14:13:47 +03:00
"get" : {
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Check if a user is a member of an organization" ,
2017-08-21 14:13:47 +03:00
"operationId" : "orgIsMember" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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 14:13:47 +03:00
"responses" : {
"204" : {
2017-11-13 10:02:25 +03:00
"description" : "user is a member" ,
"schema" : {
"$ref" : "#/responses/empty"
}
2017-08-21 14:13:47 +03:00
} ,
"404" : {
2017-11-13 10:02:25 +03:00
"description" : "user is not a member" ,
"schema" : {
"$ref" : "#/responses/empty"
}
2017-08-21 14:13:47 +03:00
}
}
} ,
"delete" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Remove a member from an organization" ,
2017-08-21 14:13:47 +03:00
"operationId" : "orgDeleteMember" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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 14:13:47 +03:00
"responses" : {
"204" : {
2017-11-13 10:02:25 +03:00
"description" : "member removed" ,
"schema" : {
"$ref" : "#/responses/empty"
}
2017-08-21 14:13:47 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/orgs/{org}/public_members" : {
2017-08-21 14:13:47 +03:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List an organization's public members" ,
2017-08-21 14:13:47 +03:00
"operationId" : "orgListPublicMembers" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "name of the organization" ,
"name" : "org" ,
"in" : "path" ,
"required" : true
}
] ,
2017-08-21 14:13:47 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/UserList"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/orgs/{org}/public_members/{username}" : {
2017-08-21 14:13:47 +03:00
"get" : {
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Check if a user is a public member of an organization" ,
2017-08-21 14:13:47 +03:00
"operationId" : "orgIsPublicMember" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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 14:13:47 +03:00
"responses" : {
"204" : {
2017-11-13 10:02:25 +03:00
"description" : "user is a public member" ,
"schema" : {
"$ref" : "#/responses/empty"
}
2017-08-21 14:13:47 +03:00
} ,
"404" : {
2017-11-13 10:02:25 +03:00
"description" : "user is not a public member" ,
"schema" : {
"$ref" : "#/responses/empty"
}
2017-08-21 14:13:47 +03:00
}
}
} ,
"put" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Publicize a user's membership" ,
2017-08-21 14:13:47 +03:00
"operationId" : "orgPublicizeMember" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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 14:13:47 +03:00
"responses" : {
"204" : {
2017-11-13 10:02:25 +03:00
"description" : "membership publicized" ,
"schema" : {
"$ref" : "#/responses/empty"
}
2017-08-21 14:13:47 +03:00
}
}
} ,
"delete" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Conceal a user's membership" ,
2017-08-21 14:13:47 +03:00
"operationId" : "orgConcealMember" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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 14:13:47 +03:00
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/orgs/{org}/repos" : {
2017-08-21 14:13:47 +03:00
"get" : {
"produces" : [
2017-07-13 14:14:15 +03:00
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
"organization"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List an organization's repos" ,
2017-07-13 14:14:15 +03:00
"operationId" : "orgListRepos" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "name of the organization" ,
"name" : "org" ,
"in" : "path" ,
"required" : true
}
] ,
2017-07-13 14:14:15 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/RepositoryList"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/orgs/{org}/teams" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
"summary" : "List an organization's teams" ,
"operationId" : "orgListTeams" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "name of the organization" ,
"name" : "org" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/TeamList"
}
}
} ,
2017-08-21 14:13:47 +03:00
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2017-11-13 10:02:25 +03:00
"organization"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Create a team" ,
"operationId" : "orgCreateTeam" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "name of the organization" ,
"name" : "org" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-08-21 14:13:47 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/CreateTeamOption"
2017-08-21 14:13:47 +03:00
}
2017-11-13 10:02:25 +03:00
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/Team"
}
}
}
} ,
"/repos/migrate" : {
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Migrate a remote git repository" ,
"operationId" : "repoMigrate" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
2017-08-21 14:13:47 +03:00
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-08-21 14:13:47 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/MigrateRepoForm"
2017-08-21 14:13:47 +03:00
}
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/Repository"
}
}
}
} ,
2017-05-02 16:35:59 +03:00
"/repos/search" : {
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Search for repositories" ,
2017-05-02 16:35:59 +03:00
"operationId" : "repoSearch" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-05-02 16:35:59 +03:00
"parameters" : [
{
"type" : "string" ,
2017-11-13 10:02:25 +03:00
"description" : "keyword" ,
2017-05-02 16:35:59 +03:00
"name" : "q" ,
"in" : "query"
} ,
{
"type" : "integer" ,
2017-11-15 11:10:26 +03:00
"description" : "search only for repos that the user with the given id owns or contributes to" ,
2017-05-02 16:35:59 +03:00
"name" : "uid" ,
"in" : "query"
} ,
{
"type" : "integer" ,
2017-11-15 11:10:26 +03: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 16:35:59 +03:00
"name" : "limit" ,
"in" : "query"
2017-10-27 00:16:13 +03:00
} ,
{
"type" : "string" ,
2017-11-13 10:02:25 +03:00
"description" : "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"" ,
2017-10-27 00:16:13 +03:00
"name" : "mode" ,
"in" : "query"
} ,
{
"type" : "boolean" ,
2017-11-15 11:10:26 +03:00
"description" : "if `uid` is given, search only for repos that the user owns" ,
2017-10-27 00:16:13 +03:00
"name" : "exclusive" ,
"in" : "query"
2017-05-02 16:35:59 +03:00
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/SearchResults"
} ,
2017-10-27 00:16:13 +03:00
"422" : {
"$ref" : "#/responses/validationError"
2017-08-21 14:13:47 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}" : {
2017-08-21 14:13:47 +03:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Get a repository" ,
"operationId" : "repoGet" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
] ,
2017-08-21 14:13:47 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Repository"
2017-08-21 14:13:47 +03:00
}
}
} ,
2017-11-13 10:02:25 +03:00
"delete" : {
2017-08-21 14:13:47 +03:00
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Delete a repository" ,
"operationId" : "repoDelete" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03: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 14:13:47 +03:00
}
] ,
"responses" : {
2017-11-13 10:02:25 +03:00
"204" : {
"$ref" : "#/responses/empty"
2017-08-21 14:13:47 +03:00
} ,
"403" : {
"$ref" : "#/responses/forbidden"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/archive/{filepath}" : {
2017-08-21 14:13:47 +03:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Get an archive of a repository" ,
"operationId" : "repoGetArchive" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
2017-11-13 10:02:25 +03: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 14:13:47 +03:00
}
2017-11-13 10:02:25 +03:00
] ,
"responses" : {
"200" : { }
2017-08-21 14:13:47 +03:00
}
2017-11-13 10:02:25 +03:00
}
} ,
"/repos/{owner}/{repo}/branches" : {
"get" : {
2017-08-21 14:13:47 +03:00
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List a repository's branches" ,
"operationId" : "repoListBranches" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/BranchList"
2017-08-21 14:13:47 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/branches/{branch}" : {
2017-08-21 14:13:47 +03:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List a repository's branches" ,
"operationId" : "repoGetBranch" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : "branch to get" ,
"name" : "branch" ,
"in" : "path" ,
"required" : true
}
] ,
2017-08-21 14:13:47 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Branch"
2017-08-21 14:13:47 +03:00
}
}
2017-11-13 10:02:25 +03:00
}
} ,
"/repos/{owner}/{repo}/collaborators" : {
"get" : {
2017-08-21 14:13:47 +03:00
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List a repository's collaborators" ,
"operationId" : "repoListCollaborators" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
}
] ,
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/UserList"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/collaborators/{collaborator}" : {
"get" : {
2017-06-12 03:59:51 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Check if a user is a collaborator of a repository" ,
"operationId" : "repoCheckCollaborator" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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 the collaborator" ,
"name" : "collaborator" ,
"in" : "path" ,
"required" : true
}
] ,
2017-06-12 03:59:51 +03:00
"responses" : {
2017-08-21 14:13:47 +03:00
"204" : {
"$ref" : "#/responses/empty"
} ,
"404" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/empty"
2017-06-12 03:59:51 +03:00
}
}
} ,
2017-11-13 10:02:25 +03:00
"put" : {
2017-06-12 03:59:51 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Add a collaborator to a repository" ,
"operationId" : "repoAddCollaborator" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-06-12 03:59:51 +03:00
} ,
2017-08-21 14:13:47 +03:00
{
2017-11-13 10:02:25 +03: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 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-08-21 14:13:47 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/AddCollaboratorOption"
2017-08-21 14:13:47 +03:00
}
}
] ,
"responses" : {
2017-11-13 10:02:25 +03:00
"204" : {
"$ref" : "#/responses/empty"
2017-06-12 03:59:51 +03:00
}
}
2017-11-13 10:02:25 +03:00
} ,
"delete" : {
2017-09-12 09:48:13 +03:00
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Delete a collaborator from a repository" ,
"operationId" : "repoDeleteCollaborator" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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 the collaborator to delete" ,
"name" : "collaborator" ,
"in" : "path" ,
"required" : true
}
] ,
2017-09-12 09:48:13 +03:00
"responses" : {
2017-11-13 10:02:25 +03:00
"204" : {
"$ref" : "#/responses/empty"
}
}
}
} ,
"/repos/{owner}/{repo}/commits/{ref}/statuses" : {
"get" : {
2017-05-19 03:20:06 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Get a commit's combined status, by branch/tag/commit reference" ,
"operationId" : "repoGetCombinedStatusByRef" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : "name of branch/tag/commit" ,
"name" : "ref" ,
"in" : "path" ,
"required" : true
}
] ,
2017-05-19 03:20:06 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Status"
2017-05-19 03:20:06 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/editorconfig/{filepath}" : {
2017-05-02 16:35:59 +03:00
"get" : {
2017-11-13 10:02:25 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Get the EditorConfig definitions of a file in a repository" ,
"operationId" : "repoGetEditorConfig" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "filepath of file to get" ,
"name" : "filepath" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
2017-11-13 10:02:25 +03:00
"200" : { }
2017-05-02 16:35:59 +03:00
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/forks" : {
2017-09-12 09:48:13 +03:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List a repository's forks" ,
"operationId" : "listForks" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
] ,
2017-09-12 09:48:13 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/RepositoryList"
2017-09-12 09:48:13 +03:00
}
}
2017-11-13 10:02:25 +03:00
} ,
"post" : {
2017-09-12 09:48:13 +03:00
"produces" : [
"application/json"
] ,
"tags" : [
2017-11-13 10:02:25 +03:00
"repository"
2017-09-12 09:48:13 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Fork a repository" ,
"operationId" : "createFork" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo to fork" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-09-12 09:48:13 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo to fork" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
2017-09-12 09:48:13 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"name" : "body" ,
"in" : "body" ,
"schema" : {
"$ref" : "#/definitions/CreateForkOption"
}
}
] ,
"responses" : {
"202" : {
"$ref" : "#/responses/Repository"
2017-09-12 09:48:13 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/hooks" : {
2017-08-21 14:13:47 +03:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List the hooks in a repository" ,
"operationId" : "repoListHooks" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
] ,
2017-08-21 14:13:47 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/HookList"
2017-08-21 14:13:47 +03:00
}
}
2017-11-13 10:02:25 +03:00
} ,
"post" : {
"consumes" : [
"application/json"
] ,
2017-05-02 16:35:59 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"repository"
] ,
"summary" : "Create a hook" ,
"operationId" : "repoCreateHook" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : {
"$ref" : "#/definitions/CreateHookOption"
}
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
2017-11-20 10:00:53 +03:00
"201" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Hook"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/hooks/{id}" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"repository"
] ,
"summary" : "Get a hook" ,
"operationId" : "repoGetHook" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "id of the hook to get" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Hook"
2017-05-02 16:35:59 +03:00
}
}
2017-11-13 10:02:25 +03:00
} ,
"patch" : {
2017-05-02 16:35:59 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"repository"
] ,
"summary" : "Edit a hook in a repository" ,
"operationId" : "repoEditHook" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : {
"$ref" : "#/definitions/EditHookOption"
}
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Hook"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/issue/{index}/comments" : {
2017-05-02 16:35:59 +03:00
"get" : {
2017-11-13 10:02:25 +03:00
"produces" : [
"application/json"
2017-08-21 14:13:47 +03:00
] ,
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List all comments on an issue" ,
"operationId" : "issueGetComments" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "index of the issue" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "if provided, only comments updated since the specified time are returned." ,
"name" : "string" ,
"in" : "query"
2017-05-02 16:35:59 +03:00
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
2017-11-13 10:02:25 +03:00
"200" : {
"$ref" : "#/responses/CommentList"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/issue/{index}/labels" : {
"put" : {
"consumes" : [
"application/json"
] ,
2017-05-02 16:35:59 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
] ,
"summary" : "Replace an issue's labels" ,
"operationId" : "issueReplaceLabels" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "index of the issue" ,
"name" : "index" ,
"in" : "path" ,
"required" : true
} ,
{
"name" : "body" ,
"in" : "body" ,
"schema" : {
"$ref" : "#/definitions/IssueLabelsOption"
}
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/LabelList"
2017-05-02 16:35:59 +03:00
}
}
} ,
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Add a label to an issue" ,
"operationId" : "issueAddLabel" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-05-02 16:35:59 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03: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
} ,
{
"type" : "integer" ,
"description" : "index of the issue" ,
"name" : "index" ,
"in" : "path" ,
"required" : true
} ,
{
"name" : "body" ,
2017-05-02 16:35:59 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/IssueLabelsOption"
2017-05-02 16:35:59 +03:00
}
}
] ,
"responses" : {
2017-11-13 10:02:25 +03:00
"200" : {
"$ref" : "#/responses/LabelList"
2017-05-02 16:35:59 +03:00
}
}
2017-11-13 10:02:25 +03:00
} ,
"delete" : {
2017-05-02 16:35:59 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Remove all labels from an issue" ,
"operationId" : "issueClearLabels" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "integer" ,
"description" : "index of the issue" ,
"name" : "index" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
2017-05-02 16:35:59 +03:00
}
}
2017-11-13 10:02:25 +03:00
}
} ,
"/repos/{owner}/{repo}/issue/{index}/labels/{id}" : {
2017-05-02 16:35:59 +03:00
"delete" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
] ,
"summary" : "Remove a label from an issue" ,
"operationId" : "issueRemoveLabel" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "index of the issue" ,
"name" : "index" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "id of the label to remove" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/issues" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
] ,
"summary" : "List a repository's issues" ,
"operationId" : "issueListIssues" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : "whether issue is open or closed" ,
"name" : "state" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"description" : "page number of requested issues" ,
"name" : "page" ,
"in" : "query"
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/IssueList"
2017-05-02 16:35:59 +03:00
}
}
} ,
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Create an issue" ,
"operationId" : "issueCreateIssue" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-05-02 16:35:59 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03: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 16:35:59 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-05-02 16:35:59 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/CreateIssueOption"
2017-05-02 16:35:59 +03:00
}
}
] ,
"responses" : {
"201" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Issue"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/issues/comments" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List all comments in a repository" ,
"operationId" : "issueGetRepoComments" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "if provided, only comments updated since the provided time are returned." ,
"name" : "string" ,
"in" : "query"
2017-05-02 16:35:59 +03:00
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
2017-11-13 10:02:25 +03:00
"200" : {
"$ref" : "#/responses/CommentList"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-20 10:24:07 +03:00
"/repos/{owner}/{repo}/issues/comments/{id}" : {
"delete" : {
"tags" : [
"issue"
] ,
"summary" : "Delete a comment" ,
"operationId" : "issueDeleteComment" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-20 10:24:07 +03: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" ,
"description" : "id of comment to delete" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
}
}
} ,
"patch" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"issue"
] ,
"summary" : "Edit a comment" ,
"operationId" : "issueEditComment" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-20 10:24:07 +03: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" ,
"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"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/issues/{id}" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
] ,
"summary" : "Get an issue by id" ,
"operationId" : "issueGetIssue" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "id of the issue to get" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Issue"
2017-05-02 16:35:59 +03:00
}
}
2017-08-21 14:13:47 +03:00
} ,
2017-11-13 10:02:25 +03:00
"patch" : {
2017-08-21 14:13:47 +03:00
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Edit an issue" ,
"operationId" : "issueEditIssue" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-08-21 14:13:47 +03:00
"parameters" : [
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"type" : "integer" ,
"description" : "id of the issue to edit" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-08-21 14:13:47 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/EditIssueOption"
2017-08-21 14:13:47 +03:00
}
2017-11-13 10:02:25 +03:00
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/Issue"
}
}
}
} ,
"/repos/{owner}/{repo}/issues/{index}/comments" : {
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"issue"
] ,
"summary" : "Add a comment to an issue" ,
"operationId" : "issueCreateComment" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"type" : "integer" ,
"description" : "index of the issue" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
2017-08-21 14:13:47 +03:00
} ,
{
2017-11-13 10:02:25 +03:00
"name" : "body" ,
2017-08-21 14:13:47 +03:00
"in" : "body" ,
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/CreateIssueOption"
2017-08-21 14:13:47 +03:00
}
}
] ,
"responses" : {
"201" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Comment"
2017-08-21 14:13:47 +03:00
}
}
2017-05-02 16:35:59 +03:00
}
} ,
2017-11-20 10:24:07 +03:00
"/repos/{owner}/{repo}/issues/{index}/comments/{id}" : {
"delete" : {
"tags" : [
"issue"
] ,
"summary" : "Delete a comment" ,
"operationId" : "issueDeleteCommentDeprecated" ,
"deprecated" : true ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-20 10:24:07 +03: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" ,
"description" : "this parameter is ignored" ,
"name" : "index" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "id of comment to delete" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
}
}
} ,
"patch" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"issue"
] ,
"summary" : "Edit a comment" ,
"operationId" : "issueEditCommentDeprecated" ,
"deprecated" : true ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-20 10:24:07 +03: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" ,
"description" : "this parameter is ignored" ,
"name" : "index" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"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"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/issues/{index}/labels" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
] ,
"summary" : "Get an issue's labels" ,
"operationId" : "issueGetLabels" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "index of the issue" ,
"name" : "index" ,
"in" : "path" ,
"required" : true
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/LabelList"
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"404" : {
"$ref" : "#/responses/notFound"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/issues/{index}/times" : {
2017-05-02 16:35:59 +03:00
"get" : {
2017-11-13 10:02:25 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "List an issue's tracked times" ,
"operationId" : "issueTrackedTimes" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "index of the issue" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
2017-11-13 10:02:25 +03:00
"200" : {
"$ref" : "#/responses/TrackedTimeList"
2017-05-02 16:35:59 +03:00
}
}
} ,
2017-11-13 10:02:25 +03:00
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
] ,
"summary" : "Add a tracked time to a issue" ,
"operationId" : "issueAddTime" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "index of the issue to add tracked time to" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"name" : "body" ,
"in" : "body" ,
"schema" : {
"$ref" : "#/definitions/AddTimeOption"
}
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
2017-11-13 10:02:25 +03:00
"200" : {
"$ref" : "#/responses/TrackedTime"
} ,
"400" : {
"$ref" : "#/responses/error"
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"403" : {
2017-05-02 16:35:59 +03:00
"$ref" : "#/responses/error"
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/keys" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"repository"
] ,
"summary" : "List a repository's keys" ,
"operationId" : "repoListKeys" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/DeployKeyList"
2017-09-12 09:48:13 +03:00
}
}
2017-11-13 10:02:25 +03:00
} ,
"post" : {
"consumes" : [
"application/json"
] ,
2017-09-12 09:48:13 +03:00
"produces" : [
"application/json"
] ,
"tags" : [
2017-11-13 10:02:25 +03:00
"repository"
2017-09-12 09:48:13 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Add a key to a repository" ,
"operationId" : "repoCreateKey" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-09-12 09:48:13 +03:00
} ,
2017-11-13 10:02:25 +03: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"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/keys/{id}" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"repository"
] ,
"summary" : "Get a repository's key by id" ,
"operationId" : "repoGetKey" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "id of the key to get" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/DeployKey"
}
}
} ,
"delete" : {
"tags" : [
"repository"
] ,
"summary" : "Delete a key from a repository" ,
"operationId" : "repoDeleteKey" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "id of the key to delete" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/labels" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
] ,
"summary" : "Get all of a repository's labels" ,
"operationId" : "issueListLabels" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/LabelList"
2017-05-02 16:35:59 +03:00
}
}
2017-11-13 10:02:25 +03:00
} ,
"post" : {
"consumes" : [
"application/json"
] ,
2017-05-02 16:35:59 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Create a label" ,
"operationId" : "issueCreateLabel" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"name" : "body" ,
"in" : "body" ,
"schema" : {
"$ref" : "#/definitions/CreateLabelOption"
}
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/Label"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/labels/{id}" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
] ,
"summary" : "Get a single label" ,
"operationId" : "issueGetLabel" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "id of the label to get" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Label"
2017-05-02 16:35:59 +03:00
}
}
2017-11-13 10:02:25 +03:00
} ,
"delete" : {
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
] ,
"summary" : "Delete a label" ,
"operationId" : "issueDeleteLabel" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "id of the label to delete" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
}
}
2017-11-13 10:02:25 +03:00
} ,
"patch" : {
"consumes" : [
"application/json"
] ,
2017-05-02 16:35:59 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Update a label" ,
"operationId" : "issueEditLabel" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "id of the label to edit" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"name" : "body" ,
"in" : "body" ,
"schema" : {
"$ref" : "#/definitions/EditLabelOption"
}
2017-05-02 16:35:59 +03:00
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Label"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/milestones" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
] ,
"summary" : "Get all of a repository's milestones" ,
"operationId" : "issueGetMilestones" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "id of the milestone to get" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/MilestoneList"
2017-05-02 16:35:59 +03:00
}
}
2017-11-13 10:02:25 +03:00
} ,
"post" : {
"consumes" : [
"application/json"
] ,
2017-05-02 16:35:59 +03:00
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"issue"
2017-08-21 14:13:47 +03:00
] ,
2017-11-13 10:02:25 +03:00
"summary" : "Create a milestone" ,
"operationId" : "issueCreateMilestone" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : {
"$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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/Milestone"
}
}
} ,
"delete" : {
"tags" : [
"issue"
] ,
"summary" : "Delete a milestone" ,
"operationId" : "issueDeleteMilestone" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "id of the milestone to delete" ,
"name" : "body" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
}
}
} ,
"patch" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"issue"
] ,
"summary" : "Update a milestone" ,
"operationId" : "issueEditMilestone" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : {
"$ref" : "#/definitions/EditMilestoneOption"
}
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/Milestone"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/mirror-sync" : {
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Sync a mirrored repository" ,
"operationId" : "repoMirrorSync" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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"
}
}
}
} ,
"/repos/{owner}/{repo}/pulls" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"repository"
] ,
"summary" : "List a repo's pull requests" ,
"operationId" : "repoListPullRequests" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/PullRequestList"
}
}
} ,
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Create a pull request" ,
"operationId" : "repoCreatePullRequest" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03: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"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/pulls/{index}" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"repository"
] ,
"summary" : "Get a pull request" ,
"operationId" : "repoGetPullRequest" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "index of the pull request to get" ,
"name" : "index" ,
"in" : "path" ,
"required" : true
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/PullRequest"
}
}
} ,
"patch" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Update a pull request" ,
"operationId" : "repoEditPullRequest" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "owner of the repo" ,
"name" : "owner" ,
"in" : "path" ,
"required" : true
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
{
"type" : "string" ,
"description" : "name of the repo" ,
"name" : "repo" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"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"
2017-05-02 16:35:59 +03:00
}
}
}
} ,
2017-11-13 10:02:25 +03:00
"/repos/{owner}/{repo}/pulls/{index}/merge" : {
2017-05-02 16:35:59 +03:00
"get" : {
"produces" : [
"application/json"
] ,
2017-08-21 14:13:47 +03:00
"tags" : [
2017-11-13 10:02:25 +03:00
"repository"
] ,
"summary" : "Check if a pull request has been merged" ,
"operationId" : "repoPullRequestIsMerged" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "index of the pull request" ,
"name" : "index" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"description" : "pull request has been merged" ,
"schema" : {
"$ref" : "#/responses/empty"
}
} ,
"404" : {
"description" : "pull request has not been merged" ,
"schema" : {
"$ref" : "#/responses/empty"
}
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Merge a pull request" ,
"operationId" : "repoMergePullRequest" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "index of the pull request to merge" ,
"name" : "index" ,
"in" : "path" ,
"required" : true
}
2017-08-21 14:13:47 +03:00
] ,
2017-05-02 16:35:59 +03:00
"responses" : {
"200" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/responses/empty"
} ,
"405" : {
"$ref" : "#/responses/empty"
2017-05-02 16:35:59 +03:00
}
}
}
2017-11-13 10:02:25 +03:00
} ,
"/repos/{owner}/{repo}/raw/{filepath}" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Get a file from a repository" ,
"operationId" : "repoGetRawFile" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : "filepath of the file to get" ,
"name" : "filepath" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : { }
}
}
} ,
"/repos/{owner}/{repo}/releases" : {
"get" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Create a release" ,
"operationId" : "repoCreateRelease" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : {
"$ref" : "#/definitions/CreateReleaseOption"
}
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/Release"
}
}
}
} ,
"/repos/{owner}/{repo}/releases/{id}" : {
"delete" : {
"tags" : [
"repository"
] ,
"summary" : "Delete a release" ,
"operationId" : "repoDeleteRelease" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"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"
}
}
}
} ,
"/repos/{owner}/{repo}/stargazers" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "List a repo's stargazers" ,
"operationId" : "repoListStargazers" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/UserList"
}
}
}
} ,
"/repos/{owner}/{repo}/statuses/{sha}" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Get a commit's statuses" ,
"operationId" : "repoListStatuses" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : "sha of the commit" ,
"name" : "sha" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/StatusList"
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Create a commit status" ,
"operationId" : "repoCreateStatus" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" : "sha of the commit" ,
"name" : "sha" ,
"in" : "path" ,
"required" : true
} ,
{
"name" : "body" ,
"in" : "body" ,
"schema" : {
"$ref" : "#/definitions/CreateStatusOption"
}
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/StatusList"
}
}
}
} ,
"/repos/{owner}/{repo}/subscribers" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "List a repo's watchers" ,
"operationId" : "repoListSubscribers" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/UserList"
}
}
}
} ,
"/repos/{owner}/{repo}/subscription" : {
"get" : {
"tags" : [
"repository"
] ,
"summary" : "Check if the current user is watching a repo" ,
"operationId" : "userCurrentCheckSubscription" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/WatchInfo"
}
}
} ,
"put" : {
"tags" : [
"repository"
] ,
"summary" : "Watch a repo" ,
"operationId" : "userCurrentPutSubscription" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/WatchInfo"
}
}
} ,
"delete" : {
"tags" : [
"repository"
] ,
"summary" : "Unwatch a repo" ,
"operationId" : "userCurrentDeleteSubscription" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
] ,
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
}
}
}
} ,
"/repos/{owner}/{repo}/times" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "List a repo's tracked times" ,
"operationId" : "repoTrackedTimes" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/TrackedTimeList"
}
}
}
} ,
"/repos/{owner}/{repo}/times/{tracker}" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "List a user's tracked times in a repo" ,
"operationId" : "userTrackedTimes" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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"
}
}
}
} ,
"/repos/{user}/{repo}/hooks/{id}" : {
"delete" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Delete a hook in a repository" ,
"operationId" : "repoDeleteHook" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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" ,
"description" : "id of the hook to delete" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
} ,
"404" : {
"$ref" : "#/responses/notFound"
}
}
}
} ,
"/repositories/{id}" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"repository"
] ,
"summary" : "Get a repository by id" ,
"operationId" : "repoGetByID" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"description" : "id of the repo to get" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/Repository"
}
}
}
} ,
"/teams/{id}" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
"summary" : "Get a team" ,
"operationId" : "orgGetTeam" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"description" : "id of the team to delete" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"description" : "team deleted" ,
"schema" : {
"$ref" : "#/responses/empty"
}
}
}
} ,
"patch" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
"summary" : "Edit a team" ,
"operationId" : "orgEditTeam" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"description" : "id of the team" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/UserList"
}
}
}
} ,
"/teams/{id}/members/{username}" : {
"put" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
"summary" : "Add a team member" ,
"operationId" : "orgAddTeamMember" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"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"
}
}
} ,
"delete" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
"summary" : "Remove a team member" ,
"operationId" : "orgAddTeamMember" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"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"
}
}
}
} ,
"/teams/{id}/repos" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
"summary" : "List a team's repos" ,
"operationId" : "orgListTeamRepos" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"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" ,
"operationId" : "orgAddTeamMember" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"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"
}
}
} ,
"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" ,
"operationId" : "orgAddTeamMember" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"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"
}
}
}
} ,
"/user" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "Get the authenticated user" ,
"operationId" : "userGetCurrent" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/User"
}
}
}
} ,
"/user/emails" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "List the authenticated user's email addresses" ,
"operationId" : "userListEmails" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/EmailList"
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "Add email addresses" ,
"operationId" : "userAddEmail" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"name" : "body" ,
"in" : "body" ,
"schema" : {
"$ref" : "#/definitions/CreateEmailOption"
}
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/EmailList"
}
}
} ,
"delete" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "Delete email addresses" ,
"operationId" : "userDeleteEmail" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/UserList"
}
}
}
} ,
"/user/following/{followee}" : {
"get" : {
"tags" : [
"user"
] ,
"summary" : "Check whether a user is followed by the authenticated user" ,
"operationId" : "userCurrentCheckFollowing" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "username of followed user" ,
"name" : "followee" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
} ,
"404" : {
"$ref" : "#/responses/notFound"
}
}
}
} ,
"/user/following/{username}" : {
"put" : {
"tags" : [
"user"
] ,
"summary" : "Follow a user" ,
"operationId" : "userCurrentPutFollow" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/GPGKeyList"
}
}
} ,
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "Create a GPG key" ,
"operationId" : "userCurrentPostGPGKey" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/PublicKeyList"
}
}
} ,
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "Create a public key" ,
"operationId" : "userCurrentPostKey" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "integer" ,
"description" : "id of key to delete" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
} ,
"403" : {
"$ref" : "#/responses/forbidden"
2017-12-06 13:27:10 +03:00
} ,
"404" : {
"$ref" : "#/responses/notFound"
2017-11-13 10:02:25 +03:00
}
}
}
} ,
"/user/orgs" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
"summary" : "List the current user's organizations" ,
"operationId" : "orgListCurrentUserOrgs" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/RepositoryList"
}
}
} ,
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"repository" ,
"user"
] ,
"summary" : "Create a repository" ,
"operationId" : "createCurrentUserRepo" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"name" : "body" ,
"in" : "body" ,
"schema" : {
"$ref" : "#/definitions/CreateRepoOption"
}
}
] ,
"responses" : {
"201" : {
"$ref" : "#/responses/Repository"
}
}
}
} ,
"/user/starred" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "The repos that the authenticated user has starred" ,
"operationId" : "userCurrentListStarred" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/RepositoryList"
}
}
}
} ,
"/user/starred/{owner}/{repo}" : {
"get" : {
"tags" : [
"user"
] ,
"summary" : "Whether the authenticated is starring the repo" ,
"operationId" : "userCurrentCheckStarring" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03: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
}
] ,
"responses" : {
"204" : {
"$ref" : "#/responses/empty"
} ,
"404" : {
"$ref" : "#/responses/notFound"
}
}
} ,
"put" : {
"tags" : [
"user"
] ,
"summary" : "Star the given repo" ,
"operationId" : "userCurrentPutStar" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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"
}
}
}
} ,
"/user/subscriptions" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "List repositories watched by the authenticated user" ,
"operationId" : "userCurrentListSubscriptions" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/RepositoryList"
}
}
}
} ,
"/user/times" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "List the current user's tracked times" ,
"operationId" : "userCurrentTrackedTimes" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/TrackedTimeList"
}
}
}
} ,
"/user/{username}/orgs" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"organization"
] ,
"summary" : "List a user's organizations" ,
"operationId" : "orgListUserOrgs" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "username of user" ,
"name" : "username" ,
"in" : "path"
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/OrganizationList"
}
}
}
} ,
"/users/search" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "Search for users" ,
"operationId" : "userSearch" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "keyword" ,
"name" : "q" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"description" : "maximum number of users to return" ,
"name" : "limit" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/UserList"
}
}
}
} ,
"/users/{follower}/following/{followee}" : {
"get" : {
"tags" : [
"user"
] ,
"summary" : "Check if one user is following another user" ,
"operationId" : "userCheckFollowing" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "username of user" ,
"name" : "username" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/GPGKeyList"
}
}
}
} ,
"/users/{username}/keys" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "List the given user's public keys" ,
"operationId" : "userListKeys" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "username of user" ,
"name" : "username" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/PublicKeyList"
}
}
}
} ,
"/users/{username}/repos" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "List the repos owned by the given user" ,
"operationId" : "userListRepos" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"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" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"description" : "username of the user" ,
"name" : "username" ,
"in" : "path"
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/RepositoryList"
}
}
}
} ,
"/users/{username}/tokens" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "List the authenticated user's access tokens" ,
"operationId" : "userGetTokens" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/AccessTokenList"
}
}
} ,
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"user"
] ,
"summary" : "Create an access token" ,
"operationId" : "userCreateToken" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"parameters" : [
{
"type" : "string" ,
"x-go-name" : "Name" ,
"name" : "name" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"$ref" : "#/responses/AccessToken"
}
}
}
} ,
"/version" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"miscellaneous"
] ,
"summary" : "Returns the version of the Gitea application" ,
"operationId" : "getVersion" ,
2017-12-06 13:27:10 +03:00
"security" : null ,
2017-11-13 10:02:25 +03:00
"responses" : {
"200" : {
"$ref" : "#/responses/ServerVersion"
}
}
}
}
} ,
"definitions" : {
"AddCollaboratorOption" : {
"description" : "AddCollaboratorOption options when adding a user as a collaborator of a repository" ,
"type" : "object" ,
"properties" : {
"permission" : {
"type" : "string" ,
"x-go-name" : "Permission"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"AddTimeOption" : {
"description" : "AddTimeOption options for adding time to an issue" ,
"type" : "object" ,
"required" : [
"time"
] ,
"properties" : {
"time" : {
"description" : "time in seconds" ,
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "Time"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"Branch" : {
"description" : "Branch represents a repository branch" ,
"type" : "object" ,
"properties" : {
"commit" : {
"$ref" : "#/definitions/PayloadCommit"
} ,
"name" : {
"type" : "string" ,
"x-go-name" : "Name"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"pull_request_url" : {
"type" : "string" ,
"x-go-name" : "PRURL"
} ,
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"x-go-name" : "Updated"
} ,
"user" : {
"$ref" : "#/definitions/User"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"CreateHookOption" : {
"description" : "CreateHookOption options when create a hook" ,
"type" : "object" ,
"required" : [
"type" ,
"config"
] ,
"properties" : {
"active" : {
"type" : "boolean" ,
"default" : false ,
"x-go-name" : "Active"
} ,
"config" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
} ,
"x-go-name" : "Config"
} ,
"events" : {
"type" : "array" ,
"items" : {
"type" : "string"
} ,
"x-go-name" : "Events"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"gitea" ,
"gogs" ,
"slack" ,
"discord"
] ,
"x-go-name" : "Type"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"CreateIssueCommentOption" : {
"description" : "CreateIssueCommentOption options for creating a comment on an issue" ,
"type" : "object" ,
"required" : [
"body"
] ,
"properties" : {
"body" : {
"type" : "string" ,
"x-go-name" : "Body"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"CreateIssueOption" : {
"description" : "CreateIssueOption options to create one issue" ,
"type" : "object" ,
"required" : [
"title"
] ,
"properties" : {
"assignee" : {
"description" : "username of assignee" ,
"type" : "string" ,
"x-go-name" : "Assignee"
} ,
"body" : {
"type" : "string" ,
"x-go-name" : "Body"
} ,
"closed" : {
"type" : "boolean" ,
"x-go-name" : "Closed"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"title" : {
"description" : "Title of the key to add" ,
"type" : "string" ,
"uniqueItems" : true ,
"x-go-name" : "Title"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"CreateLabelOption" : {
"description" : "CreateLabelOption options for creating a label" ,
"type" : "object" ,
"required" : [
"name" ,
"color"
] ,
"properties" : {
"color" : {
"type" : "string" ,
"x-go-name" : "Color" ,
"example" : "#00aabb"
} ,
"name" : {
"type" : "string" ,
"x-go-name" : "Name"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"username" : {
"type" : "string" ,
"x-go-name" : "UserName"
} ,
"website" : {
"type" : "string" ,
"x-go-name" : "Website"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"CreatePullRequestOption" : {
"description" : "CreatePullRequestOption options when creating a pull request" ,
"type" : "object" ,
"properties" : {
"assignee" : {
"type" : "string" ,
"x-go-name" : "Assignee"
} ,
"base" : {
"type" : "string" ,
"x-go-name" : "Base"
} ,
"body" : {
"type" : "string" ,
"x-go-name" : "Body"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"CreateTeamOption" : {
"description" : "CreateTeamOption options for creating a team" ,
"type" : "object" ,
"required" : [
"name"
] ,
"properties" : {
"description" : {
"type" : "string" ,
"x-go-name" : "Description"
} ,
"name" : {
"type" : "string" ,
"x-go-name" : "Name"
} ,
"permission" : {
"type" : "string" ,
"enum" : [
"read" ,
"write" ,
"admin"
] ,
"x-go-name" : "Permission"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"DeployKey" : {
"description" : "DeployKey a deploy key" ,
"type" : "object" ,
"properties" : {
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"x-go-name" : "Created"
} ,
"id" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "ID"
} ,
"key" : {
"type" : "string" ,
"x-go-name" : "Key"
} ,
"read_only" : {
"type" : "boolean" ,
"x-go-name" : "ReadOnly"
} ,
"title" : {
"type" : "string" ,
"x-go-name" : "Title"
} ,
"url" : {
"type" : "string" ,
"x-go-name" : "URL"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"EditHookOption" : {
"description" : "EditHookOption options when modify one hook" ,
"type" : "object" ,
"properties" : {
"active" : {
"type" : "boolean" ,
"x-go-name" : "Active"
} ,
"config" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
} ,
"x-go-name" : "Config"
} ,
"events" : {
"type" : "array" ,
"items" : {
"type" : "string"
} ,
"x-go-name" : "Events"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"EditIssueCommentOption" : {
"description" : "EditIssueCommentOption options for editing a comment" ,
"type" : "object" ,
"required" : [
"body"
] ,
"properties" : {
"body" : {
"type" : "string" ,
"x-go-name" : "Body"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"EditIssueOption" : {
"description" : "EditIssueOption options for editing an issue" ,
"type" : "object" ,
"properties" : {
"assignee" : {
"type" : "string" ,
"x-go-name" : "Assignee"
} ,
"body" : {
"type" : "string" ,
"x-go-name" : "Body"
} ,
"milestone" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "Milestone"
} ,
"state" : {
"type" : "string" ,
"x-go-name" : "State"
} ,
"title" : {
"type" : "string" ,
"x-go-name" : "Title"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"EditLabelOption" : {
"description" : "EditLabelOption options for editing a label" ,
"type" : "object" ,
"properties" : {
"color" : {
"type" : "string" ,
"x-go-name" : "Color"
} ,
"name" : {
"type" : "string" ,
"x-go-name" : "Name"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"website" : {
"type" : "string" ,
"x-go-name" : "Website"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"EditPullRequestOption" : {
"description" : "EditPullRequestOption options when modify pull request" ,
"type" : "object" ,
"properties" : {
"assignee" : {
"type" : "string" ,
"x-go-name" : "Assignee"
} ,
"body" : {
"type" : "string" ,
"x-go-name" : "Body"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"EditTeamOption" : {
"description" : "EditTeamOption options for editing a team" ,
"type" : "object" ,
"required" : [
"name"
] ,
"properties" : {
"description" : {
"type" : "string" ,
"x-go-name" : "Description"
} ,
"name" : {
"type" : "string" ,
"x-go-name" : "Name"
} ,
"permission" : {
"type" : "string" ,
"enum" : [
"read" ,
"write" ,
"admin"
] ,
"x-go-name" : "Permission"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"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"
} ,
"password" : {
"type" : "string" ,
"x-go-name" : "Password"
} ,
"source_id" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "SourceID"
} ,
"website" : {
"type" : "string" ,
"x-go-name" : "Website"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"Issue" : {
"description" : "Issue represents an issue in a repository" ,
"type" : "object" ,
"properties" : {
"assignee" : {
"$ref" : "#/definitions/User"
} ,
"body" : {
"type" : "string" ,
"x-go-name" : "Body"
} ,
"comments" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "Comments"
} ,
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"x-go-name" : "Created"
} ,
"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"
} ,
"pull_request" : {
"$ref" : "#/definitions/PullRequestMeta"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"Label" : {
"description" : "Label a label to an issue or a pr" ,
"type" : "object" ,
"properties" : {
"color" : {
"type" : "string" ,
"x-go-name" : "Color" ,
"example" : "00aabb"
} ,
"id" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "ID"
} ,
"name" : {
"type" : "string" ,
"x-go-name" : "Name"
} ,
"url" : {
"type" : "string" ,
"x-go-name" : "URL"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"mirror" : {
"type" : "boolean" ,
"x-go-name" : "Mirror"
} ,
"private" : {
"type" : "boolean" ,
"x-go-name" : "Private"
} ,
"repo_name" : {
"type" : "string" ,
"x-go-name" : "RepoName"
} ,
"uid" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "UID"
}
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"username" : {
"type" : "string" ,
"x-go-name" : "UserName"
} ,
"website" : {
"type" : "string" ,
"x-go-name" : "Website"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"PayloadCommit" : {
"description" : "PayloadCommit represents a commit" ,
"type" : "object" ,
"properties" : {
"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"
} ,
"timestamp" : {
"type" : "string" ,
"format" : "date-time" ,
"x-go-name" : "Timestamp"
} ,
"url" : {
"type" : "string" ,
"x-go-name" : "URL"
} ,
"verification" : {
"$ref" : "#/definitions/PayloadCommitVerification"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"verified" : {
"type" : "boolean" ,
"x-go-name" : "Verified"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"PublicKey" : {
"description" : "PublicKey publickey is a user key to push code to repository" ,
"type" : "object" ,
"properties" : {
2017-05-02 16:35:59 +03:00
"created_at" : {
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"format" : "date-time" ,
2017-05-02 16:35:59 +03:00
"x-go-name" : "Created"
} ,
2017-12-06 13:27:10 +03:00
"fingerprint" : {
"type" : "string" ,
"x-go-name" : "Fingerprint"
} ,
2017-11-13 10:02:25 +03:00
"id" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "ID"
} ,
"key" : {
"type" : "string" ,
"x-go-name" : "Key"
} ,
"title" : {
"type" : "string" ,
"x-go-name" : "Title"
} ,
"url" : {
"type" : "string" ,
"x-go-name" : "URL"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"PullRequest" : {
"description" : "PullRequest represents a pull request" ,
"type" : "object" ,
"properties" : {
"assignee" : {
"$ref" : "#/definitions/User"
} ,
"base" : {
"$ref" : "#/definitions/PRBranchInfo"
} ,
"body" : {
"type" : "string" ,
"x-go-name" : "Body"
} ,
"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"
} ,
"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 16:35:59 +03:00
"type" : "array" ,
"items" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/Label"
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"x-go-name" : "Labels"
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03: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 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"number" : {
2017-05-02 16:35:59 +03:00
"type" : "integer" ,
"format" : "int64" ,
2017-11-13 10:02:25 +03:00
"x-go-name" : "Index"
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"patch_url" : {
2017-05-02 16:35:59 +03:00
"type" : "string" ,
2017-11-13 10:02:25 +03:00
"x-go-name" : "PatchURL"
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"state" : {
"$ref" : "#/definitions/StateType"
} ,
"title" : {
2017-05-02 16:35:59 +03:00
"type" : "string" ,
2017-11-13 10:02:25 +03:00
"x-go-name" : "Title"
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"updated_at" : {
2017-05-02 16:35:59 +03:00
"type" : "string" ,
2017-11-13 10:02:25 +03:00
"format" : "date-time" ,
"x-go-name" : "Updated"
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"url" : {
"type" : "string" ,
"x-go-name" : "URL"
} ,
"user" : {
"$ref" : "#/definitions/User"
2017-05-02 16:35:59 +03:00
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
2017-11-13 10:02:25 +03:00
"PullRequestMeta" : {
"description" : "PullRequestMeta PR info if an issue is a PR" ,
2017-05-02 16:35:59 +03:00
"type" : "object" ,
"properties" : {
2017-11-13 10:02:25 +03:00
"merged" : {
2017-05-02 16:35:59 +03:00
"type" : "boolean" ,
2017-11-13 10:02:25 +03:00
"x-go-name" : "HasMerged"
} ,
"merged_at" : {
"type" : "string" ,
"format" : "date-time" ,
"x-go-name" : "Merged"
2017-05-02 16:35:59 +03:00
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
2017-11-13 10:02:25 +03:00
"Release" : {
"description" : "Release represents a repository release" ,
2017-05-02 16:35:59 +03:00
"type" : "object" ,
"properties" : {
2017-11-13 10:02:25 +03:00
"author" : {
"$ref" : "#/definitions/User"
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"body" : {
"type" : "string" ,
"x-go-name" : "Note"
} ,
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"x-go-name" : "CreatedAt"
} ,
"draft" : {
2017-05-02 16:35:59 +03:00
"type" : "boolean" ,
2017-11-13 10:02:25 +03:00
"x-go-name" : "IsDraft"
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"id" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "ID"
} ,
"name" : {
"type" : "string" ,
"x-go-name" : "Title"
} ,
"prerelease" : {
2017-05-02 16:35:59 +03:00
"type" : "boolean" ,
2017-11-13 10:02:25 +03: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 16:35:59 +03:00
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"Repository" : {
2017-11-13 10:02:25 +03:00
"description" : "Repository represents a repository" ,
2017-05-02 16:35:59 +03:00
"type" : "object" ,
"properties" : {
"clone_url" : {
"type" : "string" ,
"x-go-name" : "CloneURL"
} ,
"created_at" : {
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"format" : "date-time" ,
2017-05-02 16:35:59 +03:00
"x-go-name" : "Created"
} ,
"default_branch" : {
"type" : "string" ,
"x-go-name" : "DefaultBranch"
} ,
"description" : {
"type" : "string" ,
"x-go-name" : "Description"
} ,
2017-05-14 12:37:15 +03:00
"empty" : {
"type" : "boolean" ,
"x-go-name" : "Empty"
} ,
2017-05-02 16:35:59 +03: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"
} ,
"html_url" : {
"type" : "string" ,
"x-go-name" : "HTMLURL"
} ,
"id" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "ID"
} ,
"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"
} ,
"owner" : {
"$ref" : "#/definitions/User"
} ,
2017-05-14 12:37:15 +03:00
"parent" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/Repository"
2017-05-14 12:37:15 +03:00
} ,
2017-05-02 16:35:59 +03:00
"permissions" : {
"$ref" : "#/definitions/Permission"
} ,
"private" : {
"type" : "boolean" ,
"x-go-name" : "Private"
} ,
2017-05-14 12:37:15 +03:00
"size" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "Size"
} ,
2017-05-02 16:35:59 +03:00
"ssh_url" : {
"type" : "string" ,
"x-go-name" : "SSHURL"
} ,
"stars_count" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "Stars"
} ,
"updated_at" : {
2017-11-13 10:02:25 +03:00
"type" : "string" ,
"format" : "date-time" ,
2017-05-02 16:35:59 +03:00
"x-go-name" : "Updated"
} ,
"watchers_count" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "Watchers"
} ,
"website" : {
"type" : "string" ,
"x-go-name" : "Website"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
2017-11-13 10:02:25 +03: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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"ServerVersion" : {
"description" : "ServerVersion wraps the version of the server" ,
"type" : "object" ,
"properties" : {
"version" : {
"type" : "string" ,
"x-go-name" : "Version"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"StateType" : {
"description" : "StateType issue state type" ,
"type" : "string" ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"StatusState" : {
"description" : "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"" ,
"type" : "string" ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"Team" : {
"description" : "Team represents a team in an organization" ,
"type" : "object" ,
"properties" : {
"description" : {
"type" : "string" ,
"x-go-name" : "Description"
} ,
"id" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "ID"
} ,
"name" : {
"type" : "string" ,
"x-go-name" : "Name"
} ,
"permission" : {
"type" : "string" ,
"enum" : [
"none" ,
"read" ,
"write" ,
"admin" ,
"owner"
] ,
"x-go-name" : "Permission"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
"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"
} ,
"issue_id" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "IssueID"
} ,
"time" : {
"description" : "Time in seconds" ,
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "Time"
} ,
"user_id" : {
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "UserID"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
} ,
2017-05-02 16:35:59 +03:00
"User" : {
2017-11-13 10:02:25 +03:00
"description" : "User represents a user" ,
2017-05-02 16:35:59 +03:00
"type" : "object" ,
"properties" : {
"avatar_url" : {
2017-11-13 10:02:25 +03:00
"description" : "URL to the user's avatar" ,
2017-05-02 16:35:59 +03:00
"type" : "string" ,
"x-go-name" : "AvatarURL"
} ,
"email" : {
"type" : "string" ,
2017-11-13 10:02:25 +03:00
"format" : "email" ,
2017-05-02 16:35:59 +03:00
"x-go-name" : "Email"
} ,
"full_name" : {
2017-11-13 10:02:25 +03:00
"description" : "the user's full name" ,
2017-05-02 16:35:59 +03:00
"type" : "string" ,
"x-go-name" : "FullName"
} ,
"id" : {
2017-11-13 10:02:25 +03:00
"description" : "the user's id" ,
2017-05-02 16:35:59 +03:00
"type" : "integer" ,
"format" : "int64" ,
"x-go-name" : "ID"
} ,
"login" : {
2017-11-13 10:02:25 +03:00
"description" : "the user's username" ,
2017-05-02 16:35:59 +03:00
"type" : "string" ,
"x-go-name" : "UserName"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
2017-11-13 10:02:25 +03: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"
}
} ,
"x-go-package" : "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
2017-05-02 16:35:59 +03:00
}
} ,
"responses" : {
"AccessToken" : {
"description" : "AccessToken represents a API access token." ,
"headers" : {
"name" : {
"type" : "string"
} ,
"sha1" : {
"type" : "string"
}
}
} ,
"AccessTokenList" : {
"description" : "AccessTokenList represents a list of API access token."
} ,
2017-11-13 10:02:25 +03:00
"Branch" : {
"schema" : {
"$ref" : "#/definitions/Branch"
}
} ,
"BranchList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Branch"
}
}
} ,
"Comment" : {
"schema" : {
"$ref" : "#/definitions/Comment"
}
} ,
"CommentList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Comment"
}
}
} ,
"DeployKey" : {
"schema" : {
"$ref" : "#/definitions/DeployKey"
}
} ,
"DeployKeyList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/DeployKey"
}
}
} ,
"EmailList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Email"
2017-05-02 16:35:59 +03:00
}
}
} ,
2017-11-13 10:02:25 +03:00
"GPGKey" : {
"schema" : {
"$ref" : "#/definitions/GPGKey"
}
} ,
2017-05-02 16:35:59 +03:00
"GPGKeyList" : {
2017-11-13 10:02:25 +03:00
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/GPGKey"
}
}
2017-05-02 16:35:59 +03:00
} ,
2017-08-21 14:13:47 +03:00
"Hook" : {
"schema" : {
2017-11-13 10:02:25 +03:00
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Branch"
2017-08-21 14:13:47 +03:00
}
}
} ,
"HookList" : {
2017-11-13 10:02:25 +03:00
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Branch"
}
}
} ,
"Issue" : {
"schema" : {
"$ref" : "#/definitions/Issue"
}
} ,
"IssueList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Issue"
}
}
} ,
"Label" : {
"schema" : {
"$ref" : "#/definitions/Label"
}
} ,
"LabelList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Label"
}
}
2017-08-21 14:13:47 +03:00
} ,
2017-05-02 16:35:59 +03:00
"MarkdownRender" : {
"description" : "MarkdownRender is a rendered markdown document"
} ,
2017-11-13 10:02:25 +03:00
"Milestone" : {
"schema" : {
"$ref" : "#/definitions/Milestone"
}
} ,
"MilestoneList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Milestone"
}
}
} ,
2017-08-21 14:13:47 +03:00
"Organization" : {
2017-11-13 10:02:25 +03:00
"schema" : {
"$ref" : "#/definitions/Organization"
}
} ,
"OrganizationList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Organization"
2017-08-21 14:13:47 +03:00
}
}
} ,
2017-05-02 16:35:59 +03:00
"PublicKey" : {
2017-11-13 10:02:25 +03:00
"schema" : {
"$ref" : "#/definitions/PublicKey"
2017-05-02 16:35:59 +03:00
}
} ,
"PublicKeyList" : {
2017-11-13 10:02:25 +03:00
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/PublicKey"
}
}
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"PullRequest" : {
2017-05-02 16:35:59 +03:00
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/PullRequest"
}
} ,
"PullRequestList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/PullRequest"
2017-05-02 16:35:59 +03:00
}
}
} ,
2017-11-13 10:02:25 +03:00
"Release" : {
"schema" : {
"$ref" : "#/definitions/Release"
}
2017-05-02 16:35:59 +03:00
} ,
2017-11-13 10:02:25 +03:00
"ReleaseList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Release"
}
}
} ,
"Repository" : {
"schema" : {
"$ref" : "#/definitions/Repository"
}
} ,
"RepositoryList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Repository"
2017-05-02 16:35:59 +03:00
}
}
} ,
"SearchResults" : {
2017-11-13 10:02:25 +03:00
"schema" : {
"$ref" : "#/definitions/SearchResults"
} ,
2017-05-02 16:35:59 +03:00
"headers" : {
2017-11-13 10:02:25 +03:00
"body" : { }
2017-05-02 16:35:59 +03:00
}
} ,
"ServerVersion" : {
2017-11-13 10:02:25 +03:00
"schema" : {
"$ref" : "#/definitions/ServerVersion"
}
} ,
"Status" : {
"schema" : {
"$ref" : "#/definitions/Status"
}
} ,
"StatusList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Status"
2017-05-02 16:35:59 +03:00
}
}
} ,
2017-11-13 10:02:25 +03:00
"Team" : {
"schema" : {
"$ref" : "#/definitions/Team"
}
} ,
"TeamList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Team"
2017-08-21 14:13:47 +03:00
}
}
} ,
2017-11-13 10:02:25 +03:00
"TrackedTime" : {
"schema" : {
"$ref" : "#/definitions/TrackedTime"
}
2017-08-21 14:13:47 +03:00
} ,
2017-11-13 10:02:25 +03:00
"TrackedTimeList" : {
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/TrackedTime"
2017-05-02 16:35:59 +03:00
}
}
} ,
2017-11-13 10:02:25 +03:00
"User" : {
"schema" : {
"$ref" : "#/definitions/User"
}
} ,
2017-05-02 16:35:59 +03:00
"UserList" : {
2017-11-13 10:02:25 +03:00
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/User"
}
}
2017-05-02 16:35:59 +03:00
} ,
"WatchInfo" : {
"schema" : {
2017-11-13 10:02:25 +03:00
"$ref" : "#/definitions/WatchInfo"
2017-05-02 16:35:59 +03:00
}
} ,
"empty" : {
2017-05-18 17:39:42 +03:00
"description" : "APIEmpty is an empty response"
2017-05-02 16:35:59 +03: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"
}
}
} ,
"notFound" : {
"description" : "APINotFound is a not found empty response"
} ,
2017-11-13 10:02:25 +03:00
"parameterBodies" : {
"schema" : {
"$ref" : "#/definitions/MigrateRepoForm"
} ,
"headers" : {
"AddCollaboratorOption" : { } ,
"AddTimeOption" : { } ,
"CreateEmailOption" : { } ,
"CreateForkOption" : { } ,
"CreateHookOption" : { } ,
"CreateIssueCommentOption" : { } ,
"CreateIssueOption" : { } ,
"CreateKeyOption" : { } ,
"CreateLabelOption" : { } ,
"CreateMilestoneOption" : { } ,
"CreateOrgOption" : { } ,
"CreatePullRequestOption" : { } ,
"CreateReleaseOption" : { } ,
"CreateRepoOption" : { } ,
"CreateStatusOption" : { } ,
"CreateTeamOption" : { } ,
"CreateUserOption" : { } ,
"DeleteEmailOption" : { } ,
"EditHookOption" : { } ,
"EditIssueCommentOption" : { } ,
"EditIssueOption" : { } ,
"EditLabelOption" : { } ,
"EditMilestoneOption" : { } ,
"EditOrgOption" : { } ,
"EditPullRequestOption" : { } ,
"EditReleaseOption" : { } ,
"EditTeamOption" : { } ,
"EditUserOption" : { } ,
"IssueLabelsOption" : { } ,
"MarkdownOption" : { } ,
"MigrateRepoForm" : { }
}
} ,
2017-08-21 14:13:47 +03:00
"redirect" : {
"description" : "APIRedirect is a redirect response"
} ,
2017-05-02 16:35:59 +03:00
"validationError" : {
"description" : "APIValidationError is error format response related to input validation" ,
"headers" : {
"message" : {
"type" : "string"
} ,
"url" : {
"type" : "string"
}
}
}
2017-08-21 14:13:47 +03:00
} ,
"securityDefinitions" : {
"AccessToken" : {
"type" : "apiKey" ,
"name" : "access_token" ,
"in" : "query"
} ,
"AuthorizationHeaderToken" : {
"type" : "apiKey" ,
"name" : "Authorization" ,
"in" : "header"
} ,
"BasicAuth" : {
"type" : "basic"
} ,
"Token" : {
"type" : "apiKey" ,
"name" : "token" ,
"in" : "query"
}
} ,
"security" : [
{
"BasicAuth" : [
"[]"
]
} ,
{
"Token" : [
"[]"
]
} ,
{
"AccessToken" : [
"[]"
]
} ,
{
"AuthorizationHeaderToken" : [
"[]"
]
}
]
2017-12-06 13:27:10 +03:00
}