|
1 | 1 | { |
2 | 2 | "openapi": "3.0.3", |
3 | 3 | "info": { |
4 | | - "version": "2.13.1", |
| 4 | + "version": "2.13.2", |
5 | 5 | "title": "GitHub's official OpenAPI spec + Octokit extension", |
6 | 6 | "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", |
7 | 7 | "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, |
|
9404 | 9404 | { "$ref": "#/components/parameters/org" }, |
9405 | 9405 | { |
9406 | 9406 | "name": "type", |
9407 | | - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", |
| 9407 | + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", |
9408 | 9408 | "in": "query", |
9409 | 9409 | "required": false, |
9410 | 9410 | "schema": { |
|
9482 | 9482 | }, |
9483 | 9483 | "post": { |
9484 | 9484 | "summary": "Create an organization repository", |
9485 | | - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", |
| 9485 | + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", |
9486 | 9486 | "tags": ["repos"], |
9487 | 9487 | "operationId": "repos/create-in-org", |
9488 | 9488 | "externalDocs": { |
|
9510 | 9510 | }, |
9511 | 9511 | "private": { |
9512 | 9512 | "type": "boolean", |
9513 | | - "description": "Either `true` to create a private repository or `false` to create a public one.", |
| 9513 | + "description": "Whether the repository is private.", |
9514 | 9514 | "default": false |
9515 | 9515 | }, |
9516 | 9516 | "visibility": { |
9517 | 9517 | "type": "string", |
9518 | | - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", |
| 9518 | + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", |
9519 | 9519 | "enum": ["public", "private", "visibility", "internal"] |
9520 | 9520 | }, |
9521 | 9521 | "has_issues": { |
|
30221 | 30221 | "/repos/{template_owner}/{template_repo}/generate": { |
30222 | 30222 | "post": { |
30223 | 30223 | "summary": "Create a repository using a template", |
30224 | | - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", |
| 30224 | + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", |
30225 | 30225 | "tags": ["repos"], |
30226 | 30226 | "operationId": "repos/create-using-template", |
30227 | 30227 | "externalDocs": { |
|
30321 | 30321 | "/repositories": { |
30322 | 30322 | "get": { |
30323 | 30323 | "summary": "List public repositories", |
30324 | | - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", |
| 30324 | + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", |
30325 | 30325 | "tags": ["repos"], |
30326 | 30326 | "operationId": "repos/list-public", |
30327 | 30327 | "externalDocs": { |
|
36692 | 36692 | "parameters": [ |
36693 | 36693 | { |
36694 | 36694 | "name": "visibility", |
36695 | | - "description": "Can be one of `all`, `public`, or `private`.", |
| 36695 | + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", |
36696 | 36696 | "in": "query", |
36697 | 36697 | "required": false, |
36698 | 36698 | "schema": { |
|
36713 | 36713 | }, |
36714 | 36714 | { |
36715 | 36715 | "name": "type", |
36716 | | - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", |
| 36716 | + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", |
36717 | 36717 | "in": "query", |
36718 | 36718 | "required": false, |
36719 | 36719 | "schema": { |
|
36778 | 36778 | }, |
36779 | 36779 | "post": { |
36780 | 36780 | "summary": "Create a repository for the authenticated user", |
36781 | | - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", |
| 36781 | + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", |
36782 | 36782 | "tags": ["repos"], |
36783 | 36783 | "operationId": "repos/create-for-authenticated-user", |
36784 | 36784 | "externalDocs": { |
|
36805 | 36805 | "type": "string" |
36806 | 36806 | }, |
36807 | 36807 | "private": { |
36808 | | - "description": "Whether the repository is private or public.", |
| 36808 | + "description": "Whether the repository is private.", |
36809 | 36809 | "default": false, |
36810 | 36810 | "type": "boolean" |
36811 | 36811 | }, |
|
38149 | 38149 | "/users/{username}/repos": { |
38150 | 38150 | "get": { |
38151 | 38151 | "summary": "List repositories for a user", |
38152 | | - "description": "Lists public repositories for the specified user.", |
| 38152 | + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", |
38153 | 38153 | "tags": ["repos"], |
38154 | 38154 | "operationId": "repos/list-for-user", |
38155 | 38155 | "externalDocs": { |
|
0 commit comments