Skip to content

Commit aef66f9

Browse files
authored
fix(typescript): description updates (#357)
1 parent 0e5d8b0 commit aef66f9

File tree

9 files changed

+34
-29
lines changed

9 files changed

+34
-29
lines changed

docs/repos/createForAuthenticatedUser.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Creates a new repository for the authenticated user.
1414

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

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

2020
```js
2121
octokit.repos.createForAuthenticatedUser({
@@ -51,7 +51,7 @@ A URL with more information about the repository.
5151
</td></tr>
5252
<tr><td>private</td><td>no</td><td>
5353

54-
Whether the repository is private or public.
54+
Whether the repository is private.
5555

5656
</td></tr>
5757
<tr><td>has_issues</td><td>no</td><td>

docs/repos/createInOrg.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Creates a new repository in the specified organization. The authenticated user m
1414

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

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

2020
```js
@@ -55,12 +55,12 @@ A URL with more information about the repository.
5555
</td></tr>
5656
<tr><td>private</td><td>no</td><td>
5757

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

6060
</td></tr>
6161
<tr><td>visibility</td><td>no</td><td>
6262

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

6666
</td></tr>

docs/repos/createUsingTemplate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Creates a new repository using a repository template. Use the `template_owner` a
1414

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

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

2020
```js

docs/repos/listForAuthenticatedUser.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ octokit.repos.listForAuthenticatedUser();
2929
<tbody>
3030
<tr><td>visibility</td><td>no</td><td>
3131

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

3434
</td></tr>
3535
<tr><td>affiliation</td><td>no</td><td>
@@ -42,7 +42,7 @@ Comma-separated list of values. Can include:
4242
</td></tr>
4343
<tr><td>type</td><td>no</td><td>
4444

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

4747
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**.
4848

docs/repos/listForOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ octokit.repos.listForOrg({
3232
</td></tr>
3333
<tr><td>type</td><td>no</td><td>
3434

35-
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`.
35+
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`.
3636

3737
</td></tr>
3838
<tr><td>sort</td><td>no</td><td>

docs/repos/listForUser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ type: API method
88

99
# List repositories for a user
1010

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

1313
```js
1414
octokit.repos.listForUser({

docs/repos/listPublic.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ type: API method
1010

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

13-
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.
13+
Notes:
14+
15+
- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.
16+
- 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.
1417

1518
```js
1619
octokit.repos.listPublic();

scripts/update-endpoints/generated/endpoints.json

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34197,7 +34197,7 @@
3419734197
"url": "/user/repos",
3419834198
"isDeprecated": false,
3419934199
"deprecationDate": null,
34200-
"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",
34200+
"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.",
3420134201
"documentationUrl": "https://docs.github.com/rest/reference/repos/#create-a-repository-for-the-authenticated-user",
3420234202
"previews": [],
3420334203
"headers": [],
@@ -34243,7 +34243,7 @@
3424334243
},
3424434244
{
3424534245
"name": "private",
34246-
"description": "Whether the repository is private or public.",
34246+
"description": "Whether the repository is private.",
3424734247
"in": "BODY",
3424834248
"type": "boolean",
3424934249
"required": false,
@@ -34527,7 +34527,7 @@
3452734527
"url": "/orgs/{org}/repos",
3452834528
"isDeprecated": false,
3452934529
"deprecationDate": null,
34530-
"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",
34530+
"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",
3453134531
"documentationUrl": "https://docs.github.com/rest/reference/repos/#create-an-organization-repository",
3453234532
"previews": [],
3453334533
"headers": [],
@@ -34586,7 +34586,7 @@
3458634586
},
3458734587
{
3458834588
"name": "private",
34589-
"description": "Either `true` to create a private repository or `false` to create a public one.",
34589+
"description": "Whether the repository is private.",
3459034590
"in": "BODY",
3459134591
"type": "boolean",
3459234592
"required": false,
@@ -34599,7 +34599,7 @@
3459934599
},
3460034600
{
3460134601
"name": "visibility",
34602-
"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.",
34602+
"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.",
3460334603
"in": "BODY",
3460434604
"type": "string",
3460534605
"required": false,
@@ -35417,7 +35417,7 @@
3541735417
"url": "/repos/{template_owner}/{template_repo}/generate",
3541835418
"isDeprecated": false,
3541935419
"deprecationDate": null,
35420-
"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",
35420+
"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",
3542135421
"documentationUrl": "https://docs.github.com/rest/reference/repos/#create-a-repository-using-a-template",
3542235422
"previews": [{ "name": "baptiste" }],
3542335423
"headers": [],
@@ -41033,7 +41033,7 @@
4103341033
"parameters": [
4103441034
{
4103541035
"name": "visibility",
41036-
"description": "Can be one of `all`, `public`, or `private`.",
41036+
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
4103741037
"in": "QUERY",
4103841038
"type": "string",
4103941039
"required": false,
@@ -41059,7 +41059,7 @@
4105941059
},
4106041060
{
4106141061
"name": "type",
41062-
"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**.",
41062+
"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**.",
4106341063
"in": "QUERY",
4106441064
"type": "string",
4106541065
"required": false,
@@ -41198,7 +41198,7 @@
4119841198
},
4119941199
{
4120041200
"name": "type",
41201-
"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`.",
41201+
"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`.",
4120241202
"in": "QUERY",
4120341203
"type": "string",
4120441204
"required": false,
@@ -41291,7 +41291,7 @@
4129141291
"url": "/users/{username}/repos",
4129241292
"isDeprecated": false,
4129341293
"deprecationDate": null,
41294-
"description": "Lists public repositories for the specified user.",
41294+
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
4129541295
"documentationUrl": "https://docs.github.com/rest/reference/repos/#list-repositories-for-a-user",
4129641296
"previews": [],
4129741297
"headers": [],
@@ -41758,7 +41758,7 @@
4175841758
"url": "/repositories",
4175941759
"isDeprecated": false,
4176041760
"deprecationDate": null,
41761-
"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.",
41761+
"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.",
4176241762
"documentationUrl": "https://docs.github.com/rest/reference/repos/#list-public-repositories",
4176341763
"previews": [],
4176441764
"headers": [],

src/generated/method-types.ts

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6021,8 +6021,8 @@ export type RestEndpointMethods = {
60216021
*
60226022
* When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
60236023
*
6024-
* * `public_repo` scope or `repo` scope to create a public repository
6025-
* * `repo` scope to create a private repository
6024+
* * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
6025+
* * `repo` scope to create a private repository.
60266026
*/
60276027
createForAuthenticatedUser: {
60286028
(
@@ -6052,7 +6052,7 @@ export type RestEndpointMethods = {
60526052
*
60536053
* When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
60546054
*
6055-
* * `public_repo` scope or `repo` scope to create a public repository
6055+
* * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
60566056
* * `repo` scope to create a private repository
60576057
*/
60586058
createInOrg: {
@@ -6123,7 +6123,7 @@ export type RestEndpointMethods = {
61236123
*
61246124
* When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
61256125
*
6126-
* * `public_repo` scope or `repo` scope to create a public repository
6126+
* * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
61276127
* * `repo` scope to create a private repository
61286128
*/
61296129
createUsingTemplate: {
@@ -7224,7 +7224,7 @@ export type RestEndpointMethods = {
72247224
endpoint: EndpointInterface<{ url: string }>;
72257225
};
72267226
/**
7227-
* Lists public repositories for the specified user.
7227+
* Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.
72287228
*/
72297229
listForUser: {
72307230
(
@@ -7288,7 +7288,9 @@ export type RestEndpointMethods = {
72887288
/**
72897289
* Lists all public repositories in the order that they were created.
72907290
*
7291-
* 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.
7291+
* Notes:
7292+
* - For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.
7293+
* - 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.
72927294
*/
72937295
listPublic: {
72947296
(

0 commit comments

Comments
 (0)