Get a repository

When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.

The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

返回响应

🟢200Response

application/json

Body

Full Repository

allow_merge_commit

boolean

可选

示例值:

true

allow_rebase_merge

boolean

可选

示例值:

true

allow_squash_merge

boolean

可选

示例值:

true

anonymous_access_enabled

boolean

可选

Whether anonymous git access is allowed.

默认值:

true

archive_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

archived

boolean

必需

assignees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/branches{/branch}

clone_url

string

必需

示例值:

https://github.com/octocat/Hello-World.git

code_of_conduct

object (Code Of Conduct Simple)

可选

Code of Conduct Simple

html_url

string <uri> | null

必需

示例值:

https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md

key

string

必需

示例值:

citizen_code_of_conduct

name

string

必需

示例值:

Citizen Code of Conduct

url

string <uri>

必需

示例值:

https://api.github.com/repos/github/docs/community/code_of_conduct

collaborators_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contributors

created_at

string <date-time>

必需

示例值:

2011-01-26T19:01:12Z

default_branch

string

必需

示例值:

master

delete_branch_on_merge

boolean

可选

示例值:

false

deployments_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/deployments

description

string | null

必需

示例值:

This your first repo!

disabled

boolean

必需

Returns whether or not this repository disabled.

downloads_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/downloads

events_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/events

fork

boolean

必需

forks

integer

必需

forks_count

integer

必需

示例值:

forks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/forks

full_name

string

必需

示例值:

octocat/Hello-World

git_commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

git_url

string

必需

示例值:

git:github.com/octocat/Hello-World.git

has_advanced_security

boolean

可选

示例值:

true

has_downloads

boolean

必需

示例值:

true

has_issues

boolean

必需

示例值:

true

has_pages

boolean

必需

has_projects

boolean

必需

示例值:

true

has_wiki

boolean

必需

示例值:

true

homepage

string <uri> | null

必需

示例值:

https://github.com

hooks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/hooks

html_url

string <uri>

必需

示例值:

https://github.com/octocat/Hello-World

integer

必需

示例值:

1296269

is_template

boolean

可选

示例值:

true

issue_comment_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/labels{/name}

language

string | null

必需

languages_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/languages

license

null | allOf {1}

必需

object (License Simple)

可选

License Simple

master_branch

string

可选

merges_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/merges

milestones_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/milestones{/number}

mirror_url

string <uri> | null

必需

示例值:

git:git.example.com/octocat/Hello-World

name

string

必需

示例值:

Hello-World

network_count

integer

必需

示例值:

node_id

string

必需

示例值:

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

notifications_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

open_issues

integer

必需

open_issues_count

integer

必需

示例值:

organization

null

可选

Simple User

owner

object (Simple User) | null

必需

Simple User

avatar_url

string <uri>

必需

示例值:

https://github.com/images/error/octocat_happy.gif

events_url

string

必需

示例值:

https://api.github.com/users/octocat/events{/privacy}

followers_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/followers

following_url

string

必需

示例值:

https://api.github.com/users/octocat/following{/other_user}

gists_url

string

必需

示例值:

https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id

string | null

必需

示例值:

41d064eb2195891e12d0413f63227ea7

html_url

string <uri>

必需

示例值:

https://github.com/octocat

integer

必需

示例值:

string

必需

示例值:

octocat

node_id

string

必需

示例值:

MDQ6VXNlcjE=

organizations_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/orgs

received_events_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/received_events

repos_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/repos

site_admin

boolean

必需

starred_at

string

可选

示例值:

"2020-07-09T00:17:55Z"

starred_url

string

必需

示例值:

https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/subscriptions

type

string

必需

示例值:

User

url

string <uri>

必需

示例值:

https://api.github.com/users/octocat

parent

object (Repository)

可选

A git repository

allow_merge_commit

boolean

可选

Whether to allow merge commits for pull requests.

默认值:

true

示例值:

true

allow_rebase_merge

boolean

可选

Whether to allow rebase merges for pull requests.

默认值:

true

示例值:

true

allow_squash_merge

boolean

可选

Whether to allow squash merges for pull requests.

默认值:

true

示例值:

true

archive_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

archived

boolean

必需

Whether the repository is archived.

默认值:

false

assignees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/branches{/branch}

clone_url

string

必需

示例值:

https://github.com/octocat/Hello-World.git

collaborators_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contributors

created_at

string <date-time> | null

必需

示例值:

2011-01-26T19:01:12Z

default_branch

string

必需

The default branch of the repository.

示例值:

master

delete_branch_on_merge

boolean

可选

Whether to delete head branches when pull requests are merged

默认值:

false

示例值:

false

deployments_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/deployments

description

string | null

必需

示例值:

This your first repo!

disabled

boolean

必需

Returns whether or not this repository disabled.

downloads_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/downloads

events_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/events

fork

boolean

必需

forks

integer

必需

forks_count

integer

必需

示例值:

forks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/forks

full_name

string

必需

示例值:

octocat/Hello-World

git_commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

git_url

string

必需

示例值:

git:github.com/octocat/Hello-World.git

has_downloads

boolean

必需

Whether downloads are enabled.

默认值:

true

示例值:

true

has_issues

boolean

必需

Whether issues are enabled.

默认值:

true

示例值:

true

has_pages

boolean

必需

has_projects

boolean

必需

Whether projects are enabled.

默认值:

true

示例值:

true

has_wiki

boolean

必需

Whether the wiki is enabled.

默认值:

true

示例值:

true

homepage

string <uri> | null

必需

示例值:

https://github.com

hooks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/hooks

html_url

string <uri>

必需

示例值:

https://github.com/octocat/Hello-World

integer

必需

Unique identifier of the repository

示例值:

is_template

boolean

可选

Whether this repository acts as a template that can be used to generate new repositories.

默认值:

false

示例值:

true

issue_comment_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/labels{/name}

language

string | null

必需

languages_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/languages

license

null | allOf {1}

必需

master_branch

string

可选

merges_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/merges

milestones_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/milestones{/number}

mirror_url

string <uri> | null

必需

示例值:

git:git.example.com/octocat/Hello-World

name

string

必需

The name of the repository.

示例值:

Team Environment

network_count

integer

可选

node_id

string

必需

示例值:

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

notifications_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

open_issues

integer

必需

open_issues_count

integer

必需

示例值:

organization

null

可选

Simple User

owner

null

必需

Simple User

permissions

object

可选

private

boolean

必需

Whether the repository is private or public.

默认值:

false

pulls_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/pulls{/number}

pushed_at

string <date-time> | null

必需

示例值:

2011-01-26T19:06:43Z

releases_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/releases{/id}

size

integer

必需

示例值:

108

ssh_url

string

必需

示例值:

git@github.com:octocat/Hello-World.git

stargazers_count

integer

必需

示例值:

stargazers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/stargazers

starred_at

string

可选

示例值:

"2020-07-09T00:17:42Z"

statuses_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_count

integer

可选

subscribers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscribers

subscription_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscription

svn_url

string <uri>

必需

示例值:

https://svn.github.com/octocat/Hello-World

tags_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/tags

teams_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/teams

temp_clone_token

string

可选

template_repository

object | null

可选

topics

array[string]

可选

trees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

updated_at

string <date-time> | null

必需

示例值:

2011-01-26T19:14:43Z

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World

visibility

string

可选

The repository visibility: public, private, or internal.

默认值:

public

watchers

integer

必需

watchers_count

integer

必需

示例值:

permissions

object

可选

admin

boolean

必需

pull

boolean

必需

push

boolean

必需

private

boolean

必需

pulls_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/pulls{/number}

pushed_at

string <date-time>

必需

示例值:

2011-01-26T19:06:43Z

releases_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/releases{/id}

size

integer

必需

示例值:

108

source

object (Repository)

可选

A git repository

ssh_url

string

必需

示例值:

git@github.com:octocat/Hello-World.git

stargazers_count

integer

必需

示例值:

stargazers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/stargazers

statuses_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_count

integer

必需

示例值:

subscribers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscribers

subscription_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscription

svn_url

string <uri>

必需

示例值:

https://svn.github.com/octocat/Hello-World

tags_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/tags

teams_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/teams

temp_clone_token

string | null

可选

template_repository

object | null | allOf {1}

可选

#/components/schemas/repository

可选

topics

array[string]

可选

示例值:

["octocat","atom","electron","API"]

trees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

updated_at

string <date-time>

必需

示例值:

2011-01-26T19:14:43Z

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World

visibility

string

可选

The repository visibility: public, private, or internal.

示例值:

public

watchers

integer

必需

watchers_count

integer

必需

示例值:

🔵301301

🟠403403

🟠404404

请求参数

返回响应