Skip to content

fix(typescript): description updates #357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/repos/createForAuthenticatedUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Creates a new repository for the authenticated user.

When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:

- `public_repo` scope or `repo` scope to create a public repository
- `repo` scope to create a private repository
- `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- `repo` scope to create a private repository.

```js
octokit.repos.createForAuthenticatedUser({
Expand Down Expand Up @@ -51,7 +51,7 @@ A URL with more information about the repository.
</td></tr>
<tr><td>private</td><td>no</td><td>

Whether the repository is private or public.
Whether the repository is private.

</td></tr>
<tr><td>has_issues</td><td>no</td><td>
Expand Down
6 changes: 3 additions & 3 deletions docs/repos/createInOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Creates a new repository in the specified organization. The authenticated user m

When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:

- `public_repo` scope or `repo` scope to create a public repository
- `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- `repo` scope to create a private repository

```js
Expand Down Expand Up @@ -55,12 +55,12 @@ A URL with more information about the repository.
</td></tr>
<tr><td>private</td><td>no</td><td>

Either `true` to create a private repository or `false` to create a public one.
Whether the repository is private.

</td></tr>
<tr><td>visibility</td><td>no</td><td>

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.
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.
The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.

</td></tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/repos/createUsingTemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Creates a new repository using a repository template. Use the `template_owner` a

When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:

- `public_repo` scope or `repo` scope to create a public repository
- `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- `repo` scope to create a private repository

```js
Expand Down
4 changes: 2 additions & 2 deletions docs/repos/listForAuthenticatedUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ octokit.repos.listForAuthenticatedUser();
<tbody>
<tr><td>visibility</td><td>no</td><td>

Can be one of `all`, `public`, or `private`.
Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.

</td></tr>
<tr><td>affiliation</td><td>no</td><td>
Expand All @@ -42,7 +42,7 @@ Comma-separated list of values. Can include:
</td></tr>
<tr><td>type</td><td>no</td><td>

Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all`
Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all`

Will 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**.

Expand Down
2 changes: 1 addition & 1 deletion docs/repos/listForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ octokit.repos.listForOrg({
</td></tr>
<tr><td>type</td><td>no</td><td>

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`.
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`.

</td></tr>
<tr><td>sort</td><td>no</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/repos/listForUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: API method

# List repositories for a user

Lists public repositories for the specified user.
Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.

```js
octokit.repos.listForUser({
Expand Down
5 changes: 4 additions & 1 deletion docs/repos/listPublic.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ type: API method

Lists all public repositories in the order that they were created.

Note: 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.
Notes:

- For GitHub Enterprise Server and GitHub AE, 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/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.

```js
octokit.repos.listPublic();
Expand Down
22 changes: 11 additions & 11 deletions scripts/update-endpoints/generated/endpoints.json
Original file line number Diff line number Diff line change
Expand Up @@ -34197,7 +34197,7 @@
"url": "/user/repos",
"isDeprecated": false,
"deprecationDate": null,
"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",
"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.",
"documentationUrl": "https://docs.github.com/rest/reference/repos/#create-a-repository-for-the-authenticated-user",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -34243,7 +34243,7 @@
},
{
"name": "private",
"description": "Whether the repository is private or public.",
"description": "Whether the repository is private.",
"in": "BODY",
"type": "boolean",
"required": false,
Expand Down Expand Up @@ -34527,7 +34527,7 @@
"url": "/orgs/{org}/repos",
"isDeprecated": false,
"deprecationDate": null,
"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",
"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",
"documentationUrl": "https://docs.github.com/rest/reference/repos/#create-an-organization-repository",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -34586,7 +34586,7 @@
},
{
"name": "private",
"description": "Either `true` to create a private repository or `false` to create a public one.",
"description": "Whether the repository is private.",
"in": "BODY",
"type": "boolean",
"required": false,
Expand All @@ -34599,7 +34599,7 @@
},
{
"name": "visibility",
"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.",
"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.",
"in": "BODY",
"type": "string",
"required": false,
Expand Down Expand Up @@ -35417,7 +35417,7 @@
"url": "/repos/{template_owner}/{template_repo}/generate",
"isDeprecated": false,
"deprecationDate": null,
"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",
"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",
"documentationUrl": "https://docs.github.com/rest/reference/repos/#create-a-repository-using-a-template",
"previews": [{ "name": "baptiste" }],
"headers": [],
Expand Down Expand Up @@ -41033,7 +41033,7 @@
"parameters": [
{
"name": "visibility",
"description": "Can be one of `all`, `public`, or `private`.",
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
"in": "QUERY",
"type": "string",
"required": false,
Expand All @@ -41059,7 +41059,7 @@
},
{
"name": "type",
"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**.",
"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**.",
"in": "QUERY",
"type": "string",
"required": false,
Expand Down Expand Up @@ -41198,7 +41198,7 @@
},
{
"name": "type",
"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`.",
"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`.",
"in": "QUERY",
"type": "string",
"required": false,
Expand Down Expand Up @@ -41291,7 +41291,7 @@
"url": "/users/{username}/repos",
"isDeprecated": false,
"deprecationDate": null,
"description": "Lists public repositories for the specified user.",
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
"documentationUrl": "https://docs.github.com/rest/reference/repos/#list-repositories-for-a-user",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -41758,7 +41758,7 @@
"url": "/repositories",
"isDeprecated": false,
"deprecationDate": null,
"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.",
"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.",
"documentationUrl": "https://docs.github.com/rest/reference/repos/#list-public-repositories",
"previews": [],
"headers": [],
Expand Down
14 changes: 8 additions & 6 deletions src/generated/method-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6021,8 +6021,8 @@ export type RestEndpointMethods = {
*
* When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
*
* * `public_repo` scope or `repo` scope to create a public repository
* * `repo` scope to create a private repository
* * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
* * `repo` scope to create a private repository.
*/
createForAuthenticatedUser: {
(
Expand Down Expand Up @@ -6052,7 +6052,7 @@ export type RestEndpointMethods = {
*
* When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
*
* * `public_repo` scope or `repo` scope to create a public repository
* * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
* * `repo` scope to create a private repository
*/
createInOrg: {
Expand Down Expand Up @@ -6123,7 +6123,7 @@ export type RestEndpointMethods = {
*
* When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
*
* * `public_repo` scope or `repo` scope to create a public repository
* * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
* * `repo` scope to create a private repository
*/
createUsingTemplate: {
Expand Down Expand Up @@ -7224,7 +7224,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
* Lists public repositories for the specified user.
* Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.
*/
listForUser: {
(
Expand Down Expand Up @@ -7288,7 +7288,9 @@ export type RestEndpointMethods = {
/**
* Lists all public repositories in the order that they were created.
*
* Note: 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.
* Notes:
* - For GitHub Enterprise Server and GitHub AE, 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/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.
*/
listPublic: {
(
Expand Down