Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.
The codespace's token is granted write permissions to the repository, allowing the user to push their changes.
This will fail for a codespace that is already published, meaning it has an associated repository.
You must authenticate using a personal access token with the codespace
scope to use this endpoint.
GitHub Apps must have write access to the codespaces
repository permission to use this endpoint.
type: object
properties:
parameters:
type: object
properties:
codespace_name:
type: string
description: The name of the codespace.
required:
- codespace_name
title: Parameters
data:
type: object
properties:
name:
description: A name for the new repository.
type: string
private:
description: Whether the new repository should be private.
type: boolean
default: false
title: Data
type: object
title: Codespace
properties:
id:
type: integer
example: 1
name:
description: Automatically generated name of this codespace.
type: string
example: monalisa-octocat-hello-world-g4wpq6h95q
display_name:
description: Display name for this codespace.
type: string
example: bookish space pancake
nullable: true
environment_id:
description: UUID identifying this codespace's environment.
type: string
example: 26a7c758-7299-4a73-b978-5a92a7ae98a0
nullable: true
owner:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
billable_owner:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
repository:
type: object
title: Full Repository
properties:
id:
type: integer
example: 1296269
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
type: string
example: Hello-World
full_name:
type: string
example: octocat/Hello-World
owner:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
private:
type: boolean
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
example: This your first repo!
nullable: true
fork:
type: boolean
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url:
type: string
example: git:github.com/octocat/Hello-World.git
issue_comment_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url:
type: string
example:
[email protected]:octocat/Hello-World.git
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url:
type: string
example: https://github.com/octocat/Hello-World.git
mirror_url:
type: string
format: uri
example: git:git.example.com/octocat/Hello-World
nullable: true
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
format: uri
example: https://svn.github.com/octocat/Hello-World
homepage:
type: string
format: uri
example: https://github.com
nullable: true
language:
type: string
nullable: true
forks_count:
type: integer
example: 9
stargazers_count:
type: integer
example: 80
watchers_count:
type: integer
example: 80
size:
description: >-
The size of the repository. Size is calculated hourly. When a
repository is initially created, the size is 0.
type: integer
example: 108
default_branch:
type: string
example: master
open_issues_count:
type: integer
example: 0
is_template:
type: boolean
example: true
topics:
type: array
items:
type: string
has_issues:
type: boolean
example: true
has_projects:
type: boolean
example: true
has_wiki:
type: boolean
example: true
has_pages:
type: boolean
has_downloads:
type: boolean
example: true
has_discussions:
type: boolean
example: true
archived:
type: boolean
disabled:
type: boolean
description: Returns whether or not this repository disabled.
visibility:
description: 'The repository visibility: public, private, or internal.'
type: string
example: public
pushed_at:
type: string
format: date-time
example: '2011-01-26T19:06:43.000Z'
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12.000Z'
updated_at:
type: string
format: date-time
example: '2011-01-26T19:14:43.000Z'
permissions:
type: object
properties:
admin:
type: boolean
maintain:
type: boolean
push:
type: boolean
triage:
type: boolean
pull:
type: boolean
allow_rebase_merge:
type: boolean
example: true
template_repository:
type: object
title: Repository
properties:
id:
description: Unique identifier of the repository
example: 42
type: integer
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
description: The name of the repository.
type: string
example: Team Environment
full_name:
type: string
example: octocat/Hello-World
license:
type: object
title: License Simple
properties:
key:
type: string
example: mit
name:
type: string
example: MIT License
url:
type: string
nullable: true
format: uri
example: https://api.github.com/licenses/mit
spdx_id:
type: string
nullable: true
example: MIT
node_id:
type: string
example: MDc6TGljZW5zZW1pdA==
html_url:
type: string
format: uri
organization:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
forks:
type: integer
permissions:
type: object
properties:
admin:
type: boolean
pull:
type: boolean
triage:
type: boolean
push:
type: boolean
maintain:
type: boolean
owner:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
private:
description: Whether the repository is private or public.
default: false
type: boolean
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
example: This your first repo!
nullable: true
fork:
type: boolean
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url:
type: string
example: git:github.com/octocat/Hello-World.git
issue_comment_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url:
type: string
example:
[email protected]:octocat/Hello-World.git
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url:
type: string
example: https://github.com/octocat/Hello-World.git
mirror_url:
type: string
format: uri
example: git:git.example.com/octocat/Hello-World
nullable: true
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
format: uri
example: https://svn.github.com/octocat/Hello-World
homepage:
type: string
format: uri
example: https://github.com
nullable: true
language:
type: string
nullable: true
forks_count:
type: integer
example: 9
stargazers_count:
type: integer
example: 80
watchers_count:
type: integer
example: 80
size:
description: >-
The size of the repository. Size is calculated hourly. When a
repository is initially created, the size is 0.
type: integer
example: 108
default_branch:
description: The default branch of the repository.
type: string
example: master
open_issues_count:
type: integer
example: 0
is_template:
description: >-
Whether this repository acts as a template that can be used to
generate new repositories.
default: false
type: boolean
example: true
topics:
type: array
items:
type: string
has_issues:
description: Whether issues are enabled.
default: true
type: boolean
example: true
has_projects:
description: Whether projects are enabled.
default: true
type: boolean
example: true
has_wiki:
description: Whether the wiki is enabled.
default: true
type: boolean
example: true
has_pages:
type: boolean
has_downloads:
description: Whether downloads are enabled.
default: true
type: boolean
example: true
has_discussions:
description: Whether discussions are enabled.
default: false
type: boolean
example: true
archived:
description: Whether the repository is archived.
default: false
type: boolean
disabled:
type: boolean
description: Returns whether or not this repository disabled.
visibility:
description: 'The repository visibility: public, private, or internal.'
default: public
type: string
pushed_at:
type: string
format: date-time
example: '2011-01-26T19:06:43.000Z'
nullable: true
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12.000Z'
nullable: true
updated_at:
type: string
format: date-time
example: '2011-01-26T19:14:43.000Z'
nullable: true
allow_rebase_merge:
description: Whether to allow rebase merges for pull requests.
default: true
type: boolean
example: true
template_repository:
type: object
properties:
id:
type: integer
node_id:
type: string
name:
type: string
full_name:
type: string
owner:
type: object
properties:
login:
type: string
id:
type: integer
node_id:
type: string
avatar_url:
type: string
gravatar_id:
type: string
url:
type: string
html_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
starred_url:
type: string
subscriptions_url:
type: string
organizations_url:
type: string
repos_url:
type: string
events_url:
type: string
received_events_url:
type: string
type:
type: string
site_admin:
type: boolean
private:
type: boolean
html_url:
type: string
description:
type: string
fork:
type: boolean
url:
type: string
archive_url:
type: string
assignees_url:
type: string
blobs_url:
type: string
branches_url:
type: string
collaborators_url:
type: string
comments_url:
type: string
commits_url:
type: string
compare_url:
type: string
contents_url:
type: string
contributors_url:
type: string
deployments_url:
type: string
downloads_url:
type: string
events_url:
type: string
forks_url:
type: string
git_commits_url:
type: string
git_refs_url:
type: string
git_tags_url:
type: string
git_url:
type: string
issue_comment_url:
type: string
issue_events_url:
type: string
issues_url:
type: string
keys_url:
type: string
labels_url:
type: string
languages_url:
type: string
merges_url:
type: string
milestones_url:
type: string
notifications_url:
type: string
pulls_url:
type: string
releases_url:
type: string
ssh_url:
type: string
stargazers_url:
type: string
statuses_url:
type: string
subscribers_url:
type: string
subscription_url:
type: string
tags_url:
type: string
teams_url:
type: string
trees_url:
type: string
clone_url:
type: string
mirror_url:
type: string
hooks_url:
type: string
svn_url:
type: string
homepage:
type: string
language:
type: string
forks_count:
type: integer
stargazers_count:
type: integer
watchers_count:
type: integer
size:
type: integer
default_branch:
type: string
open_issues_count:
type: integer
is_template:
type: boolean
topics:
type: array
items:
type: string
has_issues:
type: boolean
has_projects:
type: boolean
has_wiki:
type: boolean
has_pages:
type: boolean
has_downloads:
type: boolean
archived:
type: boolean
disabled:
type: boolean
visibility:
type: string
pushed_at:
type: string
created_at:
type: string
updated_at:
type: string
permissions:
type: object
properties:
admin:
type: boolean
maintain:
type: boolean
push:
type: boolean
triage:
type: boolean
pull:
type: boolean
allow_rebase_merge:
type: boolean
temp_clone_token:
type: string
allow_squash_merge:
type: boolean
allow_auto_merge:
type: boolean
delete_branch_on_merge:
type: boolean
allow_update_branch:
type: boolean
use_squash_pr_title_as_default:
type: boolean
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: >-
The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if
only one commit) or the pull request's title (when more than
one commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: >-
The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge
message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.
- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
allow_merge_commit:
type: boolean
subscribers_count:
type: integer
network_count:
type: integer
temp_clone_token:
type: string
allow_squash_merge:
description: Whether to allow squash merges for pull requests.
default: true
type: boolean
example: true
allow_auto_merge:
description: Whether to allow Auto-merge to be used on pull requests.
default: false
type: boolean
example: false
delete_branch_on_merge:
description: Whether to delete head branches when pull requests are merged
default: false
type: boolean
example: false
allow_update_branch:
description: >-
Whether or not a pull request head branch that is behind its base
branch can always be updated even if it is not required to be up
to date before merging.
default: false
type: boolean
example: false
use_squash_pr_title_as_default:
type: boolean
description: >-
Whether a squash merge commit can use the pull request title as
default. **This property has been deprecated. Please use
`squash_merge_commit_title` instead.
default: false
deprecated: true
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: >-
The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only
one commit) or the pull request's title (when more than one
commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: >-
The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge
message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.
- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
allow_merge_commit:
description: Whether to allow merge commits for pull requests.
default: true
type: boolean
example: true
allow_forking:
description: Whether to allow forking this repo
type: boolean
web_commit_signoff_required:
description: Whether to require contributors to sign off on web-based commits
default: false
type: boolean
subscribers_count:
type: integer
network_count:
type: integer
open_issues:
type: integer
watchers:
type: integer
master_branch:
type: string
starred_at:
type: string
example: '"2020-07-09T00:17:42Z"'
anonymous_access_enabled:
type: boolean
description: Whether anonymous git access is enabled for this repository
temp_clone_token:
type: string
nullable: true
allow_squash_merge:
type: boolean
example: true
allow_auto_merge:
type: boolean
example: false
delete_branch_on_merge:
type: boolean
example: false
allow_merge_commit:
type: boolean
example: true
allow_update_branch:
type: boolean
example: true
use_squash_pr_title_as_default:
type: boolean
example: false
squash_merge_commit_title:
type: string
example: PR_TITLE
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: >-
The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one
commit) or the pull request's title (when more than one commit).
squash_merge_commit_message:
type: string
example: PR_BODY
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
example: PR_TITLE
enum:
- PR_TITLE
- MERGE_MESSAGE
description: |-
The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
example: PR_BODY
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.
- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
allow_forking:
type: boolean
example: true
web_commit_signoff_required:
type: boolean
example: false
subscribers_count:
type: integer
example: 42
network_count:
type: integer
example: 0
license:
type: object
title: License Simple
properties:
key:
type: string
example: mit
name:
type: string
example: MIT License
url:
type: string
nullable: true
format: uri
example: https://api.github.com/licenses/mit
spdx_id:
type: string
nullable: true
example: MIT
node_id:
type: string
example: MDc6TGljZW5zZW1pdA==
html_url:
type: string
format: uri
organization:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
parent:
type: object
title: Repository
properties:
id:
description: Unique identifier of the repository
example: 42
type: integer
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
description: The name of the repository.
type: string
example: Team Environment
full_name:
type: string
example: octocat/Hello-World
license:
type: object
title: License Simple
properties:
key:
type: string
example: mit
name:
type: string
example: MIT License
url:
type: string
nullable: true
format: uri
example: https://api.github.com/licenses/mit
spdx_id:
type: string
nullable: true
example: MIT
node_id:
type: string
example: MDc6TGljZW5zZW1pdA==
html_url:
type: string
format: uri
organization:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
forks:
type: integer
permissions:
type: object
properties:
admin:
type: boolean
pull:
type: boolean
triage:
type: boolean
push:
type: boolean
maintain:
type: boolean
owner:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
private:
description: Whether the repository is private or public.
default: false
type: boolean
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
example: This your first repo!
nullable: true
fork:
type: boolean
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url:
type: string
example: git:github.com/octocat/Hello-World.git
issue_comment_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url:
type: string
example:
[email protected]:octocat/Hello-World.git
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url:
type: string
example: https://github.com/octocat/Hello-World.git
mirror_url:
type: string
format: uri
example: git:git.example.com/octocat/Hello-World
nullable: true
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
format: uri
example: https://svn.github.com/octocat/Hello-World
homepage:
type: string
format: uri
example: https://github.com
nullable: true
language:
type: string
nullable: true
forks_count:
type: integer
example: 9
stargazers_count:
type: integer
example: 80
watchers_count:
type: integer
example: 80
size:
description: >-
The size of the repository. Size is calculated hourly. When a
repository is initially created, the size is 0.
type: integer
example: 108
default_branch:
description: The default branch of the repository.
type: string
example: master
open_issues_count:
type: integer
example: 0
is_template:
description: >-
Whether this repository acts as a template that can be used to
generate new repositories.
default: false
type: boolean
example: true
topics:
type: array
items:
type: string
has_issues:
description: Whether issues are enabled.
default: true
type: boolean
example: true
has_projects:
description: Whether projects are enabled.
default: true
type: boolean
example: true
has_wiki:
description: Whether the wiki is enabled.
default: true
type: boolean
example: true
has_pages:
type: boolean
has_downloads:
description: Whether downloads are enabled.
default: true
type: boolean
example: true
has_discussions:
description: Whether discussions are enabled.
default: false
type: boolean
example: true
archived:
description: Whether the repository is archived.
default: false
type: boolean
disabled:
type: boolean
description: Returns whether or not this repository disabled.
visibility:
description: 'The repository visibility: public, private, or internal.'
default: public
type: string
pushed_at:
type: string
format: date-time
example: '2011-01-26T19:06:43.000Z'
nullable: true
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12.000Z'
nullable: true
updated_at:
type: string
format: date-time
example: '2011-01-26T19:14:43.000Z'
nullable: true
allow_rebase_merge:
description: Whether to allow rebase merges for pull requests.
default: true
type: boolean
example: true
template_repository:
type: object
properties:
id:
type: integer
node_id:
type: string
name:
type: string
full_name:
type: string
owner:
type: object
properties:
login:
type: string
id:
type: integer
node_id:
type: string
avatar_url:
type: string
gravatar_id:
type: string
url:
type: string
html_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
starred_url:
type: string
subscriptions_url:
type: string
organizations_url:
type: string
repos_url:
type: string
events_url:
type: string
received_events_url:
type: string
type:
type: string
site_admin:
type: boolean
private:
type: boolean
html_url:
type: string
description:
type: string
fork:
type: boolean
url:
type: string
archive_url:
type: string
assignees_url:
type: string
blobs_url:
type: string
branches_url:
type: string
collaborators_url:
type: string
comments_url:
type: string
commits_url:
type: string
compare_url:
type: string
contents_url:
type: string
contributors_url:
type: string
deployments_url:
type: string
downloads_url:
type: string
events_url:
type: string
forks_url:
type: string
git_commits_url:
type: string
git_refs_url:
type: string
git_tags_url:
type: string
git_url:
type: string
issue_comment_url:
type: string
issue_events_url:
type: string
issues_url:
type: string
keys_url:
type: string
labels_url:
type: string
languages_url:
type: string
merges_url:
type: string
milestones_url:
type: string
notifications_url:
type: string
pulls_url:
type: string
releases_url:
type: string
ssh_url:
type: string
stargazers_url:
type: string
statuses_url:
type: string
subscribers_url:
type: string
subscription_url:
type: string
tags_url:
type: string
teams_url:
type: string
trees_url:
type: string
clone_url:
type: string
mirror_url:
type: string
hooks_url:
type: string
svn_url:
type: string
homepage:
type: string
language:
type: string
forks_count:
type: integer
stargazers_count:
type: integer
watchers_count:
type: integer
size:
type: integer
default_branch:
type: string
open_issues_count:
type: integer
is_template:
type: boolean
topics:
type: array
items:
type: string
has_issues:
type: boolean
has_projects:
type: boolean
has_wiki:
type: boolean
has_pages:
type: boolean
has_downloads:
type: boolean
archived:
type: boolean
disabled:
type: boolean
visibility:
type: string
pushed_at:
type: string
created_at:
type: string
updated_at:
type: string
permissions:
type: object
properties:
admin:
type: boolean
maintain:
type: boolean
push:
type: boolean
triage:
type: boolean
pull:
type: boolean
allow_rebase_merge:
type: boolean
temp_clone_token:
type: string
allow_squash_merge:
type: boolean
allow_auto_merge:
type: boolean
delete_branch_on_merge:
type: boolean
allow_update_branch:
type: boolean
use_squash_pr_title_as_default:
type: boolean
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: >-
The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if
only one commit) or the pull request's title (when more than
one commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: >-
The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge
message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.
- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
allow_merge_commit:
type: boolean
subscribers_count:
type: integer
network_count:
type: integer
temp_clone_token:
type: string
allow_squash_merge:
description: Whether to allow squash merges for pull requests.
default: true
type: boolean
example: true
allow_auto_merge:
description: Whether to allow Auto-merge to be used on pull requests.
default: false
type: boolean
example: false
delete_branch_on_merge:
description: Whether to delete head branches when pull requests are merged
default: false
type: boolean
example: false
allow_update_branch:
description: >-
Whether or not a pull request head branch that is behind its base
branch can always be updated even if it is not required to be up
to date before merging.
default: false
type: boolean
example: false
use_squash_pr_title_as_default:
type: boolean
description: >-
Whether a squash merge commit can use the pull request title as
default. **This property has been deprecated. Please use
`squash_merge_commit_title` instead.
default: false
deprecated: true
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: >-
The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only
one commit) or the pull request's title (when more than one
commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: >-
The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge
message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.
- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
allow_merge_commit:
description: Whether to allow merge commits for pull requests.
default: true
type: boolean
example: true
allow_forking:
description: Whether to allow forking this repo
type: boolean
web_commit_signoff_required:
description: Whether to require contributors to sign off on web-based commits
default: false
type: boolean
subscribers_count:
type: integer
network_count:
type: integer
open_issues:
type: integer
watchers:
type: integer
master_branch:
type: string
starred_at:
type: string
example: '"2020-07-09T00:17:42Z"'
anonymous_access_enabled:
type: boolean
description: Whether anonymous git access is enabled for this repository
source:
type: object
title: Repository
properties:
id:
description: Unique identifier of the repository
example: 42
type: integer
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
description: The name of the repository.
type: string
example: Team Environment
full_name:
type: string
example: octocat/Hello-World
license:
type: object
title: License Simple
properties:
key:
type: string
example: mit
name:
type: string
example: MIT License
url:
type: string
nullable: true
format: uri
example: https://api.github.com/licenses/mit
spdx_id:
type: string
nullable: true
example: MIT
node_id:
type: string
example: MDc6TGljZW5zZW1pdA==
html_url:
type: string
format: uri
organization:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
forks:
type: integer
permissions:
type: object
properties:
admin:
type: boolean
pull:
type: boolean
triage:
type: boolean
push:
type: boolean
maintain:
type: boolean
owner:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
private:
description: Whether the repository is private or public.
default: false
type: boolean
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
example: This your first repo!
nullable: true
fork:
type: boolean
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url:
type: string
example: git:github.com/octocat/Hello-World.git
issue_comment_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url:
type: string
example: >-
http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url:
type: string
example:
[email protected]:octocat/Hello-World.git
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url:
type: string
example: https://github.com/octocat/Hello-World.git
mirror_url:
type: string
format: uri
example: git:git.example.com/octocat/Hello-World
nullable: true
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
format: uri
example: https://svn.github.com/octocat/Hello-World
homepage:
type: string
format: uri
example: https://github.com
nullable: true
language:
type: string
nullable: true
forks_count:
type: integer
example: 9
stargazers_count:
type: integer
example: 80
watchers_count:
type: integer
example: 80
size:
description: >-
The size of the repository. Size is calculated hourly. When a
repository is initially created, the size is 0.
type: integer
example: 108
default_branch:
description: The default branch of the repository.
type: string
example: master
open_issues_count:
type: integer
example: 0
is_template:
description: >-
Whether this repository acts as a template that can be used to
generate new repositories.
default: false
type: boolean
example: true
topics:
type: array
items:
type: string
has_issues:
description: Whether issues are enabled.
default: true
type: boolean
example: true
has_projects:
description: Whether projects are enabled.
default: true
type: boolean
example: true
has_wiki:
description: Whether the wiki is enabled.
default: true
type: boolean
example: true
has_pages:
type: boolean
has_downloads:
description: Whether downloads are enabled.
default: true
type: boolean
example: true
has_discussions:
description: Whether discussions are enabled.
default: false
type: boolean
example: true
archived:
description: Whether the repository is archived.
default: false
type: boolean
disabled:
type: boolean
description: Returns whether or not this repository disabled.
visibility:
description: 'The repository visibility: public, private, or internal.'
default: public
type: string
pushed_at:
type: string
format: date-time
example: '2011-01-26T19:06:43.000Z'
nullable: true
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12.000Z'
nullable: true
updated_at:
type: string
format: date-time
example: '2011-01-26T19:14:43.000Z'
nullable: true
allow_rebase_merge:
description: Whether to allow rebase merges for pull requests.
default: true
type: boolean
example: true
template_repository:
type: object
properties:
id:
type: integer
node_id:
type: string
name:
type: string
full_name:
type: string
owner:
type: object
properties:
login:
type: string
id:
type: integer
node_id:
type: string
avatar_url:
type: string
gravatar_id:
type: string
url:
type: string
html_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
starred_url:
type: string
subscriptions_url:
type: string
organizations_url:
type: string
repos_url:
type: string
events_url:
type: string
received_events_url:
type: string
type:
type: string
site_admin:
type: boolean
private:
type: boolean
html_url:
type: string
description:
type: string
fork:
type: boolean
url:
type: string
archive_url:
type: string
assignees_url:
type: string
blobs_url:
type: string
branches_url:
type: string
collaborators_url:
type: string
comments_url:
type: string
commits_url:
type: string
compare_url:
type: string
contents_url:
type: string
contributors_url:
type: string
deployments_url:
type: string
downloads_url:
type: string
events_url:
type: string
forks_url:
type: string
git_commits_url:
type: string
git_refs_url:
type: string
git_tags_url:
type: string
git_url:
type: string
issue_comment_url:
type: string
issue_events_url:
type: string
issues_url:
type: string
keys_url:
type: string
labels_url:
type: string
languages_url:
type: string
merges_url:
type: string
milestones_url:
type: string
notifications_url:
type: string
pulls_url:
type: string
releases_url:
type: string
ssh_url:
type: string
stargazers_url:
type: string
statuses_url:
type: string
subscribers_url:
type: string
subscription_url:
type: string
tags_url:
type: string
teams_url:
type: string
trees_url:
type: string
clone_url:
type: string
mirror_url:
type: string
hooks_url:
type: string
svn_url:
type: string
homepage:
type: string
language:
type: string
forks_count:
type: integer
stargazers_count:
type: integer
watchers_count:
type: integer
size:
type: integer
default_branch:
type: string
open_issues_count:
type: integer
is_template:
type: boolean
topics:
type: array
items:
type: string
has_issues:
type: boolean
has_projects:
type: boolean
has_wiki:
type: boolean
has_pages:
type: boolean
has_downloads:
type: boolean
archived:
type: boolean
disabled:
type: boolean
visibility:
type: string
pushed_at:
type: string
created_at:
type: string
updated_at:
type: string
permissions:
type: object
properties:
admin:
type: boolean
maintain:
type: boolean
push:
type: boolean
triage:
type: boolean
pull:
type: boolean
allow_rebase_merge:
type: boolean
temp_clone_token:
type: string
allow_squash_merge:
type: boolean
allow_auto_merge:
type: boolean
delete_branch_on_merge:
type: boolean
allow_update_branch:
type: boolean
use_squash_pr_title_as_default:
type: boolean
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: >-
The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if
only one commit) or the pull request's title (when more than
one commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: >-
The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge
message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.
- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
allow_merge_commit:
type: boolean
subscribers_count:
type: integer
network_count:
type: integer
temp_clone_token:
type: string
allow_squash_merge:
description: Whether to allow squash merges for pull requests.
default: true
type: boolean
example: true
allow_auto_merge:
description: Whether to allow Auto-merge to be used on pull requests.
default: false
type: boolean
example: false
delete_branch_on_merge:
description: Whether to delete head branches when pull requests are merged
default: false
type: boolean
example: false
allow_update_branch:
description: >-
Whether or not a pull request head branch that is behind its base
branch can always be updated even if it is not required to be up
to date before merging.
default: false
type: boolean
example: false
use_squash_pr_title_as_default:
type: boolean
description: >-
Whether a squash merge commit can use the pull request title as
default. **This property has been deprecated. Please use
`squash_merge_commit_title` instead.
default: false
deprecated: true
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: >-
The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only
one commit) or the pull request's title (when more than one
commit).
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: |-
The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message.
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: >-
The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge
message (e.g., Merge pull request #123 from branch-name).
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: |-
The default value for a merge commit message.
- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.
allow_merge_commit:
description: Whether to allow merge commits for pull requests.
default: true
type: boolean
example: true
allow_forking:
description: Whether to allow forking this repo
type: boolean
web_commit_signoff_required:
description: Whether to require contributors to sign off on web-based commits
default: false
type: boolean
subscribers_count:
type: integer
network_count:
type: integer
open_issues:
type: integer
watchers:
type: integer
master_branch:
type: string
starred_at:
type: string
example: '"2020-07-09T00:17:42Z"'
anonymous_access_enabled:
type: boolean
description: Whether anonymous git access is enabled for this repository
forks:
type: integer
master_branch:
type: string
open_issues:
type: integer
watchers:
type: integer
anonymous_access_enabled:
description: Whether anonymous git access is allowed.
default: true
type: boolean
code_of_conduct:
type: object
title: Code Of Conduct Simple
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/github/docs/community/code_of_conduct
key:
type: string
example: citizen_code_of_conduct
name:
type: string
example: Citizen Code of Conduct
html_url:
type: string
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
security_and_analysis:
type: object
properties:
advanced_security:
type: object
properties:
status:
type: string
enum:
- enabled
- disabled
secret_scanning:
type: object
properties:
status:
type: string
enum:
- enabled
- disabled
secret_scanning_push_protection:
type: object
properties:
status:
type: string
enum:
- enabled
- disabled
machine:
type: object
title: Codespace machine
properties:
name:
type: string
description: The name of the machine.
example: standardLinux
display_name:
type: string
description: The display name of the machine includes cores, memory, and storage.
example: 4 cores, 8 GB RAM, 64 GB storage
operating_system:
type: string
description: The operating system of the machine.
example: linux
storage_in_bytes:
type: integer
description: How much storage is available to the codespace.
example: 68719476736
memory_in_bytes:
type: integer
description: How much memory is available to the codespace.
example: 8589934592
cpus:
type: integer
description: How many cores are available to the codespace.
example: 4
prebuild_availability:
type: string
description: >-
Whether a prebuild is currently available when creating a codespace
for this machine and repository. If a branch was not specified as a
ref, the default branch will be assumed. Value will be "null" if
prebuilds are not supported or prebuild availability could not be
determined. Value will be "none" if no prebuild is available. Latest
values "ready" and "in_progress" indicate the prebuild availability
status.
example: ready
enum:
- none
- ready
- in_progress
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to create Codespace.
type: string
example: .devcontainer/example/devcontainer.json
nullable: true
prebuild:
description: Whether the codespace was created from a prebuild.
type: boolean
example: false
nullable: true
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12.000Z'
updated_at:
type: string
format: date-time
example: '2011-01-26T19:01:12.000Z'
last_used_at:
description: Last known time this codespace was started.
type: string
format: date-time
example: '2011-01-26T19:01:12.000Z'
state:
description: State of this codespace.
enum:
- Unknown
- Created
- Queued
- Provisioning
- Available
- Awaiting
- Unavailable
- Deleted
- Moved
- Shutdown
- Archived
- Starting
- ShuttingDown
- Failed
- Exporting
- Updating
- Rebuilding
example: Available
type: string
url:
description: API URL for this codespace.
type: string
format: uri
git_status:
type: object
properties:
ahead:
description: The number of commits the local repository is ahead of the remote.
type: integer
example: 0
behind:
description: The number of commits the local repository is behind the remote.
type: integer
example: 0
has_unpushed_changes:
description: Whether the local repository has unpushed changes.
type: boolean
has_uncommitted_changes:
description: Whether the local repository has uncommitted changes.
type: boolean
ref:
description: >-
The current branch (or SHA if in detached HEAD state) of the local
repository.
type: string
example: main
location:
description: The initally assigned location of a new codespace.
enum:
- EastUs
- SouthEastAsia
- WestEurope
- WestUs2
example: WestUs2
type: string
idle_timeout_minutes:
description: >-
The number of minutes of inactivity after which this codespace will be
automatically stopped.
type: integer
example: 60
nullable: true
web_url:
description: URL to access this codespace on the web.
type: string
format: uri
machines_url:
description: API URL to access available alternate machine types for this codespace.
type: string
format: uri
start_url:
description: API URL to start this codespace.
type: string
format: uri
stop_url:
description: API URL to stop this codespace.
type: string
format: uri
publish_url:
description: API URL to publish this codespace to a new repository.
type: string
format: uri
nullable: true
pulls_url:
description: API URL for the Pull Request associated with this codespace, if any.
type: string
format: uri
nullable: true
recent_folders:
type: array
items:
type: string
runtime_constraints:
type: object
properties:
allowed_port_privacy_settings:
description: The privacy settings a user can select from when forwarding a port.
type: array
nullable: true
items:
type: string
pending_operation:
description: >-
Whether or not a codespace has a pending async operation. This would mean
that the codespace is temporarily unavailable. The only thing that you can
do with a codespace in this state is delete it.
type: boolean
nullable: true
pending_operation_disabled_reason:
description: Text to show user when codespace is disabled by a pending operation
type: string
nullable: true
idle_timeout_notice:
description: >-
Text to show user when codespace idle timeout minutes has been overriden
by an organization policy
type: string
nullable: true
retention_period_minutes:
description: >-
Duration in minutes after codespace has gone idle in which it will be
deleted. Must be integer minutes between 0 and 43200 (30 days).
type: integer
example: 60
nullable: true
retention_expires_at:
description: >-
When a codespace will be auto-deleted based on the
"retention_period_minutes" and "last_used_at"
type: string
format: date-time
example: '2011-01-26T20:01:12.000Z'
nullable: true