Created
December 13, 2023 03:51
-
-
Save tulik/cc9278fe314beb65553c595c40e5d71a to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: 3.0.0 | |
info: | |
title: GitHub v3 REST API | |
description: |- | |
GitHub's v3 REST API. | |
Contact Support: | |
Name: Support | |
version: 1.0.0 | |
servers: | |
- url: http://{{baseurl}} | |
tags: | |
- name: repos | |
- name: repos > {owner}/{repo} | |
- name: repos > {owner}/{repo} > branches | |
- name: repos > {owner}/{repo} > branches > {branch} | |
- name: repos > {owner}/{repo} > branches > {branch} > protection | |
- name: repos > {owner}/{repo} > branches > {branch} > protection > enforce_admins | |
- name: >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_pull_request_reviews | |
- name: >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_signatures | |
- name: >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_status_checks | |
- name: >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_status_checks > contexts | |
- name: repos > {owner}/{repo} > branches > {branch} > protection > restrictions | |
- name: >- | |
repos > {owner}/{repo} > branches > {branch} > protection > restrictions > | |
apps | |
- name: >- | |
repos > {owner}/{repo} > branches > {branch} > protection > restrictions > | |
teams | |
- name: >- | |
repos > {owner}/{repo} > branches > {branch} > protection > restrictions > | |
users | |
- name: repos > {owner}/{repo} > commits | |
- name: repos > {owner}/{repo} > commits > {commit_sha} | |
- name: repos > {owner}/{repo} > commits > {commit_sha} > comments | |
- name: repos > {owner}/{repo} > commits > {ref} | |
- name: repos > {owner}/{repo} > contents/{path} | |
- name: repos > {owner}/{repo} > dependency-graph | |
- name: repos > {owner}/{repo} > git | |
- name: repos > {owner}/{repo} > git > blobs | |
- name: repos > {owner}/{repo} > git > commits | |
- name: repos > {owner}/{repo} > git > refs | |
- name: repos > {owner}/{repo} > git > refs > {ref} | |
- name: repos > {owner}/{repo} > git > tags | |
- name: repos > {owner}/{repo} > git > trees | |
- name: repos > {owner}/{repo} > interaction-limits | |
- name: repos > {owner}/{repo} > pulls | |
- name: repos > {owner}/{repo} > pulls > comments | |
- name: repos > {owner}/{repo} > pulls > comments > {comment_id} | |
- name: repos > {owner}/{repo} > pulls > {pull_number} | |
- name: repos > {owner}/{repo} > pulls > {pull_number} > comments | |
- name: repos > {owner}/{repo} > pulls > {pull_number} > merge | |
- name: repos > {owner}/{repo} > pulls > {pull_number} > requested_reviewers | |
- name: repos > {owner}/{repo} > pulls > {pull_number} > reviews | |
- name: repos > {owner}/{repo} > pulls > {pull_number} > reviews > {review_id} | |
- name: repos > {owner}/{repo} > readme | |
- name: repositories | |
- name: search | |
paths: | |
/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins: | |
get: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
enforce_admins | |
summary: Get admin branch protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <uri> | |
enabled: <boolean> | |
post: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
enforce_admins | |
summary: Set admin branch protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Adding admin enforcement requires admin or owner permissions to the | |
repository and branch protection to be enabled. | |
requestBody: | |
content: {} | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <uri> | |
enabled: <boolean> | |
delete: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
enforce_admins | |
summary: Delete admin branch protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Removing admin enforcement requires admin or owner permissions to the | |
repository and branch protection to be enabled. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'204': | |
description: No Content | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews: | |
get: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_pull_request_reviews | |
summary: Get pull request review protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
dismiss_stale_reviews: <boolean> | |
require_code_owner_reviews: <boolean> | |
url: <uri> | |
dismissal_restrictions: | |
users: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
url: <string> | |
users_url: <string> | |
teams_url: <string> | |
bypass_pull_request_allowances: | |
users: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
required_approving_review_count: <integer> | |
require_last_push_approval: false | |
patch: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_pull_request_reviews | |
summary: Update pull request review protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Updating pull request review enforcement requires admin or owner | |
permissions to the repository and branch protection to be enabled. | |
**Note**: Passing new arrays of `users` and `teams` replaces their | |
previous values. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
dismissal_restrictions: | |
users: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
dismiss_stale_reviews: <boolean> | |
require_code_owner_reviews: <boolean> | |
required_approving_review_count: <integer> | |
require_last_push_approval: false | |
bypass_pull_request_allowances: | |
users: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
dismiss_stale_reviews: <boolean> | |
require_code_owner_reviews: <boolean> | |
url: <uri> | |
dismissal_restrictions: | |
users: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
url: <string> | |
users_url: <string> | |
teams_url: <string> | |
bypass_pull_request_allowances: | |
users: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
required_approving_review_count: <integer> | |
require_last_push_approval: false | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_pull_request_reviews | |
summary: Delete pull request review protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'204': | |
description: No Content | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures: | |
get: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_signatures | |
summary: Get commit signature protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
When authenticated with admin or owner permissions to the repository, | |
you can use this endpoint to check whether a branch requires signed | |
commits. An enabled status of `true` indicates you must sign commits on | |
this branch. For more information, see [Signing commits with | |
GPG](https://docs.github.com/articles/signing-commits-with-gpg) in | |
GitHub Help. | |
**Note**: You must enable branch protection to require signed commits. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <uri> | |
enabled: <boolean> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
post: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_signatures | |
summary: Create commit signature protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
When authenticated with admin or owner permissions to the repository, | |
you can use this endpoint to require signed commits on a branch. You | |
must enable branch protection to require signed commits. | |
requestBody: | |
content: {} | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <uri> | |
enabled: <boolean> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
delete: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_signatures | |
summary: Delete commit signature protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
When authenticated with admin or owner permissions to the repository, | |
you can use this endpoint to disable required signed commits on a | |
branch. You must enable branch protection to require signed commits. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'204': | |
description: No Content | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts: | |
get: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_status_checks > contexts | |
summary: Get all status check contexts | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- <string> | |
- <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
post: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_status_checks > contexts | |
summary: Add status check contexts | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
contexts: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- <string> | |
- <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
put: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_status_checks > contexts | |
summary: Set status check contexts | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
contexts: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- <string> | |
- <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_status_checks > contexts | |
summary: Remove status check contexts | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- <string> | |
- <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks: | |
get: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_status_checks | |
summary: Get status checks protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <uri> | |
contexts_url: <uri> | |
strict: <boolean> | |
contexts: | |
- <string> | |
- <string> | |
checks: | |
- context: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
app_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- context: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
app_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
patch: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_status_checks | |
summary: Update status check protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Updating required status checks requires admin or owner permissions to | |
the repository and branch protection to be enabled. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
strict: <boolean> | |
contexts: | |
- <string> | |
- <string> | |
checks: | |
- context: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
app_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- context: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
app_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <uri> | |
contexts_url: <uri> | |
strict: <boolean> | |
contexts: | |
- <string> | |
- <string> | |
checks: | |
- context: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
app_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- context: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
app_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
required_status_checks | |
summary: Remove status check protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
parameters: | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'204': | |
description: No Content | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps: | |
get: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > apps | |
summary: Get apps with access to the protected branch | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Lists the GitHub Apps that have push access to this branch. Only | |
installed GitHub Apps with `write` access to the `contents` permission | |
can be added as authorized actors on a protected branch. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
external_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
installations_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
webhook_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pem: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
external_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
installations_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
webhook_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pem: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
post: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > apps | |
summary: Add app access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Grants the specified apps push access for this branch. Only installed | |
GitHub Apps with `write` access to the `contents` permission can be | |
added as authorized actors on a protected branch. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
apps: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
external_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
installations_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
webhook_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pem: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
external_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
installations_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
webhook_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pem: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
put: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > apps | |
summary: Set app access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Replaces the list of apps that have push access to this branch. This | |
removes all apps that previously had push access and grants push access | |
to the new list of apps. Only installed GitHub Apps with `write` access | |
to the `contents` permission can be added as authorized actors on a | |
protected branch. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
apps: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
external_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
installations_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
webhook_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pem: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
external_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
installations_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
webhook_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pem: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > apps | |
summary: Remove app access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Removes the ability of an app to push to this branch. Only installed | |
GitHub Apps with `write` access to the `contents` permission can be | |
added as authorized actors on a protected branch. | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
external_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
installations_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
webhook_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pem: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
external_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
installations_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
client_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
webhook_secret: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pem: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams: | |
get: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > teams | |
summary: Get teams with access to the protected branch | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Lists the teams who have push access to this branch. The list includes | |
child teams. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
post: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > teams | |
summary: Add team access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Grants the specified teams push access for this branch. You can also | |
give push access to child teams. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
put: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > teams | |
summary: Set team access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Replaces the list of teams that have push access to this branch. This | |
removes all teams that previously had push access and grants push access | |
to the new list of teams. Team restrictions include child teams. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > teams | |
summary: Remove team access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Removes the ability of a team to push to this branch. You can also | |
remove push access for child teams. | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users: | |
get: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > users | |
summary: Get users with access to the protected branch | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Lists the people who have push access to this branch. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
post: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > users | |
summary: Add user access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Grants the specified people push access for this branch. | |
| Type | | |
Description | |
| | |
| ------- | | |
----------------------------------------------------------------------------------------------------------------------------- | |
| | |
| `array` | Usernames for people who can have push access. **Note**: The | |
list of users, apps, and teams in total is limited to 100 items. | | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
users: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
put: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > users | |
summary: Set user access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Replaces the list of people that have push access to this branch. This | |
removes all people that previously had push access and grants push | |
access to the new list of people. | |
| Type | | |
Description | |
| | |
| ------- | | |
----------------------------------------------------------------------------------------------------------------------------- | |
| | |
| `array` | Usernames for people who can have push access. **Note**: The | |
list of users, apps, and teams in total is limited to 100 items. | | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
users: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions > users | |
summary: Remove user access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Removes the ability of a user to push to this branch. | |
| Type | | |
Description | |
| | |
| ------- | | |
--------------------------------------------------------------------------------------------------------------------------------------------- | |
| | |
| `array` | Usernames of the people who should no longer have push | |
access. **Note**: The list of users, apps, and teams in total is limited | |
to 100 items. | | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions: | |
get: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions | |
summary: Get access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Lists who has access to this protected branch. | |
**Note**: Users, apps, and teams `restrictions` are only available for | |
organization-owned repositories. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <uri> | |
users_url: <uri> | |
teams_url: <uri> | |
apps_url: <uri> | |
users: | |
- login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
external_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
external_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
delete: | |
tags: | |
- >- | |
repos > {owner}/{repo} > branches > {branch} > protection > | |
restrictions | |
summary: Delete access restrictions | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Disables the ability to restrict who can push to this branch. | |
parameters: | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'204': | |
description: No Content | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
/repos/{owner}/{repo}/branches/{branch}/protection: | |
get: | |
tags: | |
- repos > {owner}/{repo} > branches > {branch} > protection | |
summary: Get branch protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <string> | |
enabled: <boolean> | |
required_status_checks: | |
contexts: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
checks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
enforcement_level: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contexts_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
strict: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
enforce_admins: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
enabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_pull_request_reviews: | |
dismiss_stale_reviews: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
require_code_owner_reviews: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
dismissal_restrictions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
bypass_pull_request_allowances: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_approving_review_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
require_last_push_approval: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
restrictions: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
users_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
apps_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
users: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_linear_history: | |
enabled: <boolean> | |
allow_force_pushes: | |
enabled: <boolean> | |
allow_deletions: | |
enabled: <boolean> | |
block_creations: | |
enabled: <boolean> | |
required_conversation_resolution: | |
enabled: <boolean> | |
name: <string> | |
protection_url: <string> | |
required_signatures: | |
url: <uri> | |
enabled: <boolean> | |
lock_branch: | |
enabled: false | |
allow_fork_syncing: | |
enabled: false | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
put: | |
tags: | |
- repos > {owner}/{repo} > branches > {branch} > protection | |
summary: Update branch protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Protecting a branch requires admin or owner permissions to the | |
repository. | |
**Note**: Passing new arrays of `users` and `teams` replaces their | |
previous values. | |
**Note**: The list of users, apps, and teams in total is limited to 100 | |
items. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
required_status_checks: | |
strict: <boolean> | |
contexts: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
checks: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
enforce_admins: <boolean,null> | |
required_pull_request_reviews: | |
dismissal_restrictions: | |
users: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
dismiss_stale_reviews: <boolean> | |
require_code_owner_reviews: <boolean> | |
required_approving_review_count: <integer> | |
require_last_push_approval: false | |
bypass_pull_request_allowances: | |
users: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
restrictions: | |
users: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
required_linear_history: <boolean> | |
allow_force_pushes: <boolean,null> | |
allow_deletions: <boolean> | |
block_creations: <boolean> | |
required_conversation_resolution: <boolean> | |
lock_branch: false | |
allow_fork_syncing: false | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <uri> | |
required_status_checks: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contexts_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
strict: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contexts: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
checks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_pull_request_reviews: | |
url: <uri> | |
dismiss_stale_reviews: <boolean> | |
require_code_owner_reviews: <boolean> | |
required_approving_review_count: <integer> | |
require_last_push_approval: false | |
dismissal_restrictions: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
users_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
users: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
bypass_pull_request_allowances: | |
users: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_signatures: | |
url: <uri> | |
enabled: <boolean> | |
enforce_admins: | |
url: <uri> | |
enabled: <boolean> | |
required_linear_history: | |
enabled: <boolean> | |
allow_force_pushes: | |
enabled: <boolean> | |
allow_deletions: | |
enabled: <boolean> | |
restrictions: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
users_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
apps_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
users: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
apps: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_conversation_resolution: | |
enabled: <boolean> | |
block_creations: | |
enabled: <boolean> | |
lock_branch: | |
enabled: false | |
allow_fork_syncing: | |
enabled: false | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- <string> | |
- <string> | |
delete: | |
tags: | |
- repos > {owner}/{repo} > branches > {branch} > protection | |
summary: Delete branch protection | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'204': | |
description: No Content | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/branches/{branch}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > branches > {branch} | |
summary: Get a branch | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
name: <string> | |
commit: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
committer: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parents: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stats: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
files: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
_links: | |
html: <string> | |
self: <uri> | |
protection: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
enabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_status_checks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
enforce_admins: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_pull_request_reviews: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
restrictions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_linear_history: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_force_pushes: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_deletions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
block_creations: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_conversation_resolution: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
protection_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
required_signatures: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
lock_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_fork_syncing: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
protected: <boolean> | |
protection_url: <uri> | |
pattern: <string> | |
required_approving_review_count: <integer> | |
'301': | |
description: Moved Permanently | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/branches: | |
get: | |
tags: | |
- repos > {owner}/{repo} > branches | |
summary: List branches | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: protected | |
in: query | |
schema: | |
type: string | |
description: >- | |
Setting to `true` returns only protected branches. When set to | |
`false`, only unprotected branches are returned. Omitting this | |
parameter returns all branches. | |
example: <boolean> | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
protected: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
protection: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
protection_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
protected: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
protection: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
protection_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/commits/{commit_sha}/comments: | |
get: | |
tags: | |
- repos > {owner}/{repo} > commits > {commit_sha} > comments | |
summary: List commit comments | |
description: >- | |
Use the `:commit_sha` to specify the commit that will have its comments | |
listed. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: commit_sha | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The SHA of the commit. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reactions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reactions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head: | |
get: | |
tags: | |
- repos > {owner}/{repo} > commits > {commit_sha} | |
summary: List branches for HEAD commit | |
description: >- | |
Protected branches are available in public repositories with GitHub Free | |
and GitHub Free for organizations, and in public and private | |
repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and | |
GitHub Enterprise Server. For more information, see [GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Returns all branches where the given commit SHA is the HEAD, or latest | |
commit for the branch. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: commit_sha | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The SHA of the commit. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
protected: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
protected: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/commits/{commit_sha}/pulls: | |
get: | |
tags: | |
- repos > {owner}/{repo} > commits > {commit_sha} | |
summary: List pull requests associated with a commit | |
description: >- | |
Lists the merged pull request that introduced the commit to the | |
repository. If the commit is not present in the default branch, will | |
only return open pull requests associated with the commit. | |
To list the open or merged pull requests associated with a branch, you | |
can set the `commit_sha` parameter to the branch name. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: commit_sha | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The SHA of the commit. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- _links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignee: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
base: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
closed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
diff_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
head: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_commit_sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merged_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestone: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
number: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
patch_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
locked: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
auto_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
active_lock_reason: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_reviewers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_teams: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
draft: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- _links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignee: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
base: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
closed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
diff_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
head: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_commit_sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merged_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestone: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
number: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
patch_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
locked: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
auto_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
active_lock_reason: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_reviewers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_teams: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
draft: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/commits/{ref}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > commits > {ref} | |
summary: Get a commit | |
description: >- | |
Returns the contents of a single commit reference. You must have `read` | |
access for the repository to use this endpoint. | |
**Note:** If there are more than 300 files in the commit diff, the | |
response will include pagination link headers for the remaining files, | |
up to a limit of 3000 files. Each page contains the static commit | |
information, and the only changes are to the file listing. | |
You can pass the appropriate [media | |
type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) | |
to fetch `diff` and `patch` formats. Diffs with binary data will have | |
no `patch` property. | |
To return only the SHA-1 hash of the commit reference, you can provide | |
the `sha` custom [media | |
type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) | |
in the `Accept` header. You can use this endpoint to check if a remote | |
reference's SHA-1 hash is the same as your local reference's SHA-1 hash | |
by providing the local SHA-1 reference as the ETag. | |
**Signature verification object** | |
The response will include a `verification` object that describes the | |
result of verifying the commit's signature. The following fields are | |
included in the `verification` object: | |
| Name | Type | Description | | |
| ---- | ---- | ----------- | | |
| `verified` | `boolean` | Indicates whether GitHub considers the | |
signature in this commit to be verified. | | |
| `reason` | `string` | The reason for verified value. Possible values | |
and their meanings are enumerated in table below. | | |
| `signature` | `string` | The signature that was extracted from the | |
commit. | | |
| `payload` | `string` | The value that was signed. | | |
These are the possible values for `reason` in the `verification` object: | |
| Value | Description | | |
| ----- | ----------- | | |
| `expired_key` | The key that made the signature is expired. | | |
| `not_signing_key` | The "signing" flag is not among the usage flags in | |
the GPG key that made the signature. | | |
| `gpgverify_error` | There was an error communicating with the | |
signature verification service. | | |
| `gpgverify_unavailable` | The signature verification service is | |
currently unavailable. | | |
| `unsigned` | The object does not include a signature. | | |
| `unknown_signature_type` | A non-PGP signature was found in the | |
commit. | | |
| `no_user` | No user was associated with the `committer` email address | |
in the commit. | | |
| `unverified_email` | The `committer` email address in the commit was | |
associated with a user, but the email address is not verified on their | |
account. | | |
| `bad_email` | The `committer` email address in the commit is not | |
included in the identities of the PGP key that made the signature. | | |
| `unknown_key` | The key that made the signature has not been | |
registered with any user's account. | | |
| `malformed_signature` | There was an error parsing the signature. | | |
| `invalid` | The signature could not be cryptographically verified | |
using the key whose key-id was found in the signature. | | |
| `valid` | None of the above errors applied, so the signature is | |
considered to be verified. | | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The commit reference. Can be a commit SHA, branch name | |
(`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more | |
information, see "[Git | |
References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" | |
in the Git documentation. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <uri> | |
sha: <string> | |
node_id: <string> | |
html_url: <uri> | |
comments_url: <uri> | |
commit: | |
author: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
committer: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comment_count: <integer> | |
message: <string> | |
tree: | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: <uri> | |
verification: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author: <null> | |
committer: <null> | |
parents: | |
- sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stats: | |
additions: <integer> | |
deletions: <integer> | |
total: <integer> | |
files: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'500': | |
description: Internal Server Error | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'503': | |
description: Service Unavailable | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
code: <string> | |
message: <string> | |
documentation_url: <string> | |
/repos/{owner}/{repo}/commits/{ref}/check-runs: | |
get: | |
tags: | |
- repos > {owner}/{repo} > commits > {ref} | |
summary: List check runs for a Git reference | |
description: >- | |
Lists check runs for a commit ref. The `ref` can be a SHA, branch name, | |
or a tag name. GitHub Apps must have the `checks:read` permission on a | |
private repository or pull access to a public repository to get check | |
runs. OAuth apps and authenticated users must have the `repo` scope to | |
get check runs in a private repository. | |
**Note:** The endpoints to manage checks only look for pushes in the | |
repository where the check suite or check run were created. Pushes to a | |
branch in a forked repository are not detected and return an empty | |
`pull_requests` array. | |
If there are more than 1000 check suites on a single git reference, this | |
endpoint will limit check runs to the 1000 most recent check suites. To | |
iterate over all possible check runs, use the [List check suites for a | |
Git | |
reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) | |
endpoint and provide the `check_suite_id` parameter to the [List check | |
runs in a check | |
suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) | |
endpoint. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: check_name | |
in: query | |
schema: | |
type: string | |
description: Returns check runs with the specified `name`. | |
example: <string> | |
- name: status | |
in: query | |
schema: | |
type: string | |
description: Returns check runs with the specified `status`. | |
example: <string> | |
- name: filter | |
in: query | |
schema: | |
type: string | |
description: >- | |
Filters check runs by their `completed_at` timestamp. `latest` | |
returns the most recent check runs. | |
example: latest | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: app_id | |
in: query | |
schema: | |
type: string | |
example: <integer> | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The commit reference. Can be a commit SHA, branch name | |
(`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more | |
information, see "[Git | |
References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" | |
in the Git documentation. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
total_count: <integer> | |
check_runs: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/commits/{ref}/check-suites: | |
get: | |
tags: | |
- repos > {owner}/{repo} > commits > {ref} | |
summary: List check suites for a Git reference | |
description: >- | |
Lists check suites for a commit `ref`. The `ref` can be a SHA, branch | |
name, or a tag name. GitHub Apps must have the `checks:read` permission | |
on a private repository or pull access to a public repository to list | |
check suites. OAuth apps and authenticated users must have the `repo` | |
scope to get check suites in a private repository. | |
**Note:** The endpoints to manage checks only look for pushes in the | |
repository where the check suite or check run were created. Pushes to a | |
branch in a forked repository are not detected and return an empty | |
`pull_requests` array and a `null` value for `head_branch`. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: app_id | |
in: query | |
schema: | |
type: string | |
description: Filters check suites by GitHub App `id`. | |
example: <integer> | |
- name: check_name | |
in: query | |
schema: | |
type: string | |
description: Returns check runs with the specified `name`. | |
example: <string> | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The commit reference. Can be a commit SHA, branch name | |
(`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more | |
information, see "[Git | |
References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" | |
in the Git documentation. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
total_count: <integer> | |
check_suites: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/commits/{ref}/status: | |
get: | |
tags: | |
- repos > {owner}/{repo} > commits > {ref} | |
summary: Get the combined status for a specific reference | |
description: >- | |
Users with pull access in a repository can access a combined view of | |
commit statuses for a given ref. The ref can be a SHA, a branch name, or | |
a tag name. | |
Additionally, a combined `state` is returned. The `state` is one of: | |
* **failure** if any of the contexts report as `error` or `failure` | |
* **pending** if there are no statuses or a context is `pending` | |
* **success** if the latest status for all contexts is `success` | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The commit reference. Can be a commit SHA, branch name | |
(`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more | |
information, see "[Git | |
References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" | |
in the Git documentation. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
state: <string> | |
sha: <string> | |
total_count: <integer> | |
statuses: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
repository: | |
archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
role_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete_branch_on_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
network_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
code_of_conduct: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
security_and_analysis: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_url: <uri> | |
url: <uri> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/commits/{ref}/statuses: | |
get: | |
tags: | |
- repos > {owner}/{repo} > commits > {ref} | |
summary: List commit statuses for a reference | |
description: >- | |
Users with pull access in a repository can view commit statuses for a | |
given ref. The ref can be a SHA, a branch name, or a tag name. Statuses | |
are returned in reverse chronological order. The first status in the | |
list will be the latest one. | |
This resource is also available via a legacy route: `GET | |
/repos/:owner/:repo/statuses/:ref`. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The commit reference. Can be a commit SHA, branch name | |
(`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more | |
information, see "[Git | |
References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" | |
in the Git documentation. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
target_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
context: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
creator: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
target_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
context: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
creator: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'301': | |
description: Moved Permanently | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/commits: | |
get: | |
tags: | |
- repos > {owner}/{repo} > commits | |
summary: List commits | |
description: >- | |
**Signature verification object** | |
The response will include a `verification` object that describes the | |
result of verifying the commit's signature. The following fields are | |
included in the `verification` object: | |
| Name | Type | Description | | |
| ---- | ---- | ----------- | | |
| `verified` | `boolean` | Indicates whether GitHub considers the | |
signature in this commit to be verified. | | |
| `reason` | `string` | The reason for verified value. Possible values | |
and their meanings are enumerated in table below. | | |
| `signature` | `string` | The signature that was extracted from the | |
commit. | | |
| `payload` | `string` | The value that was signed. | | |
These are the possible values for `reason` in the `verification` object: | |
| Value | Description | | |
| ----- | ----------- | | |
| `expired_key` | The key that made the signature is expired. | | |
| `not_signing_key` | The "signing" flag is not among the usage flags in | |
the GPG key that made the signature. | | |
| `gpgverify_error` | There was an error communicating with the | |
signature verification service. | | |
| `gpgverify_unavailable` | The signature verification service is | |
currently unavailable. | | |
| `unsigned` | The object does not include a signature. | | |
| `unknown_signature_type` | A non-PGP signature was found in the | |
commit. | | |
| `no_user` | No user was associated with the `committer` email address | |
in the commit. | | |
| `unverified_email` | The `committer` email address in the commit was | |
associated with a user, but the email address is not verified on their | |
account. | | |
| `bad_email` | The `committer` email address in the commit is not | |
included in the identities of the PGP key that made the signature. | | |
| `unknown_key` | The key that made the signature has not been | |
registered with any user's account. | | |
| `malformed_signature` | There was an error parsing the signature. | | |
| `invalid` | The signature could not be cryptographically verified | |
using the key whose key-id was found in the signature. | | |
| `valid` | None of the above errors applied, so the signature is | |
considered to be verified. | | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: sha | |
in: query | |
schema: | |
type: string | |
description: >- | |
SHA or branch to start listing commits from. Default: the | |
repository’s default branch (usually `main`). | |
example: <string> | |
- name: path | |
in: query | |
schema: | |
type: string | |
description: Only commits containing this file path will be returned. | |
example: <string> | |
- name: author | |
in: query | |
schema: | |
type: string | |
description: GitHub username or email address to use to filter by commit author. | |
example: <string> | |
- name: committer | |
in: query | |
schema: | |
type: string | |
description: >- | |
GitHub username or email address to use to filter by commit | |
committer. | |
example: <string> | |
- name: since | |
in: query | |
schema: | |
type: string | |
description: >- | |
Only show results that were last updated after the given time. This | |
is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) | |
format: `YYYY-MM-DDTHH:MM:SSZ`. | |
example: <dateTime> | |
- name: until | |
in: query | |
schema: | |
type: string | |
description: >- | |
Only commits before this date will be returned. This is a timestamp | |
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: | |
`YYYY-MM-DDTHH:MM:SSZ`. | |
example: <dateTime> | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
committer: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parents: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stats: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
files: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
committer: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parents: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stats: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
files: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'400': | |
description: Bad Request | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'409': | |
description: Conflict | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'500': | |
description: Internal Server Error | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/contents/{path}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > contents/{path} | |
summary: Get repository content | |
description: >- | |
Gets the contents of a file or directory in a repository. Specify the | |
file path or directory in `:path`. If you omit | |
`:path`, you will receive the contents of the repository's root | |
directory. See the description below regarding what the API response | |
includes for directories. | |
Files and symlinks support [a custom media | |
type](https://docs.github.com/rest/overview/media-types) for | |
retrieving the raw content or rendered HTML (when supported). All | |
content types support [a custom media | |
type](https://docs.github.com/rest/overview/media-types) to ensure the | |
content is returned in a consistent | |
object format. | |
**Notes**: | |
* To get a repository's contents recursively, you can [recursively get | |
the tree](https://docs.github.com/rest/git/trees#get-a-tree). | |
* This API has an upper limit of 1,000 files for a directory. If you | |
need to retrieve more files, use the [Git Trees | |
API](https://docs.github.com/rest/git/trees#get-a-tree). | |
* Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. | |
Size limits: | |
If the requested file's size is: | |
* 1 MB or smaller: All features of this endpoint are supported. | |
* Between 1-100 MB: Only the `raw` or `object` [custom media | |
types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) | |
are supported. Both will work as normal, except that when using the | |
`object` media type, the `content` field will be an empty string and the | |
`encoding` field will be `"none"`. To get the contents of these larger | |
files, use the `raw` media type. | |
* Greater than 100 MB: This endpoint is not supported. | |
If the content is a directory: | |
The response will be an array of objects, one object for each item in | |
the directory. | |
When listing the contents of a directory, submodules have their "type" | |
specified as "file". Logically, the value | |
_should_ be "submodule". This behavior exists in API v3 [for backwards | |
compatibility purposes](https://git.io/v1YCW). | |
In the next major version of the API, the type will be returned as | |
"submodule". | |
If the content is a symlink: | |
If the requested `:path` points to a symlink, and the symlink's target | |
is a normal file in the repository, then the | |
API responds with the content of the file (in the format shown in the | |
example. Otherwise, the API responds with an object | |
describing the symlink itself. | |
If the content is a submodule: | |
The `submodule_git_url` identifies the location of the submodule | |
repository, and the `sha` identifies a specific | |
commit within the submodule repository. Git uses the given URL when | |
cloning the submodule repository, and checks out | |
the submodule at that specific commit. | |
If the submodule repository is not hosted on github.com, the Git URLs | |
(`git_url` and `_links["git"]`) and the | |
github.com URLs (`html_url` and `_links["html"]`) will have null values. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/vnd.github.object | |
- name: ref | |
in: query | |
schema: | |
type: string | |
description: >- | |
The name of the commit/branch/tag. Default: the repository’s default | |
branch. | |
example: <string> | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: path | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) path parameter | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'302': | |
description: Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/dependency-graph/compare/{basehead}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > dependency-graph | |
summary: Get a diff of the dependencies between commits | |
description: >- | |
Gets the diff of the dependency changes between two commits of a | |
repository, based on the changes to the dependency manifests made in | |
those commits. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: name | |
in: query | |
schema: | |
type: string | |
description: >- | |
The full path, relative to the repository root, of the dependency | |
manifest file. | |
example: <string> | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: basehead | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The base and head Git revisions to compare. The Git | |
revisions will be resolved to commit SHAs. Named revisions will be | |
resolved to their corresponding HEAD commits, and an appropriate | |
merge base will be determined. This parameter expects the format | |
`{base}...{head}`. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- change_type: <string> | |
manifest: <string> | |
ecosystem: <string> | |
name: <string> | |
version: <string> | |
package_url: <string,null> | |
license: <string,null> | |
source_repository_url: <string,null> | |
vulnerabilities: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
scope: <string> | |
- change_type: <string> | |
manifest: <string> | |
ecosystem: <string> | |
name: <string> | |
version: <string> | |
package_url: <string,null> | |
license: <string,null> | |
source_repository_url: <string,null> | |
vulnerabilities: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
scope: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/dependency-graph/sbom: | |
get: | |
tags: | |
- repos > {owner}/{repo} > dependency-graph | |
summary: Export a software bill of materials (SBOM) for a repository. | |
description: >- | |
Exports the software bill of materials (SBOM) for a repository in SPDX | |
JSON format. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
sbom: | |
SPDXID: <string> | |
spdxVersion: <string> | |
creationInfo: | |
created: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
creators: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: <string> | |
dataLicense: <string> | |
documentDescribes: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
documentNamespace: <string> | |
packages: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/git/blobs: | |
post: | |
tags: | |
- repos > {owner}/{repo} > git > blobs | |
summary: Create a blob | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
content: <string> | |
encoding: utf-8 | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'201': | |
description: Created | |
headers: | |
Location: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <string> | |
sha: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'409': | |
description: Conflict | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/git/blobs/{file_sha}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > git > blobs | |
summary: Get a blob | |
description: |- | |
The `content` in the response will always be Base64 encoded. | |
_Note_: This API supports blobs up to 100 megabytes in size. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: file_sha | |
in: path | |
schema: | |
type: string | |
required: true | |
description: '(Required) ' | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
sha: <string> | |
url: <uri> | |
node_id: <string> | |
size: <integer,null> | |
content: <string> | |
encoding: <string> | |
highlighted_content: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/git/commits: | |
post: | |
tags: | |
- repos > {owner}/{repo} > git > commits | |
summary: Create a commit | |
description: >- | |
Creates a new Git [commit | |
object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). | |
**Signature verification object** | |
The response will include a `verification` object that describes the | |
result of verifying the commit's signature. The following fields are | |
included in the `verification` object: | |
| Name | Type | Description | | |
| ---- | ---- | ----------- | | |
| `verified` | `boolean` | Indicates whether GitHub considers the | |
signature in this commit to be verified. | | |
| `reason` | `string` | The reason for verified value. Possible values | |
and their meanings are enumerated in the table below. | | |
| `signature` | `string` | The signature that was extracted from the | |
commit. | | |
| `payload` | `string` | The value that was signed. | | |
These are the possible values for `reason` in the `verification` object: | |
| Value | Description | | |
| ----- | ----------- | | |
| `expired_key` | The key that made the signature is expired. | | |
| `not_signing_key` | The "signing" flag is not among the usage flags in | |
the GPG key that made the signature. | | |
| `gpgverify_error` | There was an error communicating with the | |
signature verification service. | | |
| `gpgverify_unavailable` | The signature verification service is | |
currently unavailable. | | |
| `unsigned` | The object does not include a signature. | | |
| `unknown_signature_type` | A non-PGP signature was found in the | |
commit. | | |
| `no_user` | No user was associated with the `committer` email address | |
in the commit. | | |
| `unverified_email` | The `committer` email address in the commit was | |
associated with a user, but the email address is not verified on their | |
account. | | |
| `bad_email` | The `committer` email address in the commit is not | |
included in the identities of the PGP key that made the signature. | | |
| `unknown_key` | The key that made the signature has not been | |
registered with any user's account. | | |
| `malformed_signature` | There was an error parsing the signature. | | |
| `invalid` | The signature could not be cryptographically verified | |
using the key whose key-id was found in the signature. | | |
| `valid` | None of the above errors applied, so the signature is | |
considered to be verified. | | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
tree: <string> | |
parents: | |
- <string> | |
- <string> | |
author: | |
name: <string> | |
email: <string> | |
date: <dateTime> | |
committer: | |
name: <string> | |
email: <string> | |
date: <dateTime> | |
signature: <string> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'201': | |
description: Created | |
headers: | |
Location: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
sha: <string> | |
node_id: <string> | |
url: <uri> | |
html_url: <uri> | |
author: | |
email: <string> | |
name: <string> | |
date: <dateTime> | |
committer: | |
email: <string> | |
name: <string> | |
date: <dateTime> | |
tree: | |
sha: <string> | |
url: <uri> | |
message: <string> | |
parents: | |
- sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
verification: | |
verified: <boolean> | |
reason: <string> | |
signature: <string,null> | |
payload: <string,null> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/git/commits/{commit_sha}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > git > commits | |
summary: Get a commit object | |
description: >- | |
Gets a Git [commit | |
object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). | |
To get the contents of a commit, see "[Get a | |
commit](/rest/commits/commits#get-a-commit)." | |
**Signature verification object** | |
The response will include a `verification` object that describes the | |
result of verifying the commit's signature. The following fields are | |
included in the `verification` object: | |
| Name | Type | Description | | |
| ---- | ---- | ----------- | | |
| `verified` | `boolean` | Indicates whether GitHub considers the | |
signature in this commit to be verified. | | |
| `reason` | `string` | The reason for verified value. Possible values | |
and their meanings are enumerated in the table below. | | |
| `signature` | `string` | The signature that was extracted from the | |
commit. | | |
| `payload` | `string` | The value that was signed. | | |
These are the possible values for `reason` in the `verification` object: | |
| Value | Description | | |
| ----- | ----------- | | |
| `expired_key` | The key that made the signature is expired. | | |
| `not_signing_key` | The "signing" flag is not among the usage flags in | |
the GPG key that made the signature. | | |
| `gpgverify_error` | There was an error communicating with the | |
signature verification service. | | |
| `gpgverify_unavailable` | The signature verification service is | |
currently unavailable. | | |
| `unsigned` | The object does not include a signature. | | |
| `unknown_signature_type` | A non-PGP signature was found in the | |
commit. | | |
| `no_user` | No user was associated with the `committer` email address | |
in the commit. | | |
| `unverified_email` | The `committer` email address in the commit was | |
associated with a user, but the email address is not verified on their | |
account. | | |
| `bad_email` | The `committer` email address in the commit is not | |
included in the identities of the PGP key that made the signature. | | |
| `unknown_key` | The key that made the signature has not been | |
registered with any user's account. | | |
| `malformed_signature` | There was an error parsing the signature. | | |
| `invalid` | The signature could not be cryptographically verified | |
using the key whose key-id was found in the signature. | | |
| `valid` | None of the above errors applied, so the signature is | |
considered to be verified. | | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: commit_sha | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The SHA of the commit. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
sha: <string> | |
node_id: <string> | |
url: <uri> | |
html_url: <uri> | |
author: | |
email: <string> | |
name: <string> | |
date: <dateTime> | |
committer: | |
email: <string> | |
name: <string> | |
date: <dateTime> | |
tree: | |
sha: <string> | |
url: <uri> | |
message: <string> | |
parents: | |
- sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
verification: | |
verified: <boolean> | |
reason: <string> | |
signature: <string,null> | |
payload: <string,null> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/git/refs/{ref}: | |
patch: | |
tags: | |
- repos > {owner}/{repo} > git > refs > {ref} | |
summary: Update a reference | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
sha: <string> | |
force: false | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the reference to update (for example, | |
`heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag | |
name (`tags/TAG_NAME`). For more information, see "[Git | |
References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" | |
in the Git documentation. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
ref: <string> | |
node_id: <string> | |
url: <uri> | |
object: | |
type: <string> | |
sha: <string> | |
url: <uri> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete: | |
tags: | |
- repos > {owner}/{repo} > git > refs > {ref} | |
summary: Delete a reference | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The commit reference. Can be a commit SHA, branch name | |
(`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more | |
information, see "[Git | |
References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" | |
in the Git documentation. | |
example: <string> | |
responses: | |
'204': | |
description: No Content | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/git/refs: | |
post: | |
tags: | |
- repos > {owner}/{repo} > git > refs | |
summary: Create a reference | |
description: >- | |
Creates a reference for your repository. You are unable to create new | |
references for empty repositories, even if the commit SHA-1 hash used | |
exists. Empty repositories are repositories without branches. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
ref: <string> | |
sha: <string> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'201': | |
description: Created | |
headers: | |
Location: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
ref: <string> | |
node_id: <string> | |
url: <uri> | |
object: | |
type: <string> | |
sha: <string> | |
url: <uri> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/git/tags: | |
post: | |
tags: | |
- repos > {owner}/{repo} > git > tags | |
summary: Create a tag object | |
description: >- | |
Note that creating a tag object does not create the reference that makes | |
a tag in Git. If you want to create an annotated tag in Git, you have to | |
do this call to create the tag object, and then | |
[create](https://docs.github.com/rest/git/refs#create-a-reference) the | |
`refs/tags/[tag]` reference. If you want to create a lightweight tag, | |
you only have to | |
[create](https://docs.github.com/rest/git/refs#create-a-reference) the | |
tag reference - this call would be unnecessary. | |
**Signature verification object** | |
The response will include a `verification` object that describes the | |
result of verifying the commit's signature. The following fields are | |
included in the `verification` object: | |
| Name | Type | Description | | |
| ---- | ---- | ----------- | | |
| `verified` | `boolean` | Indicates whether GitHub considers the | |
signature in this commit to be verified. | | |
| `reason` | `string` | The reason for verified value. Possible values | |
and their meanings are enumerated in table below. | | |
| `signature` | `string` | The signature that was extracted from the | |
commit. | | |
| `payload` | `string` | The value that was signed. | | |
These are the possible values for `reason` in the `verification` object: | |
| Value | Description | | |
| ----- | ----------- | | |
| `expired_key` | The key that made the signature is expired. | | |
| `not_signing_key` | The "signing" flag is not among the usage flags in | |
the GPG key that made the signature. | | |
| `gpgverify_error` | There was an error communicating with the | |
signature verification service. | | |
| `gpgverify_unavailable` | The signature verification service is | |
currently unavailable. | | |
| `unsigned` | The object does not include a signature. | | |
| `unknown_signature_type` | A non-PGP signature was found in the | |
commit. | | |
| `no_user` | No user was associated with the `committer` email address | |
in the commit. | | |
| `unverified_email` | The `committer` email address in the commit was | |
associated with a user, but the email address is not verified on their | |
account. | | |
| `bad_email` | The `committer` email address in the commit is not | |
included in the identities of the PGP key that made the signature. | | |
| `unknown_key` | The key that made the signature has not been | |
registered with any user's account. | | |
| `malformed_signature` | There was an error parsing the signature. | | |
| `invalid` | The signature could not be cryptographically verified | |
using the key whose key-id was found in the signature. | | |
| `valid` | None of the above errors applied, so the signature is | |
considered to be verified. | | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
tag: <string> | |
message: <string> | |
object: <string> | |
type: <string> | |
tagger: | |
name: <string> | |
email: <string> | |
date: <dateTime> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'201': | |
description: Created | |
headers: | |
Location: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
sha: <string> | |
url: <uri> | |
node_id: <string> | |
tagger: | |
date: <string> | |
email: <string> | |
name: <string> | |
object: | |
sha: <string> | |
type: <string> | |
url: <uri> | |
tag: <string> | |
message: <string> | |
verification: | |
verified: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reason: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
payload: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
signature: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/git/tags/{tag_sha}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > git > tags | |
summary: Get a tag | |
description: >- | |
**Signature verification object** | |
The response will include a `verification` object that describes the | |
result of verifying the commit's signature. The following fields are | |
included in the `verification` object: | |
| Name | Type | Description | | |
| ---- | ---- | ----------- | | |
| `verified` | `boolean` | Indicates whether GitHub considers the | |
signature in this commit to be verified. | | |
| `reason` | `string` | The reason for verified value. Possible values | |
and their meanings are enumerated in table below. | | |
| `signature` | `string` | The signature that was extracted from the | |
commit. | | |
| `payload` | `string` | The value that was signed. | | |
These are the possible values for `reason` in the `verification` object: | |
| Value | Description | | |
| ----- | ----------- | | |
| `expired_key` | The key that made the signature is expired. | | |
| `not_signing_key` | The "signing" flag is not among the usage flags in | |
the GPG key that made the signature. | | |
| `gpgverify_error` | There was an error communicating with the | |
signature verification service. | | |
| `gpgverify_unavailable` | The signature verification service is | |
currently unavailable. | | |
| `unsigned` | The object does not include a signature. | | |
| `unknown_signature_type` | A non-PGP signature was found in the | |
commit. | | |
| `no_user` | No user was associated with the `committer` email address | |
in the commit. | | |
| `unverified_email` | The `committer` email address in the commit was | |
associated with a user, but the email address is not verified on their | |
account. | | |
| `bad_email` | The `committer` email address in the commit is not | |
included in the identities of the PGP key that made the signature. | | |
| `unknown_key` | The key that made the signature has not been | |
registered with any user's account. | | |
| `malformed_signature` | There was an error parsing the signature. | | |
| `invalid` | The signature could not be cryptographically verified | |
using the key whose key-id was found in the signature. | | |
| `valid` | None of the above errors applied, so the signature is | |
considered to be verified. | | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: tag_sha | |
in: path | |
schema: | |
type: string | |
required: true | |
description: '(Required) ' | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
sha: <string> | |
url: <uri> | |
node_id: <string> | |
tagger: | |
date: <string> | |
email: <string> | |
name: <string> | |
object: | |
sha: <string> | |
type: <string> | |
url: <uri> | |
tag: <string> | |
message: <string> | |
verification: | |
verified: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reason: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
payload: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
signature: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/git/trees: | |
post: | |
tags: | |
- repos > {owner}/{repo} > git > trees | |
summary: Create a tree | |
description: >- | |
The tree creation API accepts nested entries. If you specify both a tree | |
and a nested path modifying that tree, this endpoint will overwrite the | |
contents of the tree with the new path contents, and create a new tree | |
structure. | |
If you use this endpoint to add, delete, or modify the file contents in | |
a tree, you will need to commit the tree and then update a branch to | |
point to the commit. For more information see "[Create a | |
commit](https://docs.github.com/rest/git/commits#create-a-commit)" and | |
"[Update a | |
reference](https://docs.github.com/rest/git/refs#update-a-reference)." | |
Returns an error if you try to delete a file that does not exist. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
tree: | |
- path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mode: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
content: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mode: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
content: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
base_tree: <string> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'201': | |
description: Created | |
headers: | |
Location: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
sha: <string> | |
url: <uri> | |
tree: | |
- path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mode: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mode: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
truncated: <boolean> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/git/trees/{tree_sha}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > git > trees | |
summary: Get a tree | |
description: >- | |
Returns a single tree using the SHA1 value or ref name for that tree. | |
If `truncated` is `true` in the response then the number of items in the | |
`tree` array exceeded our maximum limit. If you need to fetch more | |
items, use the non-recursive method of fetching trees, and fetch one | |
sub-tree at a time. | |
**Note**: The limit for the `tree` array is 100,000 entries with a | |
maximum size of 7 MB when using the `recursive` parameter. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: recursive | |
in: query | |
schema: | |
type: string | |
description: >- | |
Setting this parameter to any value returns the objects or subtrees | |
referenced by the tree specified in `:tree_sha`. For example, | |
setting `recursive` to any of the following will enable returning | |
objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this | |
parameter to prevent recursively returning objects or subtrees. | |
example: <string> | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: tree_sha | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The SHA1 value or ref (branch or tag) name of the tree. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
sha: <string> | |
url: <uri> | |
tree: | |
- path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mode: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mode: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
truncated: <boolean> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/git/matching-refs/{ref}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > git | |
summary: List matching references | |
description: >- | |
Returns an array of references from your Git database that match the | |
supplied name. The `:ref` in the URL must be formatted as `heads/<branch | |
name>` for branches and `tags/<tag name>` for tags. If the `:ref` | |
doesn't exist in the repository, but existing refs start with `:ref`, | |
they will be returned as an array. | |
When you use this endpoint without providing a `:ref`, it will return an | |
array of all the references from your Git database, including notes and | |
stashes if they exist on the server. Anything in the namespace is | |
returned, not just `heads` and `tags`. | |
**Note:** You need to explicitly [request a pull | |
request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to | |
trigger a test merge commit, which checks the mergeability of pull | |
requests. For more information, see "[Checking mergeability of pull | |
requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". | |
If you request matching references for a branch named `feature` but the | |
branch `feature` doesn't exist, the response can still include other | |
matching head refs that start with the word `feature`, such as | |
`featureA` and `featureB`. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The commit reference. Can be a commit SHA, branch name | |
(`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more | |
information, see "[Git | |
References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" | |
in the Git documentation. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- ref: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
object: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- ref: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
object: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/git/ref/{ref}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > git | |
summary: Get a reference | |
description: >- | |
Returns a single reference from your Git database. The `:ref` in the URL | |
must be formatted as `heads/<branch name>` for branches and `tags/<tag | |
name>` for tags. If the `:ref` doesn't match an existing ref, a `404` is | |
returned. | |
**Note:** You need to explicitly [request a pull | |
request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to | |
trigger a test merge commit, which checks the mergeability of pull | |
requests. For more information, see "[Checking mergeability of pull | |
requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The commit reference. Can be a commit SHA, branch name | |
(`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more | |
information, see "[Git | |
References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" | |
in the Git documentation. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
ref: <string> | |
node_id: <string> | |
url: <uri> | |
object: | |
type: <string> | |
sha: <string> | |
url: <uri> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/interaction-limits: | |
get: | |
tags: | |
- repos > {owner}/{repo} > interaction-limits | |
summary: Get interaction restrictions for a repository | |
description: >- | |
Shows which type of GitHub user can interact with this repository and | |
when the restriction expires. If there are no restrictions, you will see | |
an empty response. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
limit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
origin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
expires_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/pulls/comments/{comment_id}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > comments > {comment_id} | |
summary: Get a review comment for a pull request | |
description: Provides details for a review comment. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: comment_id | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The unique identifier of the comment. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <string> | |
id: <integer> | |
node_id: <string> | |
pull_request_review_id: <integer,null> | |
diff_hunk: <string> | |
path: <string> | |
commit_id: <string> | |
original_commit_id: <string> | |
user: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: <string> | |
created_at: <dateTime> | |
updated_at: <dateTime> | |
html_url: <uri> | |
pull_request_url: <uri> | |
author_association: <string> | |
_links: | |
self: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: <integer> | |
original_position: <integer> | |
in_reply_to_id: <integer> | |
start_line: <integer,null> | |
original_start_line: <integer,null> | |
start_side: RIGHT | |
line: <integer> | |
original_line: <integer> | |
side: RIGHT | |
subject_type: <string> | |
reactions: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
total_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'+1': | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'-1': | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
laugh: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
confused: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
heart: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooray: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
eyes: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
rocket: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: <string> | |
body_text: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/pulls/comments: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > comments | |
summary: List review comments in a repository | |
description: >- | |
Lists review comments for all pull requests in a repository. By default, | |
review comments are in ascending order by ID. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: sort | |
in: query | |
schema: | |
type: string | |
example: <string> | |
- name: direction | |
in: query | |
schema: | |
type: string | |
description: The direction to sort results. Ignored without `sort` parameter. | |
example: <string> | |
- name: since | |
in: query | |
schema: | |
type: string | |
description: >- | |
Only show results that were last updated after the given time. This | |
is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) | |
format: `YYYY-MM-DDTHH:MM:SSZ`. | |
example: <dateTime> | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_review_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
diff_hunk: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
_links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
in_reply_to_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subject_type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reactions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_text: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_review_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
diff_hunk: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
_links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
in_reply_to_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subject_type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reactions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_text: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/pulls/{pull_number}/comments: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > comments | |
summary: List review comments on a pull request | |
description: >- | |
Lists all review comments for a pull request. By default, review | |
comments are in ascending order by ID. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: sort | |
in: query | |
schema: | |
type: string | |
description: The property to sort the results by. | |
example: created | |
- name: direction | |
in: query | |
schema: | |
type: string | |
description: The direction to sort results. Ignored without `sort` parameter. | |
example: <string> | |
- name: since | |
in: query | |
schema: | |
type: string | |
description: >- | |
Only show results that were last updated after the given time. This | |
is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) | |
format: `YYYY-MM-DDTHH:MM:SSZ`. | |
example: <dateTime> | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_review_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
diff_hunk: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
_links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
in_reply_to_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subject_type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reactions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_text: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_review_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
diff_hunk: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
_links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
in_reply_to_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subject_type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reactions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_text: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
post: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > comments | |
summary: Create a review comment for a pull request | |
description: >- | |
Creates a review comment in the pull request diff. To add a regular | |
comment to a pull request timeline, see "[Create an issue | |
comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." | |
We recommend creating a review comment using `line`, `side`, and | |
optionally `start_line` and `start_side` if your comment applies to more | |
than one line in the pull request diff. | |
The `position` parameter is deprecated. If you use `position`, the | |
`line`, `side`, `start_line`, and `start_side` parameters are not | |
required. | |
**Note:** The position value equals the number of lines down from the | |
first "@@" hunk header in the file you want to add a comment. The line | |
just below the "@@" line is position 1, the next line is position 2, and | |
so on. The position in the diff continues to increase through lines of | |
whitespace and additional hunks until the beginning of a new file. | |
This endpoint triggers | |
[notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). | |
Creating content too quickly using this endpoint may result in secondary | |
rate limiting. For more information, see "[Rate limits for the | |
API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" | |
and "[Best practices for using the REST | |
API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
body: <string> | |
commit_id: <string> | |
path: <string> | |
position: <integer> | |
side: <string> | |
line: <integer> | |
start_line: <integer> | |
start_side: <string> | |
in_reply_to: <integer> | |
subject_type: <string> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'201': | |
description: Created | |
headers: | |
Location: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <string> | |
id: <integer> | |
node_id: <string> | |
pull_request_review_id: <integer,null> | |
diff_hunk: <string> | |
path: <string> | |
commit_id: <string> | |
original_commit_id: <string> | |
user: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: <string> | |
created_at: <dateTime> | |
updated_at: <dateTime> | |
html_url: <uri> | |
pull_request_url: <uri> | |
author_association: <string> | |
_links: | |
self: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: <integer> | |
original_position: <integer> | |
in_reply_to_id: <integer> | |
start_line: <integer,null> | |
original_start_line: <integer,null> | |
start_side: RIGHT | |
line: <integer> | |
original_line: <integer> | |
side: RIGHT | |
subject_type: <string> | |
reactions: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
total_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'+1': | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'-1': | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
laugh: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
confused: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
heart: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooray: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
eyes: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
rocket: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: <string> | |
body_text: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies: | |
post: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > comments | |
summary: Create a reply for a review comment | |
description: >- | |
Creates a reply to a review comment for a pull request. For the | |
`comment_id`, provide the ID of the review comment you are replying to. | |
This must be the ID of a _top-level review comment_, not a reply to that | |
comment. Replies to replies are not supported. | |
This endpoint triggers | |
[notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). | |
Creating content too quickly using this endpoint may result in secondary | |
rate limiting. For more information, see "[Rate limits for the | |
API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" | |
and "[Best practices for using the REST | |
API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
body: <string> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
- name: comment_id | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The unique identifier of the comment. | |
example: <integer> | |
responses: | |
'201': | |
description: Created | |
headers: | |
Location: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <string> | |
id: <integer> | |
node_id: <string> | |
pull_request_review_id: <integer,null> | |
diff_hunk: <string> | |
path: <string> | |
commit_id: <string> | |
original_commit_id: <string> | |
user: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: <string> | |
created_at: <dateTime> | |
updated_at: <dateTime> | |
html_url: <uri> | |
pull_request_url: <uri> | |
author_association: <string> | |
_links: | |
self: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: <integer> | |
original_position: <integer> | |
in_reply_to_id: <integer> | |
start_line: <integer,null> | |
original_start_line: <integer,null> | |
start_side: RIGHT | |
line: <integer> | |
original_line: <integer> | |
side: RIGHT | |
subject_type: <string> | |
reactions: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
total_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'+1': | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'-1': | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
laugh: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
confused: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
heart: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooray: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
eyes: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
rocket: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: <string> | |
body_text: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/pulls/{pull_number}/merge: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > merge | |
summary: Check if a pull request has been merged | |
description: >- | |
Checks if a pull request has been merged into the base branch. The HTTP | |
status of the response indicates whether or not the pull request has | |
been merged; the response body is empty. | |
parameters: | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'204': | |
description: No Content | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
put: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > merge | |
summary: Merge a pull request | |
description: >- | |
Merges a pull request into the base branch. | |
This endpoint triggers | |
[notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). | |
Creating content too quickly using this endpoint may result in secondary | |
rate limiting. For more information, see "[Rate limits for the | |
API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" | |
and "[Best practices for using the REST | |
API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
commit_title: <string> | |
commit_message: <string> | |
sha: <string> | |
merge_method: <string> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
merged: <boolean> | |
message: <string> | |
sha: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'405': | |
description: Method Not Allowed | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
'409': | |
description: Conflict | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > requested_reviewers | |
summary: Get all requested reviewers for a pull request | |
description: >- | |
Gets the users or teams whose review is requested for a pull request. | |
Once a requested reviewer submits a review, they are no longer | |
considered a requested reviewer. Their review will instead be returned | |
by the [List reviews for a pull | |
request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) | |
operation. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
users: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
post: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > requested_reviewers | |
summary: Request reviewers for a pull request | |
description: >- | |
Requests reviews for a pull request from a given set of users and/or | |
teams. | |
This endpoint triggers | |
[notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). | |
Creating content too quickly using this endpoint may result in secondary | |
rate limiting. For more information, see "[Rate limits for the | |
API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" | |
and "[Best practices for using the REST | |
API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'201': | |
description: Created | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
_links: | |
comments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comment: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
self: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignee: <null> | |
labels: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
base: | |
label: <string> | |
ref: <string> | |
repo: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: <string> | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: <string,null> | |
closed_at: <string,null-date-time> | |
comments_url: <uri> | |
commits_url: <uri> | |
created_at: <dateTime> | |
diff_url: <uri> | |
head: | |
label: <string> | |
ref: <string> | |
repo: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: <string> | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: <uri> | |
id: <integer> | |
node_id: <string> | |
issue_url: <uri> | |
merge_commit_sha: <string,null> | |
merged_at: <string,null-date-time> | |
milestone: <null> | |
number: <integer> | |
patch_url: <uri> | |
review_comment_url: <string> | |
review_comments_url: <uri> | |
statuses_url: <uri> | |
state: <string> | |
locked: <boolean> | |
title: <string> | |
updated_at: <dateTime> | |
url: <uri> | |
user: <null> | |
author_association: <string> | |
auto_merge: | |
enabled_by: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_method: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
active_lock_reason: <string,null> | |
assignees: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_reviewers: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
draft: <boolean> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
delete: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > requested_reviewers | |
summary: Remove requested reviewers from a pull request | |
description: >- | |
Removes review requests from a pull request for a given set of users | |
and/or teams. | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
_links: | |
comments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comment: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
self: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignee: <null> | |
labels: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
base: | |
label: <string> | |
ref: <string> | |
repo: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: <string> | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: <string,null> | |
closed_at: <string,null-date-time> | |
comments_url: <uri> | |
commits_url: <uri> | |
created_at: <dateTime> | |
diff_url: <uri> | |
head: | |
label: <string> | |
ref: <string> | |
repo: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: <string> | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: <uri> | |
id: <integer> | |
node_id: <string> | |
issue_url: <uri> | |
merge_commit_sha: <string,null> | |
merged_at: <string,null-date-time> | |
milestone: <null> | |
number: <integer> | |
patch_url: <uri> | |
review_comment_url: <string> | |
review_comments_url: <uri> | |
statuses_url: <uri> | |
state: <string> | |
locked: <boolean> | |
title: <string> | |
updated_at: <dateTime> | |
url: <uri> | |
user: <null> | |
author_association: <string> | |
auto_merge: | |
enabled_by: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_method: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
active_lock_reason: <string,null> | |
assignees: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_reviewers: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
draft: <boolean> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > reviews > {review_id} | |
summary: Get a review for a pull request | |
description: Retrieves a pull request review by its ID. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
- name: review_id | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The unique identifier of the review. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
id: <integer> | |
node_id: <string> | |
user: <null> | |
body: <string> | |
state: <string> | |
commit_id: <string,null> | |
html_url: <uri> | |
pull_request_url: <uri> | |
_links: | |
html: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: <string> | |
submitted_at: <dateTime> | |
body_html: <string> | |
body_text: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
put: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > reviews > {review_id} | |
summary: Update a review for a pull request | |
description: Update the review summary comment with new text. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
body: <string> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
- name: review_id | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The unique identifier of the review. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
id: <integer> | |
node_id: <string> | |
user: <null> | |
body: <string> | |
state: <string> | |
commit_id: <string,null> | |
html_url: <uri> | |
pull_request_url: <uri> | |
_links: | |
html: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: <string> | |
submitted_at: <dateTime> | |
body_html: <string> | |
body_text: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- <string> | |
- <string> | |
delete: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > reviews > {review_id} | |
summary: Delete a pending review for a pull request | |
description: >- | |
Deletes a pull request review that has not been submitted. Submitted | |
reviews cannot be deleted. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
- name: review_id | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The unique identifier of the review. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
id: <integer> | |
node_id: <string> | |
user: <null> | |
body: <string> | |
state: <string> | |
commit_id: <string,null> | |
html_url: <uri> | |
pull_request_url: <uri> | |
_links: | |
html: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: <string> | |
submitted_at: <dateTime> | |
body_html: <string> | |
body_text: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- <string> | |
- <string> | |
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > reviews > {review_id} | |
summary: List comments for a pull request review | |
description: List comments for a specific pull request review. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
- name: review_id | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The unique identifier of the review. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
diff_hunk: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_review_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
_links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
in_reply_to_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_text: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reactions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
diff_hunk: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_review_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
_links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
in_reply_to_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_text: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reactions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
original_start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals: | |
put: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > reviews > {review_id} | |
summary: Dismiss a review for a pull request | |
description: >- | |
**Note:** To dismiss a pull request review on a [protected | |
branch](https://docs.github.com/rest/branches/branch-protection), you | |
must be a repository administrator or be included in the list of people | |
or teams who can dismiss pull request reviews. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
event: <string> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
- name: review_id | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The unique identifier of the review. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
id: <integer> | |
node_id: <string> | |
user: <null> | |
body: <string> | |
state: <string> | |
commit_id: <string,null> | |
html_url: <uri> | |
pull_request_url: <uri> | |
_links: | |
html: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: <string> | |
submitted_at: <dateTime> | |
body_html: <string> | |
body_text: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- <string> | |
- <string> | |
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events: | |
post: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > reviews > {review_id} | |
summary: Submit a review for a pull request | |
description: >- | |
Submits a pending review for a pull request. For more information about | |
creating a pending review for a pull request, see "[Create a review for | |
a pull | |
request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
event: <string> | |
body: <string> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
- name: review_id | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The unique identifier of the review. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
id: <integer> | |
node_id: <string> | |
user: <null> | |
body: <string> | |
state: <string> | |
commit_id: <string,null> | |
html_url: <uri> | |
pull_request_url: <uri> | |
_links: | |
html: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: <string> | |
submitted_at: <dateTime> | |
body_html: <string> | |
body_text: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- <string> | |
- <string> | |
/repos/{owner}/{repo}/pulls/{pull_number}/reviews: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > reviews | |
summary: List reviews for a pull request | |
description: The list of reviews returns in chronological order. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
_links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
submitted_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_text: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
_links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
submitted_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_text: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
post: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} > reviews | |
summary: Create a review for a pull request | |
description: >- | |
This endpoint triggers | |
[notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). | |
Creating content too quickly using this endpoint may result in secondary | |
rate limiting. For more information, see "[Rate limits for the | |
API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" | |
and "[Best practices for using the REST | |
API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." | |
Pull request reviews created in the `PENDING` state are not submitted | |
and therefore do not include the `submitted_at` property in the | |
response. To create a pending review for a pull request, leave the | |
`event` parameter blank. For more information about submitting a | |
`PENDING` review, see "[Submit a review for a pull | |
request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." | |
**Note:** To comment on a specific line in a file, you need to first | |
determine the _position_ of that line in the diff. The GitHub REST API | |
offers the `application/vnd.github.v3.diff` [media | |
type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). | |
To see a pull request diff, add this media type to the `Accept` header | |
of a call to the [single pull | |
request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) | |
endpoint. | |
The `position` value equals the number of lines down from the first "@@" | |
hunk header in the file you want to add a comment. The line just below | |
the "@@" line is position 1, the next line is position 2, and so on. The | |
position in the diff continues to increase through lines of whitespace | |
and additional hunks until the beginning of a new file. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
commit_id: <string> | |
body: <string> | |
event: <string> | |
comments: | |
- path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
position: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
start_side: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
id: <integer> | |
node_id: <string> | |
user: <null> | |
body: <string> | |
state: <string> | |
commit_id: <string,null> | |
html_url: <uri> | |
pull_request_url: <uri> | |
_links: | |
html: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
href: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: <string> | |
submitted_at: <dateTime> | |
body_html: <string> | |
body_text: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- <string> | |
- <string> | |
/repos/{owner}/{repo}/pulls/{pull_number}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} | |
summary: Get a pull request | |
description: >- | |
Draft pull requests are available in public repositories with GitHub | |
Free and GitHub Free for organizations, GitHub Pro, and legacy | |
per-repository billing plans, and in public and private repositories | |
with GitHub Team and GitHub Enterprise Cloud. For more information, see | |
[GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
Lists details of a pull request by providing its number. | |
When you get, | |
[create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), | |
or | |
[edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a | |
pull request, GitHub creates a merge commit to test whether the pull | |
request can be automatically merged into the base branch. This test | |
commit is not added to the base branch or the head branch. You can | |
review the status of the test commit using the `mergeable` key. For more | |
information, see "[Checking mergeability of pull | |
requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". | |
The value of the `mergeable` attribute can be `true`, `false`, or | |
`null`. If the value is `null`, then GitHub has started a background job | |
to compute the mergeability. After giving the job time to complete, | |
resubmit the request. When the job finishes, you will see a non-`null` | |
value for the `mergeable` attribute in the response. If `mergeable` is | |
`true`, then `merge_commit_sha` will be the SHA of the _test_ merge | |
commit. | |
The value of the `merge_commit_sha` attribute changes depending on the | |
state of the pull request. Before merging a pull request, the | |
`merge_commit_sha` attribute holds the SHA of the _test_ merge commit. | |
After merging a pull request, the `merge_commit_sha` attribute changes | |
depending on how you merged the pull request: | |
* If merged as a [merge | |
commit](https://docs.github.com/articles/about-merge-methods-on-github/), | |
`merge_commit_sha` represents the SHA of the merge commit. | |
* If merged via a | |
[squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), | |
`merge_commit_sha` represents the SHA of the squashed commit on the base | |
branch. | |
* If | |
[rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), | |
`merge_commit_sha` represents the commit that the base branch was | |
updated to. | |
Pass the appropriate [media | |
type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) | |
to fetch diff and patch formats. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
_links: | |
comments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comment: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
self: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignee: <null> | |
labels: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
base: | |
label: <string> | |
ref: <string> | |
repo: | |
archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
master_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_merge_commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_squash_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_rebase_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: <string> | |
user: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: <string,null> | |
closed_at: <string,null-date-time> | |
comments_url: <uri> | |
commits_url: <uri> | |
created_at: <dateTime> | |
diff_url: <uri> | |
head: | |
label: <string> | |
ref: <string> | |
repo: | |
archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
master_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_merge_commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_squash_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_rebase_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: <string> | |
user: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: <uri> | |
id: <integer> | |
node_id: <string> | |
issue_url: <uri> | |
merge_commit_sha: <string,null> | |
merged_at: <string,null-date-time> | |
milestone: <null> | |
number: <integer> | |
patch_url: <uri> | |
review_comment_url: <string> | |
review_comments_url: <uri> | |
statuses_url: <uri> | |
state: <string> | |
locked: <boolean> | |
title: <string> | |
updated_at: <dateTime> | |
url: <uri> | |
user: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: <string> | |
auto_merge: | |
enabled_by: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_method: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
additions: <integer> | |
changed_files: <integer> | |
comments: <integer> | |
commits: <integer> | |
deletions: <integer> | |
mergeable: <boolean,null> | |
mergeable_state: <string> | |
merged: <boolean> | |
maintainer_can_modify: <boolean> | |
merged_by: <null> | |
review_comments: <integer> | |
active_lock_reason: <string,null> | |
assignees: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_reviewers: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
draft: <boolean> | |
rebaseable: <boolean,null> | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'500': | |
description: Internal Server Error | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'503': | |
description: Service Unavailable | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
code: <string> | |
message: <string> | |
documentation_url: <string> | |
patch: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} | |
summary: Update a pull request | |
description: >- | |
Draft pull requests are available in public repositories with GitHub | |
Free and GitHub Free for organizations, GitHub Pro, and legacy | |
per-repository billing plans, and in public and private repositories | |
with GitHub Team and GitHub Enterprise Cloud. For more information, see | |
[GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
To open or update a pull request in a public repository, you must have | |
write access to the head or the source branch. For organization-owned | |
repositories, you must be a member of the organization that owns the | |
repository to open or update a pull request. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
title: <string> | |
body: <string> | |
state: <string> | |
base: <string> | |
maintainer_can_modify: <boolean> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
_links: | |
comments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comment: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
self: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignee: <null> | |
labels: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
base: | |
label: <string> | |
ref: <string> | |
repo: | |
archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
master_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_merge_commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_squash_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_rebase_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: <string> | |
user: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: <string,null> | |
closed_at: <string,null-date-time> | |
comments_url: <uri> | |
commits_url: <uri> | |
created_at: <dateTime> | |
diff_url: <uri> | |
head: | |
label: <string> | |
ref: <string> | |
repo: | |
archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
master_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_merge_commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_squash_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_rebase_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: <string> | |
user: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: <uri> | |
id: <integer> | |
node_id: <string> | |
issue_url: <uri> | |
merge_commit_sha: <string,null> | |
merged_at: <string,null-date-time> | |
milestone: <null> | |
number: <integer> | |
patch_url: <uri> | |
review_comment_url: <string> | |
review_comments_url: <uri> | |
statuses_url: <uri> | |
state: <string> | |
locked: <boolean> | |
title: <string> | |
updated_at: <dateTime> | |
url: <uri> | |
user: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: <string> | |
auto_merge: | |
enabled_by: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_method: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit_message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
additions: <integer> | |
changed_files: <integer> | |
comments: <integer> | |
commits: <integer> | |
deletions: <integer> | |
mergeable: <boolean,null> | |
mergeable_state: <string> | |
merged: <boolean> | |
maintainer_can_modify: <boolean> | |
merged_by: <null> | |
review_comments: <integer> | |
active_lock_reason: <string,null> | |
assignees: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_reviewers: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_teams: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
draft: <boolean> | |
rebaseable: <boolean,null> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/pulls/{pull_number}/codespaces: | |
post: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} | |
summary: Create a codespace from a pull request | |
description: >- | |
Creates a codespace owned by the authenticated user for the specified | |
pull request. | |
You must authenticate using an 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. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
location: <string> | |
geo: <string> | |
client_ip: <string> | |
machine: <string> | |
devcontainer_path: <string> | |
multi_repo_permissions_opt_out: <boolean> | |
working_directory: <string> | |
idle_timeout_minutes: <integer> | |
display_name: <string> | |
retention_period_minutes: <integer> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'201': | |
description: Created | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
id: <integer> | |
name: <string> | |
environment_id: <string,null> | |
owner: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
billable_owner: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repository: | |
archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
role_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete_branch_on_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
network_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
code_of_conduct: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
security_and_analysis: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
machine: <null> | |
prebuild: <boolean,null> | |
created_at: <dateTime> | |
updated_at: <dateTime> | |
last_used_at: <dateTime> | |
state: <string> | |
url: <uri> | |
git_status: | |
ahead: <integer> | |
behind: <integer> | |
has_unpushed_changes: <boolean> | |
has_uncommitted_changes: <boolean> | |
ref: <string> | |
location: <string> | |
idle_timeout_minutes: <integer,null> | |
web_url: <uri> | |
machines_url: <uri> | |
start_url: <uri> | |
stop_url: <uri> | |
pulls_url: <string,null-uri> | |
recent_folders: | |
- <string> | |
- <string> | |
display_name: <string,null> | |
devcontainer_path: <string,null> | |
publish_url: <string,null-uri> | |
runtime_constraints: | |
allowed_port_privacy_settings: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
pending_operation: <boolean,null> | |
pending_operation_disabled_reason: <string,null> | |
idle_timeout_notice: <string,null> | |
retention_period_minutes: <integer,null> | |
retention_expires_at: <string,null-date-time> | |
last_known_stop_notice: <string,null> | |
'202': | |
description: Accepted | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
id: <integer> | |
name: <string> | |
environment_id: <string,null> | |
owner: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
billable_owner: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repository: | |
archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
role_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete_branch_on_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
network_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
code_of_conduct: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
security_and_analysis: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
machine: <null> | |
prebuild: <boolean,null> | |
created_at: <dateTime> | |
updated_at: <dateTime> | |
last_used_at: <dateTime> | |
state: <string> | |
url: <uri> | |
git_status: | |
ahead: <integer> | |
behind: <integer> | |
has_unpushed_changes: <boolean> | |
has_uncommitted_changes: <boolean> | |
ref: <string> | |
location: <string> | |
idle_timeout_minutes: <integer,null> | |
web_url: <uri> | |
machines_url: <uri> | |
start_url: <uri> | |
stop_url: <uri> | |
pulls_url: <string,null-uri> | |
recent_folders: | |
- <string> | |
- <string> | |
display_name: <string,null> | |
devcontainer_path: <string,null> | |
publish_url: <string,null-uri> | |
runtime_constraints: | |
allowed_port_privacy_settings: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
pending_operation: <boolean,null> | |
pending_operation_disabled_reason: <string,null> | |
idle_timeout_notice: <string,null> | |
retention_period_minutes: <integer,null> | |
retention_expires_at: <string,null-date-time> | |
last_known_stop_notice: <string,null> | |
'401': | |
description: Unauthorized | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'503': | |
description: Service Unavailable | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
code: <string> | |
message: <string> | |
documentation_url: <string> | |
/repos/{owner}/{repo}/pulls/{pull_number}/commits: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} | |
summary: List commits on a pull request | |
description: >- | |
Lists a maximum of 250 commits for a pull request. To receive a complete | |
commit list for pull requests with more than 250 commits, use the [List | |
commits](https://docs.github.com/rest/commits/commits#list-commits) | |
endpoint. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
committer: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parents: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stats: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
files: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
committer: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parents: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stats: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
files: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/pulls/{pull_number}/files: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} | |
summary: List pull requests files | |
description: >- | |
**Note:** Responses include a maximum of 3000 files. The paginated | |
response returns 30 files per page by default. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- additions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blob_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
changes: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deletions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
filename: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
raw_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
status: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
patch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
previous_filename: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- additions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blob_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
changes: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deletions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
filename: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
raw_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
status: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
patch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
previous_filename: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'500': | |
description: Internal Server Error | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'503': | |
description: Service Unavailable | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
code: <string> | |
message: <string> | |
documentation_url: <string> | |
/repos/{owner}/{repo}/pulls/{pull_number}/update-branch: | |
put: | |
tags: | |
- repos > {owner}/{repo} > pulls > {pull_number} | |
summary: Update a pull request branch | |
description: >- | |
Updates the pull request branch with the latest upstream changes by | |
merging HEAD from the base branch into the pull request branch. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
expected_head_sha: <string> | |
parameters: | |
- name: Content-Type | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: pull_number | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The number that identifies the pull request. | |
example: <integer> | |
responses: | |
'202': | |
description: Accepted | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
url: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/pulls: | |
get: | |
tags: | |
- repos > {owner}/{repo} > pulls | |
summary: List pull requests | |
description: >- | |
Draft pull requests are available in public repositories with GitHub | |
Free and GitHub Free for organizations, GitHub Pro, and legacy | |
per-repository billing plans, and in public and private repositories | |
with GitHub Team and GitHub Enterprise Cloud. For more information, see | |
[GitHub's | |
products](https://docs.github.com/github/getting-started-with-github/githubs-products) | |
in the GitHub Help documentation. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: state | |
in: query | |
schema: | |
type: string | |
description: Either `open`, `closed`, or `all` to filter by state. | |
example: open | |
- name: head | |
in: query | |
schema: | |
type: string | |
description: >- | |
Filter pulls by head user or head organization and branch name in | |
the format of `user:ref-name` or `organization:ref-name`. For | |
example: `github:new-script-format` or `octocat:test-branch`. | |
example: <string> | |
- name: base | |
in: query | |
schema: | |
type: string | |
description: 'Filter pulls by base branch name. Example: `gh-pages`.' | |
example: <string> | |
- name: sort | |
in: query | |
schema: | |
type: string | |
description: >- | |
What to sort results by. `popularity` will sort by the number of | |
comments. `long-running` will sort by date created and will limit | |
the results to pull requests that have been open for more than a | |
month and have had activity within the past month. | |
example: created | |
- name: direction | |
in: query | |
schema: | |
type: string | |
description: >- | |
The direction of the sort. Default: `desc` when sort is `created` or | |
sort is not specified, otherwise `asc`. | |
example: <string> | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- _links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignee: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
base: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
closed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
diff_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
head: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_commit_sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merged_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestone: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
number: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
patch_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
locked: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
auto_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
active_lock_reason: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_reviewers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_teams: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
draft: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- _links: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignee: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
base: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
closed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
diff_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
head: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_commit_sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merged_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestone: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
number: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
patch_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
review_comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
locked: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
auto_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
active_lock_reason: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_reviewers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
requested_teams: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
draft: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/readme: | |
get: | |
tags: | |
- repos > {owner}/{repo} > readme | |
summary: Get a repository README | |
description: >- | |
Gets the preferred README for a repository. | |
READMEs support [custom media | |
types](https://docs.github.com/rest/overview/media-types) for retrieving | |
the raw content or rendered HTML. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: ref | |
in: query | |
schema: | |
type: string | |
description: >- | |
The name of the commit/branch/tag. Default: the repository’s default | |
branch. | |
example: <string> | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
_links: | |
git: <string,null-uri> | |
html: <string,null-uri> | |
self: <uri> | |
git_url: <string,null-uri> | |
html_url: <string,null-uri> | |
download_url: <string,null-uri> | |
name: <string> | |
path: <string> | |
sha: <string> | |
size: <integer> | |
type: <string> | |
url: <uri> | |
content: <string> | |
encoding: <string> | |
target: <string> | |
submodule_git_url: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/readme/{dir}: | |
get: | |
tags: | |
- repos > {owner}/{repo} > readme | |
summary: Get a repository README for a directory | |
description: >- | |
Gets the README from a repository directory. | |
READMEs support [custom media | |
types](https://docs.github.com/rest/overview/media-types) for retrieving | |
the raw content or rendered HTML. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: ref | |
in: query | |
schema: | |
type: string | |
description: >- | |
The name of the commit/branch/tag. Default: the repository’s default | |
branch. | |
example: <string> | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: dir | |
in: path | |
schema: | |
type: string | |
required: true | |
description: (Required) The alternate path to look for a README file | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
_links: | |
git: <string,null-uri> | |
html: <string,null-uri> | |
self: <uri> | |
git_url: <string,null-uri> | |
html_url: <string,null-uri> | |
download_url: <string,null-uri> | |
name: <string> | |
path: <string> | |
sha: <string> | |
size: <integer> | |
type: <string> | |
url: <uri> | |
content: <string> | |
encoding: <string> | |
target: <string> | |
submodule_git_url: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: Get a repository | |
description: >- | |
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. | |
**Note:** In order to see the `security_and_analysis` block for a | |
repository you must have admin permissions for the repository or be an | |
owner or security manager for the organization that owns the repository. | |
For more information, see "[Managing security managers in your | |
organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
archive_url: <string> | |
assignees_url: <string> | |
blobs_url: <string> | |
branches_url: <string> | |
collaborators_url: <string> | |
comments_url: <string> | |
commits_url: <string> | |
compare_url: <string> | |
contents_url: <string> | |
contributors_url: <uri> | |
deployments_url: <uri> | |
description: <string,null> | |
downloads_url: <uri> | |
events_url: <uri> | |
fork: <boolean> | |
forks_url: <uri> | |
full_name: <string> | |
git_commits_url: <string> | |
git_refs_url: <string> | |
git_tags_url: <string> | |
hooks_url: <uri> | |
html_url: <uri> | |
id: <integer> | |
node_id: <string> | |
issue_comment_url: <string> | |
issue_events_url: <string> | |
issues_url: <string> | |
keys_url: <string> | |
labels_url: <string> | |
languages_url: <uri> | |
merges_url: <uri> | |
milestones_url: <string> | |
name: <string> | |
notifications_url: <string> | |
owner: | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: <boolean> | |
pulls_url: <string> | |
releases_url: <string> | |
stargazers_url: <uri> | |
statuses_url: <string> | |
subscribers_url: <uri> | |
subscription_url: <uri> | |
tags_url: <uri> | |
teams_url: <uri> | |
trees_url: <string> | |
url: <uri> | |
clone_url: <string> | |
default_branch: <string> | |
forks: <integer> | |
forks_count: <integer> | |
git_url: <string> | |
has_issues: <boolean> | |
has_projects: <boolean> | |
has_wiki: <boolean> | |
has_pages: <boolean> | |
has_discussions: <boolean> | |
homepage: <string,null-uri> | |
language: <string,null> | |
archived: <boolean> | |
disabled: <boolean> | |
mirror_url: <string,null-uri> | |
open_issues: <integer> | |
open_issues_count: <integer> | |
license: <null> | |
pushed_at: <dateTime> | |
size: <integer> | |
ssh_url: <string> | |
stargazers_count: <integer> | |
svn_url: <uri> | |
watchers: <integer> | |
watchers_count: <integer> | |
created_at: <dateTime> | |
updated_at: <dateTime> | |
network_count: <integer> | |
subscribers_count: <integer> | |
is_template: <boolean> | |
topics: | |
- <string> | |
- <string> | |
has_downloads: <boolean> | |
visibility: <string> | |
permissions: | |
admin: <boolean> | |
pull: <boolean> | |
push: <boolean> | |
maintain: <boolean> | |
triage: <boolean> | |
allow_rebase_merge: <boolean> | |
template_repository: <null> | |
temp_clone_token: <string,null> | |
allow_squash_merge: <boolean> | |
allow_auto_merge: <boolean> | |
delete_branch_on_merge: <boolean> | |
allow_merge_commit: <boolean> | |
allow_update_branch: <boolean> | |
use_squash_pr_title_as_default: <boolean> | |
squash_merge_commit_title: <string> | |
squash_merge_commit_message: <string> | |
merge_commit_title: <string> | |
merge_commit_message: <string> | |
allow_forking: <boolean> | |
web_commit_signoff_required: <boolean> | |
organization: <null> | |
parent: | |
archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_rebase_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
template_repository: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_squash_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_auto_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete_branch_on_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_update_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
use_squash_pr_title_as_default: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
squash_merge_commit_title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
squash_merge_commit_message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_commit_title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_commit_message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_merge_commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
network_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
master_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
anonymous_access_enabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
source: | |
archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_rebase_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
template_repository: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_squash_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_auto_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete_branch_on_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_update_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
use_squash_pr_title_as_default: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
squash_merge_commit_title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
squash_merge_commit_message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_commit_title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_commit_message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_merge_commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
network_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
master_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
anonymous_access_enabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
master_branch: <string> | |
anonymous_access_enabled: true | |
code_of_conduct: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
key: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
security_and_analysis: | |
advanced_security: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
dependabot_security_updates: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
secret_scanning: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
secret_scanning_push_protection: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'301': | |
description: Moved Permanently | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/activity: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: List repository activities | |
description: >- | |
Lists a detailed history of changes to a repository, such as pushes, | |
merges, force pushes, and branch changes, and associates these changes | |
with commits and users. | |
For more information about viewing repository activity, | |
see "[Viewing activity and data for your | |
repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: direction | |
in: query | |
schema: | |
type: string | |
description: The direction to sort the results by. | |
example: desc | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: before | |
in: query | |
schema: | |
type: string | |
description: >- | |
A cursor, as given in the [Link | |
header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). | |
If specified, the query only searches for results before this | |
cursor. | |
example: <string> | |
- name: after | |
in: query | |
schema: | |
type: string | |
description: >- | |
A cursor, as given in the [Link | |
header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). | |
If specified, the query only searches for results after this cursor. | |
example: <string> | |
- name: ref | |
in: query | |
schema: | |
type: string | |
description: >- | |
The Git reference for the activities you want to list. | |
The `ref` for a branch can be formatted either as | |
`refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is | |
the name of your branch. | |
example: <string> | |
- name: actor | |
in: query | |
schema: | |
type: string | |
description: >- | |
The GitHub username to use to filter by the actor who performed the | |
activity. | |
example: <string> | |
- name: time_period | |
in: query | |
schema: | |
type: string | |
description: >- | |
The time period to filter by. | |
For example, `day` will filter for activity that occurred in the | |
past 24 hours, and `week` will filter for activity that occurred in | |
the past 7 days (168 hours). | |
example: <string> | |
- name: activity_type | |
in: query | |
schema: | |
type: string | |
description: >- | |
The activity type to filter by. | |
For example, you can choose to filter by "force_push", to see all | |
force pushes to the repository. | |
example: <string> | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
before: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
after: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ref: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
timestamp: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
activity_type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
actor: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
before: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
after: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ref: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
timestamp: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
activity_type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
actor: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- <string> | |
- <string> | |
/repos/{owner}/{repo}/codeowners/errors: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: List CODEOWNERS errors | |
description: >- | |
List any syntax errors that are detected in the CODEOWNERS | |
file. | |
For more information about the correct CODEOWNERS syntax, | |
see "[About code | |
owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: ref | |
in: query | |
schema: | |
type: string | |
description: >- | |
A branch, tag or commit name used to determine which version of the | |
CODEOWNERS file to use. Default: the repository's default branch | |
(e.g. `main`) | |
example: <string> | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
errors: | |
- line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
column: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
kind: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
source: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
suggestion: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- line: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
column: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
kind: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
path: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
source: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
suggestion: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
/repos/{owner}/{repo}/community/profile: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: Get community profile metrics | |
description: >- | |
Returns all community profile metrics for a repository. The repository | |
cannot be a fork. | |
The returned metrics include an overall health score, the repository | |
description, the presence of documentation, the | |
detected code of conduct, the detected license, and the presence of | |
ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, | |
README, and CONTRIBUTING files. | |
The `health_percentage` score is defined as a percentage of how many of | |
the recommended community health files are present. For more | |
information, see | |
"[About community profiles for public | |
repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." | |
`content_reports_enabled` is only returned for organization-owned | |
repositories. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
health_percentage: <integer> | |
description: <string,null> | |
documentation: <string,null> | |
files: | |
code_of_conduct: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
code_of_conduct_file: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributing: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
readme: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: <string,null-date-time> | |
content_reports_enabled: <boolean> | |
/repos/{owner}/{repo}/compare/{basehead}: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: Compare two commits | |
description: >- | |
Compares two commits against one another. You can compare branches in | |
the same repository, or you can compare branches that exist in different | |
repositories within the same repository network, including fork | |
branches. For more information about how to view a repository's network, | |
see "[Understanding connections between | |
repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." | |
This endpoint is equivalent to running the `git log BASE..HEAD` command, | |
but it returns commits in a different order. The `git log BASE..HEAD` | |
command returns commits in reverse chronological order, whereas the API | |
returns commits in chronological order. You can pass the appropriate | |
[media | |
type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) | |
to fetch diff and patch formats. | |
The API response includes details about the files that were changed | |
between the two commits. This includes the status of the change (if a | |
file was added, removed, modified, or renamed), and details of the | |
change itself. For example, files with a `renamed` status have a | |
`previous_filename` field showing the previous filename of the file, and | |
files with a `modified` status have a `patch` field showing the changes | |
made to the file. | |
When calling this endpoint without any paging parameter (`per_page` or | |
`page`), the returned list is limited to 250 commits, and the last | |
commit in the list is the most recent of the entire comparison. | |
**Working with large comparisons** | |
To process a response with a large number of commits, use a query | |
parameter (`per_page` or `page`) to paginate the results. When using | |
pagination: | |
- The list of changed files is only shown on the first page of results, | |
but it includes all changed files for the entire comparison. | |
- The results are returned in chronological order, but the last commit | |
in the returned list may not be the most recent one in the entire set if | |
there are more pages of results. | |
For more information on working with pagination, see "[Using pagination | |
in the REST | |
API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)." | |
**Signature verification object** | |
The response will include a `verification` object that describes the | |
result of verifying the commit's signature. The `verification` object | |
includes the following fields: | |
| Name | Type | Description | | |
| ---- | ---- | ----------- | | |
| `verified` | `boolean` | Indicates whether GitHub considers the | |
signature in this commit to be verified. | | |
| `reason` | `string` | The reason for verified value. Possible values | |
and their meanings are enumerated in table below. | | |
| `signature` | `string` | The signature that was extracted from the | |
commit. | | |
| `payload` | `string` | The value that was signed. | | |
These are the possible values for `reason` in the `verification` object: | |
| Value | Description | | |
| ----- | ----------- | | |
| `expired_key` | The key that made the signature is expired. | | |
| `not_signing_key` | The "signing" flag is not among the usage flags in | |
the GPG key that made the signature. | | |
| `gpgverify_error` | There was an error communicating with the | |
signature verification service. | | |
| `gpgverify_unavailable` | The signature verification service is | |
currently unavailable. | | |
| `unsigned` | The object does not include a signature. | | |
| `unknown_signature_type` | A non-PGP signature was found in the | |
commit. | | |
| `no_user` | No user was associated with the `committer` email address | |
in the commit. | | |
| `unverified_email` | The `committer` email address in the commit was | |
associated with a user, but the email address is not verified on their | |
account. | | |
| `bad_email` | The `committer` email address in the commit is not | |
included in the identities of the PGP key that made the signature. | | |
| `unknown_key` | The key that made the signature has not been | |
registered with any user's account. | | |
| `malformed_signature` | There was an error parsing the signature. | | |
| `invalid` | The signature could not be cryptographically verified | |
using the key whose key-id was found in the signature. | | |
| `valid` | None of the above errors applied, so the signature is | |
considered to be verified. | | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: basehead | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The base branch and head branch to compare. This | |
parameter expects the format `BASE...HEAD`. Both must be branch | |
names in `repo`. To compare with a branch that exists in a different | |
repository in the same network as `repo`, the `basehead` parameter | |
expects the format `USERNAME:BASE...USERNAME:HEAD`. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
url: <uri> | |
html_url: <uri> | |
permalink_url: <uri> | |
diff_url: <uri> | |
patch_url: <uri> | |
base_commit: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
committer: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parents: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stats: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
files: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merge_base_commit: | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
sha: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
committer: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parents: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stats: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
files: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
status: <string> | |
ahead_by: <integer> | |
behind_by: <integer> | |
total_commits: <integer> | |
commits: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
files: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'500': | |
description: Internal Server Error | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'503': | |
description: Service Unavailable | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
code: <string> | |
message: <string> | |
documentation_url: <string> | |
/repos/{owner}/{repo}/contributors: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: List repository contributors | |
description: >- | |
Lists contributors to the specified repository and sorts them by the | |
number of commits per contributor in descending order. This endpoint may | |
return information that is a few hours old because the GitHub REST API | |
caches contributor data to improve performance. | |
GitHub identifies contributors by author email address. This endpoint | |
groups contribution counts by GitHub user, which includes all associated | |
email addresses. To improve performance, only the first 500 author email | |
addresses in the repository link to GitHub users. The rest will appear | |
as anonymous contributors without associated GitHub user information. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: anon | |
in: query | |
schema: | |
type: string | |
description: Set to `1` or `true` to include anonymous contributors in results. | |
example: <string> | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- contributions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- contributions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gravatar_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
following_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gists_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starred_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscriptions_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organizations_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
received_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
site_admin: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'204': | |
description: No Content | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/events: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: List repository events | |
description: > | |
**Note**: This API is not built to serve real-time use cases. Depending | |
on the time of day, event latency can be anywhere from 30s to 6h. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
actor: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repo: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
payload: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
public: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
org: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
actor: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repo: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
payload: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
public: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
org: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/installation: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: Get a repository installation for the authenticated app | |
description: >- | |
Enables an authenticated GitHub App to find the repository's | |
installation information. The installation's account type will be either | |
an organization or a user account, depending which account the | |
repository belongs to. | |
You must use a | |
[JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) | |
to access this endpoint. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
id: <integer> | |
app_id: <integer> | |
app_slug: <string> | |
target_id: <integer> | |
target_type: <string> | |
single_file_name: <string,null> | |
repository_selection: <string> | |
access_tokens_url: <uri> | |
html_url: <uri> | |
repositories_url: <uri> | |
events: | |
- <string> | |
- <string> | |
account: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
actions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
administration: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
checks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
codespaces: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
dependabot_secrets: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
environments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
metadata: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
packages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_requests: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repository_custom_properties: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repository_hooks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repository_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
secret_scanning_alerts: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
secrets: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
security_events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
single_file: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
vulnerability_alerts: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
workflows: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_administration: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_custom_roles: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_custom_org_roles: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_custom_properties: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_copilot_seat_management: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_announcement_banners: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_events: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_hooks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_personal_access_tokens: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_personal_access_token_requests: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_plan: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_packages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_secrets: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_self_hosted_runners: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
organization_user_blocking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
team_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
email_addresses: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
followers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_ssh_keys: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
gpg_keys: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
interaction_limits: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
profile: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
starring: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: <dateTime> | |
updated_at: <dateTime> | |
suspended_by: <null> | |
suspended_at: <string,null-date-time> | |
has_multiple_single_files: <boolean> | |
single_file_paths: | |
- <string> | |
- <string> | |
contact_email: <string,null> | |
'301': | |
description: Moved Permanently | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/languages: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: List repository languages | |
description: >- | |
Lists languages for the specified repository. The value shown for each | |
language is the number of bytes of code written in that language. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
exercitation_a: <integer> | |
dolor6cb: <integer> | |
/repos/{owner}/{repo}/license: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: Get the license for a repository | |
description: >- | |
This method returns the contents of the repository's license file, if | |
one is detected. | |
Similar to [Get repository | |
content](https://docs.github.com/rest/repos/contents#get-repository-content), | |
this method also supports [custom media | |
types](https://docs.github.com/rest/overview/media-types) for retrieving | |
the raw license content or rendered license HTML. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
_links: | |
git: <string,null-uri> | |
html: <string,null-uri> | |
self: <uri> | |
git_url: <string,null-uri> | |
html_url: <string,null-uri> | |
download_url: <string,null-uri> | |
name: <string> | |
path: <string> | |
sha: <string> | |
size: <integer> | |
type: <string> | |
url: <uri> | |
content: <string> | |
encoding: <string> | |
license: <null> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/properties/values: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: Get all custom property values for a repository | |
description: |- | |
Gets all custom property values that are set for a repository. | |
Users with read access to the repository can use this endpoint. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- property_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- property_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/rules/branches/{branch}: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: Get rules for a branch | |
description: >- | |
Returns all active rules that apply to the specified branch. The branch | |
does not need to exist; rules that would apply | |
to a branch with that name will be returned. All active rules that apply | |
will be returned, regardless of the level | |
at which they are configured (e.g. repository or organization). Rules in | |
rulesets with "evaluate" or "disabled" | |
enforcement statuses are not returned. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: branch | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the branch. Cannot contain wildcard | |
characters. To use wildcard characters in branch names, use [the | |
GraphQL API](https://docs.github.com/graphql). | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
/repos/{owner}/{repo}/tarball/{ref}: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: Download a repository archive (tar) | |
description: >- | |
Gets a redirect URL to download a tar archive for a repository. If you | |
omit `:ref`, the repository’s default branch (usually | |
`main`) will be used. Please make sure your HTTP framework is configured | |
to follow redirects or you will need to use | |
the `Location` header to make a second `GET` request. | |
**Note**: For private repositories, these links are temporary and expire | |
after five minutes. | |
parameters: | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: '(Required) ' | |
example: <string> | |
responses: | |
'302': | |
description: Found | |
headers: | |
Location: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
/repos/{owner}/{repo}/teams: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: List repository teams | |
description: >- | |
Lists the teams that have access to the specified repository and that | |
are also visible to the authenticated user. | |
For a public repository, a team is listed only if that team added the | |
public repository explicitly. | |
Personal access tokens require the following scopes: | |
* `public_repo` to call this endpoint on a public repository | |
* `repo` to call this endpoint on a private repository (this scope also | |
includes public repositories) | |
This endpoint is not compatible with fine-grained personal access | |
tokens. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permission: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repositories_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
slug: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
parent: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
privacy: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notification_setting: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/repos/{owner}/{repo}/zipball/{ref}: | |
get: | |
tags: | |
- repos > {owner}/{repo} | |
summary: Download a repository archive (zip) | |
description: >- | |
Gets a redirect URL to download a zip archive for a repository. If you | |
omit `:ref`, the repository’s default branch (usually | |
`main`) will be used. Please make sure your HTTP framework is configured | |
to follow redirects or you will need to use | |
the `Location` header to make a second `GET` request. | |
**Note**: For private repositories, these links are temporary and expire | |
after five minutes. If the repository is empty, you will receive a 404 | |
when you follow the redirect. | |
parameters: | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
- name: ref | |
in: path | |
schema: | |
type: string | |
required: true | |
description: '(Required) ' | |
example: <string> | |
responses: | |
'302': | |
description: Found | |
headers: | |
Location: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
/repositories: | |
get: | |
tags: | |
- repositories | |
summary: List public repositories | |
description: >- | |
Lists all public repositories in the order that they were created. | |
Note: | |
- For GitHub Enterprise Server, this endpoint will only list | |
repositories available to all users on the enterprise. | |
- Pagination is powered exclusively by the `since` parameter. Use the | |
[Link | |
header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) | |
to get the URL for the next page of repositories. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: since | |
in: query | |
schema: | |
type: string | |
description: >- | |
A repository ID. Only return repositories with an ID greater than | |
this ID. | |
example: <integer> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
role_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete_branch_on_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
network_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
code_of_conduct: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
security_and_analysis: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- archive_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
blobs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
branches_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
collaborators_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
compare_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contents_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
contributors_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
deployments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
downloads_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
fork: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
full_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_commits_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_refs_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_comment_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issue_events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
keys_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
languages_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
merges_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestones_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
notifications_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
owner: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
private: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pulls_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
releases_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
statuses_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscription_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
tags_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
teams_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
trees_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
git_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
ssh_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
clone_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
mirror_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
svn_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
homepage: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
language: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
stargazers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
size: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
default_branch: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
is_template: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
topics: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_projects: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_wiki: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_pages: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_downloads: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
has_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
archived: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
disabled: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
visibility: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pushed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
permissions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
role_name: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
temp_clone_token: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
delete_branch_on_merge: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
subscribers_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
network_count: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
code_of_conduct: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
license: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
forks: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
open_issues: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
watchers: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
allow_forking: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
web_commit_signoff_required: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
security_and_analysis: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/search/code: | |
get: | |
tags: | |
- search | |
summary: Search code | |
description: >- | |
Searches for query terms inside of a file. This method returns up to 100 | |
results [per | |
page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). | |
When searching for code, you can get text match metadata for the file | |
**content** and file **path** fields when you pass the `text-match` | |
media type. For more details about how to receive highlighted search | |
results, see [Text match | |
metadata](https://docs.github.com/rest/search/search#text-match-metadata). | |
For example, if you want to find the definition of the `addClass` | |
function inside [jQuery](https://github.com/jquery/jquery) repository, | |
your query would look something like this: | |
`q=addClass+in:file+language:js+repo:jquery/jquery` | |
This query searches for the keyword `addClass` within a file's contents. | |
The query limits the search to files where the language is JavaScript in | |
the `jquery/jquery` repository. | |
Considerations for code search: | |
Due to the complexity of searching code, there are a few restrictions on | |
how searches are performed: | |
* Only the _default branch_ is considered. In most cases, this will be | |
the `master` branch. | |
* Only files smaller than 384 KB are searchable. | |
* You must always include at least one search term when searching | |
source code. For example, searching for | |
[`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) | |
is not valid, while [`amazing | |
language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) | |
is. | |
This endpoint requires you to authenticate and limits you to 10 requests | |
per minute. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: q | |
in: query | |
schema: | |
type: string | |
description: >- | |
(Required) The query contains one or more search keywords and | |
qualifiers. Qualifiers allow you to limit your search to specific | |
areas of GitHub. The REST API supports the same qualifiers as the | |
web interface for GitHub. To learn more about the format of the | |
query, see [Constructing a search | |
query](https://docs.github.com/rest/search/search#constructing-a-search-query). | |
See "[Searching | |
code](https://docs.github.com/search-github/searching-on-github/searching-code)" | |
for a detailed list of qualifiers. | |
example: <string> | |
- name: sort | |
in: query | |
schema: | |
type: string | |
description: >- | |
**This field is deprecated.** Sorts the results of your query. Can | |
only be `indexed`, which indicates how recently a file has been | |
indexed by the GitHub search infrastructure. Default: [best | |
match](https://docs.github.com/rest/search/search#ranking-search-results) | |
example: <string> | |
- name: order | |
in: query | |
schema: | |
type: string | |
description: >- | |
**This field is deprecated.** Determines whether the first search | |
result returned is the highest number of matches (`desc`) or lowest | |
number of matches (`asc`). This parameter is ignored unless you | |
provide `sort`. | |
example: desc | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
total_count: <integer> | |
incomplete_results: <boolean> | |
items: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'503': | |
description: Service Unavailable | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
code: <string> | |
message: <string> | |
documentation_url: <string> | |
/search/commits: | |
get: | |
tags: | |
- search | |
summary: Search commits | |
description: >- | |
Find commits via various criteria on the default branch (usually | |
`main`). This method returns up to 100 results [per | |
page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). | |
When searching for commits, you can get text match metadata for the | |
**message** field when you provide the `text-match` media type. For more | |
details about how to receive highlighted search results, see [Text match | |
metadata](https://docs.github.com/rest/search/search#text-match-metadata). | |
For example, if you want to find commits related to CSS in the | |
[octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) | |
repository. Your query would look something like this: | |
`q=repo:octocat/Spoon-Knife+css` | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: q | |
in: query | |
schema: | |
type: string | |
description: >- | |
(Required) The query contains one or more search keywords and | |
qualifiers. Qualifiers allow you to limit your search to specific | |
areas of GitHub. The REST API supports the same qualifiers as the | |
web interface for GitHub. To learn more about the format of the | |
query, see [Constructing a search | |
query](https://docs.github.com/rest/search/search#constructing-a-search-query). | |
See "[Searching | |
commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" | |
for a detailed list of qualifiers. | |
example: <string> | |
- name: sort | |
in: query | |
schema: | |
type: string | |
description: >- | |
Sorts the results of your query by `author-date` or | |
`committer-date`. Default: [best | |
match](https://docs.github.com/rest/search/search#ranking-search-results) | |
example: <string> | |
- name: order | |
in: query | |
schema: | |
type: string | |
description: >- | |
Determines whether the first search result returned is the highest | |
number of matches (`desc`) or lowest number of matches (`asc`). This | |
parameter is ignored unless you provide `sort`. | |
example: desc | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
total_count: <integer> | |
incomplete_results: <boolean> | |
items: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
/search/issues: | |
get: | |
tags: | |
- search | |
summary: Search issues and pull requests | |
description: >- | |
Find issues by state and keyword. This method returns up to 100 results | |
[per | |
page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). | |
When searching for issues, you can get text match metadata for the issue | |
**title**, issue **body**, and issue **comment body** fields when you | |
pass the `text-match` media type. For more details about how to receive | |
highlighted | |
search results, see [Text match | |
metadata](https://docs.github.com/rest/search/search#text-match-metadata). | |
For example, if you want to find the oldest unresolved Python bugs on | |
Windows. Your query might look something like this. | |
`q=windows+label:bug+language:python+state:open&sort=created&order=asc` | |
This query searches for the keyword `windows`, within any open issue | |
that is labeled as `bug`. The search runs across repositories whose | |
primary language is Python. The results are sorted by creation date in | |
ascending order, which means the oldest issues appear first in the | |
search results. | |
**Note:** For requests made by GitHub Apps with a user access token, you | |
can't retrieve a combination of issues and pull requests in a single | |
query. Requests that don't include the `is:issue` or `is:pull-request` | |
qualifier will receive an HTTP `422 Unprocessable Entity` response. To | |
get results for both issues and pull requests, you must send separate | |
queries for issues and pull requests. For more information about the | |
`is` qualifier, see "[Searching only issues or pull | |
requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: q | |
in: query | |
schema: | |
type: string | |
description: >- | |
(Required) The query contains one or more search keywords and | |
qualifiers. Qualifiers allow you to limit your search to specific | |
areas of GitHub. The REST API supports the same qualifiers as the | |
web interface for GitHub. To learn more about the format of the | |
query, see [Constructing a search | |
query](https://docs.github.com/rest/search/search#constructing-a-search-query). | |
See "[Searching issues and pull | |
requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" | |
for a detailed list of qualifiers. | |
example: <string> | |
- name: sort | |
in: query | |
schema: | |
type: string | |
description: >- | |
Sorts the results of your query by the number of `comments`, | |
`reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, | |
`reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or | |
`interactions`. You can also sort results by how recently the items | |
were `created` or `updated`, Default: [best | |
match](https://docs.github.com/rest/search/search#ranking-search-results) | |
example: <string> | |
- name: order | |
in: query | |
schema: | |
type: string | |
description: >- | |
Determines whether the first search result returned is the highest | |
number of matches (`desc`) or lowest number of matches (`asc`). This | |
parameter is ignored unless you provide `sort`. | |
example: desc | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
total_count: <integer> | |
incomplete_results: <boolean> | |
items: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'503': | |
description: Service Unavailable | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
code: <string> | |
message: <string> | |
documentation_url: <string> | |
/search/labels: | |
get: | |
tags: | |
- search | |
summary: Search labels | |
description: >- | |
Find labels in a repository with names or descriptions that match search | |
keywords. Returns up to 100 results [per | |
page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). | |
When searching for labels, you can get text match metadata for the label | |
**name** and **description** fields when you pass the `text-match` media | |
type. For more details about how to receive highlighted search results, | |
see [Text match | |
metadata](https://docs.github.com/rest/search/search#text-match-metadata). | |
For example, if you want to find labels in the `linguist` repository | |
that match `bug`, `defect`, or `enhancement`. Your query might look like | |
this: | |
`q=bug+defect+enhancement&repository_id=64778136` | |
The labels that best match the query appear first in the search results. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: repository_id | |
in: query | |
schema: | |
type: string | |
description: (Required) The id of the repository. | |
example: <integer> | |
- name: q | |
in: query | |
schema: | |
type: string | |
description: >- | |
(Required) The search keywords. This endpoint does not accept | |
qualifiers in the query. To learn more about the format of the | |
query, see [Constructing a search | |
query](https://docs.github.com/rest/search/search#constructing-a-search-query). | |
example: <string> | |
- name: sort | |
in: query | |
schema: | |
type: string | |
description: >- | |
Sorts the results of your query by when the label was `created` or | |
`updated`. Default: [best | |
match](https://docs.github.com/rest/search/search#ranking-search-results) | |
example: <string> | |
- name: order | |
in: query | |
schema: | |
type: string | |
description: >- | |
Determines whether the first search result returned is the highest | |
number of matches (`desc`) or lowest number of matches (`asc`). This | |
parameter is ignored unless you provide `sort`. | |
example: desc | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
total_count: <integer> | |
incomplete_results: <boolean> | |
items: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/search/repositories: | |
get: | |
tags: | |
- search | |
summary: Search repositories | |
description: >- | |
Find repositories via various criteria. This method returns up to 100 | |
results [per | |
page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). | |
When searching for repositories, you can get text match metadata for the | |
**name** and **description** fields when you pass the `text-match` media | |
type. For more details about how to receive highlighted search results, | |
see [Text match | |
metadata](https://docs.github.com/rest/search/search#text-match-metadata). | |
For example, if you want to search for popular Tetris repositories | |
written in assembly code, your query might look like this: | |
`q=tetris+language:assembly&sort=stars&order=desc` | |
This query searches for repositories with the word `tetris` in the name, | |
the description, or the README. The results are limited to repositories | |
where the primary language is assembly. The results are sorted by stars | |
in descending order, so that the most popular repositories appear first | |
in the search results. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: q | |
in: query | |
schema: | |
type: string | |
description: >- | |
(Required) The query contains one or more search keywords and | |
qualifiers. Qualifiers allow you to limit your search to specific | |
areas of GitHub. The REST API supports the same qualifiers as the | |
web interface for GitHub. To learn more about the format of the | |
query, see [Constructing a search | |
query](https://docs.github.com/rest/search/search#constructing-a-search-query). | |
See "[Searching for | |
repositories](https://docs.github.com/articles/searching-for-repositories/)" | |
for a detailed list of qualifiers. | |
example: <string> | |
- name: sort | |
in: query | |
schema: | |
type: string | |
description: >- | |
Sorts the results of your query by number of `stars`, `forks`, or | |
`help-wanted-issues` or how recently the items were `updated`. | |
Default: [best | |
match](https://docs.github.com/rest/search/search#ranking-search-results) | |
example: <string> | |
- name: order | |
in: query | |
schema: | |
type: string | |
description: >- | |
Determines whether the first search result returned is the highest | |
number of matches (`desc`) or lowest number of matches (`asc`). This | |
parameter is ignored unless you provide `sort`. | |
example: desc | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
total_count: <integer> | |
incomplete_results: <boolean> | |
items: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'503': | |
description: Service Unavailable | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
code: <string> | |
message: <string> | |
documentation_url: <string> | |
/search/topics: | |
get: | |
tags: | |
- search | |
summary: Search topics | |
description: >- | |
Find topics via various criteria. Results are sorted by best match. This | |
method returns up to 100 results [per | |
page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). | |
See "[Searching | |
topics](https://docs.github.com/articles/searching-topics/)" for a | |
detailed list of qualifiers. | |
When searching for topics, you can get text match metadata for the | |
topic's **short\_description**, **description**, **name**, or | |
**display\_name** field when you pass the `text-match` media type. For | |
more details about how to receive highlighted search results, see [Text | |
match | |
metadata](https://docs.github.com/rest/search/search#text-match-metadata). | |
For example, if you want to search for topics related to Ruby that are | |
featured on https://github.com/topics. Your query might look like this: | |
`q=ruby+is:featured` | |
This query searches for topics with the keyword `ruby` and limits the | |
results to find only topics that are featured. The topics that are the | |
best match for the query appear first in the search results. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: q | |
in: query | |
schema: | |
type: string | |
description: >- | |
(Required) The query contains one or more search keywords and | |
qualifiers. Qualifiers allow you to limit your search to specific | |
areas of GitHub. The REST API supports the same qualifiers as the | |
web interface for GitHub. To learn more about the format of the | |
query, see [Constructing a search | |
query](https://docs.github.com/rest/search/search#constructing-a-search-query). | |
example: <string> | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
total_count: <integer> | |
incomplete_results: <boolean> | |
items: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
/search/users: | |
get: | |
tags: | |
- search | |
summary: Search users | |
description: >- | |
Find users via various criteria. This method returns up to 100 results | |
[per | |
page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). | |
When searching for users, you can get text match metadata for the issue | |
**login**, public **email**, and **name** fields when you pass the | |
`text-match` media type. For more details about highlighting search | |
results, see [Text match | |
metadata](https://docs.github.com/rest/search/search#text-match-metadata). | |
For more details about how to receive highlighted search results, see | |
[Text match | |
metadata](https://docs.github.com/rest/search/search#text-match-metadata). | |
For example, if you're looking for a list of popular users, you might | |
try this query: | |
`q=tom+repos:%3E42+followers:%3E1000` | |
This query searches for users with the name `tom`. The results are | |
restricted to users with more than 42 repositories and over 1,000 | |
followers. | |
This endpoint does not accept authentication and will only include | |
publicly visible users. As an alternative, you can use the GraphQL API. | |
The GraphQL API requires authentication and will return private users, | |
including Enterprise Managed Users (EMUs), that you are authorized to | |
view. For more information, see "[GraphQL | |
Queries](https://docs.github.com/graphql/reference/queries#search)." | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: q | |
in: query | |
schema: | |
type: string | |
description: >- | |
(Required) The query contains one or more search keywords and | |
qualifiers. Qualifiers allow you to limit your search to specific | |
areas of GitHub. The REST API supports the same qualifiers as the | |
web interface for GitHub. To learn more about the format of the | |
query, see [Constructing a search | |
query](https://docs.github.com/rest/search/search#constructing-a-search-query). | |
See "[Searching | |
users](https://docs.github.com/search-github/searching-on-github/searching-users)" | |
for a detailed list of qualifiers. | |
example: <string> | |
- name: sort | |
in: query | |
schema: | |
type: string | |
description: >- | |
Sorts the results of your query by number of `followers` or | |
`repositories`, or when the person `joined` GitHub. Default: [best | |
match](https://docs.github.com/rest/search/search#ranking-search-results) | |
example: <string> | |
- name: order | |
in: query | |
schema: | |
type: string | |
description: >- | |
Determines whether the first search result returned is the highest | |
number of matches (`desc`) or lowest number of matches (`asc`). This | |
parameter is ignored unless you provide `sort`. | |
example: desc | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
total_count: <integer> | |
incomplete_results: <boolean> | |
items: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'503': | |
description: Service Unavailable | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
code: <string> | |
message: <string> | |
documentation_url: <string> | |
/: | |
get: | |
tags: | |
- default | |
summary: GitHub API Root | |
description: Get Hypermedia links to resources accessible in GitHub's REST API | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
current_user_url: <uri-template> | |
current_user_authorizations_html_url: <uri-template> | |
authorizations_url: <uri-template> | |
code_search_url: <uri-template> | |
commit_search_url: <uri-template> | |
emails_url: <uri-template> | |
emojis_url: <uri-template> | |
events_url: <uri-template> | |
feeds_url: <uri-template> | |
followers_url: <uri-template> | |
following_url: <uri-template> | |
gists_url: <uri-template> | |
hub_url: <uri-template> | |
issue_search_url: <uri-template> | |
issues_url: <uri-template> | |
keys_url: <uri-template> | |
label_search_url: <uri-template> | |
notifications_url: <uri-template> | |
organization_url: <uri-template> | |
organization_repositories_url: <uri-template> | |
organization_teams_url: <uri-template> | |
public_gists_url: <uri-template> | |
rate_limit_url: <uri-template> | |
repository_url: <uri-template> | |
repository_search_url: <uri-template> | |
current_user_repositories_url: <uri-template> | |
starred_url: <uri-template> | |
starred_gists_url: <uri-template> | |
user_url: <uri-template> | |
user_organizations_url: <uri-template> | |
user_repositories_url: <uri-template> | |
user_search_url: <uri-template> | |
topic_search_url: <uri-template> | |
/apps/{app_slug}: | |
get: | |
tags: | |
- default | |
summary: Get an app | |
description: >- | |
**Note**: The `:app_slug` is just the URL-friendly name of your GitHub | |
App. You can find this on the settings page for your GitHub App (e.g., | |
`https://github.com/settings/apps/:app_slug`). | |
If the GitHub App you specify is public, you can access this endpoint | |
without authenticating. If the GitHub App you specify is private, you | |
must authenticate with a [personal access | |
token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) | |
or an [installation access | |
token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) | |
to access this endpoint. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: app_slug | |
in: path | |
schema: | |
type: string | |
required: true | |
description: '(Required) ' | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
id: <integer> | |
node_id: <string> | |
owner: <null> | |
name: <string> | |
description: <string,null> | |
external_url: <uri> | |
html_url: <uri> | |
created_at: <dateTime> | |
updated_at: <dateTime> | |
permissions: | |
issues: <string> | |
checks: <string> | |
metadata: <string> | |
contents: <string> | |
deployments: <string> | |
autee: <string> | |
Duis42: <string> | |
non882: <string> | |
events: | |
- <string> | |
- <string> | |
slug: <string> | |
installations_count: <integer> | |
client_id: <string> | |
client_secret: <string> | |
webhook_secret: <string,null> | |
pem: <string> | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/events: | |
get: | |
tags: | |
- default | |
summary: List public events | |
description: >- | |
We delay the public events feed by five minutes, which means the most | |
recent event returned by the public events API actually occurred at | |
least five minutes ago. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
actor: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repo: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
payload: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
public: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
org: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
actor: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repo: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
payload: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
public: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
org: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'503': | |
description: Service Unavailable | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
code: <string> | |
message: <string> | |
documentation_url: <string> | |
/feeds: | |
get: | |
tags: | |
- default | |
summary: Get feeds | |
description: >- | |
GitHub provides several timeline resources in | |
[Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds | |
API lists all the feeds available to the authenticated user: | |
* **Timeline**: The GitHub global public timeline | |
* **User**: The public timeline for any user, using [URI | |
template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) | |
* **Current user public**: The public timeline for the authenticated | |
user | |
* **Current user**: The private timeline for the authenticated user | |
* **Current user actor**: The private timeline for activity created by | |
the authenticated user | |
* **Current user organizations**: The private timeline for the | |
organizations the authenticated user is a member of. | |
* **Security advisories**: A collection of public announcements that | |
provide information about security-related vulnerabilities in software | |
on GitHub. | |
**Note**: Private feeds are only returned when [authenticating via Basic | |
Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) | |
since current feed URIs use the older, non revocable auth tokens. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
_links: | |
timeline: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
security_advisories: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
current_user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
current_user_public: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
current_user_actor: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
current_user_organization: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
current_user_organizations: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
repository_discussions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repository_discussions_category: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
timeline_url: <string> | |
user_url: <string> | |
current_user_public_url: <string> | |
current_user_url: <string> | |
current_user_actor_url: <string> | |
current_user_organization_url: <string> | |
current_user_organization_urls: | |
- <uri> | |
- <uri> | |
security_advisories_url: <string> | |
repository_discussions_url: <string> | |
repository_discussions_category_url: <string> | |
/issues: | |
get: | |
tags: | |
- default | |
summary: List issues assigned to the authenticated user | |
description: >- | |
List issues assigned to the authenticated user across all visible | |
repositories including owned repositories, member | |
repositories, and organization repositories. You can use the `filter` | |
query parameter to fetch issues that are not | |
necessarily assigned to you. | |
**Note**: GitHub's REST API considers every pull request an issue, but | |
not every issue is a pull request. For this | |
reason, "Issues" endpoints may return both issues and pull requests in | |
the response. You can identify pull requests by | |
the `pull_request` key. Be aware that the `id` of a pull request | |
returned from "Issues" endpoints will be an _issue id_. To find out the | |
pull | |
request id, use the "[List pull | |
requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" | |
endpoint. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: filter | |
in: query | |
schema: | |
type: string | |
description: >- | |
Indicates which sorts of issues to return. `assigned` means issues | |
assigned to you. `created` means issues created by you. `mentioned` | |
means issues mentioning you. `subscribed` means issues you're | |
subscribed to updates for. `all` or `repos` means all issues you can | |
see, regardless of participation or creation. | |
example: assigned | |
- name: state | |
in: query | |
schema: | |
type: string | |
description: Indicates the state of the issues to return. | |
example: open | |
- name: labels | |
in: query | |
schema: | |
type: string | |
description: 'A list of comma separated label names. Example: `bug,ui,@high`' | |
example: <string> | |
- name: sort | |
in: query | |
schema: | |
type: string | |
description: What to sort results by. | |
example: created | |
- name: direction | |
in: query | |
schema: | |
type: string | |
description: The direction to sort the results by. | |
example: desc | |
- name: since | |
in: query | |
schema: | |
type: string | |
description: >- | |
Only show results that were last updated after the given time. This | |
is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) | |
format: `YYYY-MM-DDTHH:MM:SSZ`. | |
example: <dateTime> | |
- name: collab | |
in: query | |
schema: | |
type: string | |
example: <boolean> | |
- name: orgs | |
in: query | |
schema: | |
type: string | |
example: <boolean> | |
- name: owned | |
in: query | |
schema: | |
type: string | |
example: <boolean> | |
- name: pulls | |
in: query | |
schema: | |
type: string | |
example: <boolean> | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- assignee: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
closed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestone: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
number: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repository_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
locked: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state_reason: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
active_lock_reason: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
draft: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
closed_by: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_text: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
timeline_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repository: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
performed_via_github_app: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reactions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- assignee: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
closed_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
comments_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
html_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
labels_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
milestone: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
number: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repository_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
locked: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
title: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
user: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
author_association: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
updated_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
state_reason: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
assignees: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
active_lock_reason: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
pull_request: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
draft: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
closed_by: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_html: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
body_text: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
timeline_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repository: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
performed_via_github_app: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reactions: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'422': | |
description: Unprocessable Entity (WebDAV) (RFC 4918) | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
errors: | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- code: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resource: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
field: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
message: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
index: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
value: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
/meta: | |
get: | |
tags: | |
- default | |
summary: Get GitHub meta information | |
description: >- | |
Returns meta information about GitHub, including a list of GitHub's IP | |
addresses. For more information, see "[About GitHub's IP | |
addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." | |
The API's response also includes a list of GitHub's domain names. | |
The values shown in the documentation's response are example values. You | |
must always query the API directly to get the latest values. | |
**Note:** This endpoint returns both IPv4 and IPv6 addresses. However, | |
not all features support IPv6. You should refer to the specific | |
documentation for each feature to determine if IPv6 is supported. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
verifiable_password_authentication: <boolean> | |
ssh_key_fingerprints: | |
SHA256_RSA: <string> | |
SHA256_DSA: <string> | |
SHA256_ECDSA: <string> | |
SHA256_ED25519: <string> | |
ssh_keys: | |
- <string> | |
- <string> | |
hooks: | |
- <string> | |
- <string> | |
github_enterprise_importer: | |
- <string> | |
- <string> | |
web: | |
- <string> | |
- <string> | |
api: | |
- <string> | |
- <string> | |
git: | |
- <string> | |
- <string> | |
packages: | |
- <string> | |
- <string> | |
pages: | |
- <string> | |
- <string> | |
importer: | |
- <string> | |
- <string> | |
actions: | |
- <string> | |
- <string> | |
dependabot: | |
- <string> | |
- <string> | |
domains: | |
website: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
codespaces: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
copilot: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
packages: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
actions: | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
- value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
/networks/{owner}/{repo}/events: | |
get: | |
tags: | |
- default | |
summary: List public events for a network of repositories | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
- name: page | |
in: query | |
schema: | |
type: integer | |
description: Page number of the results to fetch. | |
example: '1' | |
- name: owner | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The account owner of the repository. The name is not case | |
sensitive. | |
example: <string> | |
- name: repo | |
in: path | |
schema: | |
type: string | |
required: true | |
description: >- | |
(Required) The name of the repository without the `.git` extension. | |
The name is not case sensitive. | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
actor: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repo: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
payload: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
public: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
org: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
type: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
actor: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repo: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
payload: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
public: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
created_at: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
org: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'301': | |
description: Moved Permanently | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'403': | |
description: Forbidden | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/octocat: | |
get: | |
tags: | |
- default | |
summary: Get Octocat | |
description: Get the octocat as ASCII art | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/octocat-stream | |
- name: s | |
in: query | |
schema: | |
type: string | |
description: The words to show in Octocat's speech bubble | |
example: <string> | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/octocat-stream | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: <string> | |
/organizations: | |
get: | |
tags: | |
- default | |
summary: List organizations | |
description: >- | |
Lists all organizations, in the order that they were created on GitHub. | |
**Note:** Pagination is powered exclusively by the `since` parameter. | |
Use the [Link | |
header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) | |
to get the URL for the next page of organizations. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
- name: since | |
in: query | |
schema: | |
type: string | |
description: >- | |
An organization ID. Only return organizations with an ID greater | |
than this ID. | |
example: <integer> | |
- name: per_page | |
in: query | |
schema: | |
type: integer | |
description: The number of results per page (max 100). | |
example: '30' | |
responses: | |
'200': | |
description: OK | |
headers: | |
Link: | |
schema: | |
type: string | |
example: <string> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
public_members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
- login: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
node_id: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
repos_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
events_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
hooks_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
issues_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
public_members_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
avatar_url: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
description: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
/rate_limit: | |
get: | |
tags: | |
- default | |
summary: Get rate limit status for the authenticated user | |
description: >- | |
**Note:** Accessing this endpoint does not count against your REST API | |
rate limit. | |
Some categories of endpoints have custom rate limits that are separate | |
from the rate limit governing the other REST API endpoints. For this | |
reason, the API response categorizes your rate limit. Under `resources`, | |
you'll see objects relating to different categories: | |
* The `core` object provides your rate limit status for all | |
non-search-related resources in the REST API. | |
* The `search` object provides your rate limit status for the REST API | |
for searching (excluding code searches). For more information, see | |
"[Search](https://docs.github.com/rest/search)." | |
* The `code_search` object provides your rate limit status for the REST | |
API for searching code. For more information, see "[Search | |
code](https://docs.github.com/rest/search/search#search-code)." | |
* The `graphql` object provides your rate limit status for the GraphQL | |
API. For more information, see "[Resource | |
limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." | |
* The `integration_manifest` object provides your rate limit status for | |
the `POST /app-manifests/{code}/conversions` operation. For more | |
information, see "[Creating a GitHub App from a | |
manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." | |
* The `dependency_snapshots` object provides your rate limit status for | |
submitting snapshots to the dependency graph. For more information, see | |
"[Dependency graph](https://docs.github.com/rest/dependency-graph)." | |
* The `code_scanning_upload` object provides your rate limit status for | |
uploading SARIF results to code scanning. For more information, see | |
"[Uploading a SARIF file to | |
GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." | |
* The `actions_runner_registration` object provides your rate limit | |
status for registering self-hosted runners in GitHub Actions. For more | |
information, see "[Self-hosted | |
runners](https://docs.github.com/rest/actions/self-hosted-runners)." | |
* The `source_import` object is no longer in use for any API endpoints, | |
and it will be removed in the next API version. For more information | |
about API versions, see "[API | |
Versions](https://docs.github.com/rest/overview/api-versions)." | |
**Note:** The `rate` object is deprecated. If you're writing new API | |
client code or updating existing code, you should use the `core` object | |
instead of the `rate` object. The `core` object contains the same | |
information that is present in the `rate` object. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
responses: | |
'200': | |
description: OK | |
headers: | |
X-RateLimit-Limit: | |
schema: | |
type: string | |
example: <integer> | |
X-RateLimit-Remaining: | |
schema: | |
type: string | |
example: <integer> | |
X-RateLimit-Reset: | |
schema: | |
type: string | |
example: <timestamp> | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
rate: | |
limit: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
remaining: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
reset: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
used: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
resources: | |
core: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
search: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
graphql: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
code_search: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
source_import: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
integration_manifest: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
code_scanning_upload: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
actions_runner_registration: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
scim: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
dependency_snapshots: | |
value: '<Error: Too many levels of nesting to fake this schema>' | |
'304': | |
description: Not Modified | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: text/plain | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: '' | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/versions: | |
get: | |
tags: | |
- default | |
summary: Get all API versions | |
description: Get all supported GitHub API versions. | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
- <date> | |
- <date> | |
'404': | |
description: Not Found | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
message: <string> | |
documentation_url: <string> | |
url: <string> | |
status: <string> | |
/zen: | |
get: | |
tags: | |
- default | |
summary: Get the Zen of GitHub | |
description: Get a random sentence from the Zen of GitHub | |
parameters: | |
- name: Accept | |
in: header | |
schema: | |
type: string | |
example: application/json | |
responses: | |
'200': | |
description: OK | |
headers: | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
content: | |
application/json: | |
schema: | |
type: object | |
example: <string> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment