Skip to content

Commit 533f516

Browse files
fix(TypeScript): description updates (#66)
Co-authored-by: Octokit Bot <33075676+octokitbot@users.noreply.github.com>
1 parent fd14e50 commit 533f516

File tree

6 files changed

+10
-14
lines changed

6 files changed

+10
-14
lines changed

docs/repos/createForAuthenticatedUser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ A URL with more information about the repository.
4343
</td></tr>
4444
<tr><td>private</td><td>no</td><td>
4545

46-
Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.
46+
Either `true` to create a private repository or `false` to create a public one.
4747

4848
</td></tr>
4949
<tr><td>visibility</td><td>no</td><td>

docs/repos/createInOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ A URL with more information about the repository.
4949
</td></tr>
5050
<tr><td>private</td><td>no</td><td>
5151

52-
Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.
52+
Either `true` to create a private repository or `false` to create a public one.
5353

5454
</td></tr>
5555
<tr><td>visibility</td><td>no</td><td>

docs/repos/createUsingTemplate.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ When using [OAuth](https://developer.github.com/apps/building-oauth-apps/underst
99
- `public_repo` scope or `repo` scope to create a public repository
1010
- `repo` scope to create a private repository
1111

12-
\`
13-
1412
```js
1513
octokit.repos.createUsingTemplate({
1614
template_owner,

docs/repos/update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ A URL with more information about the repository.
4747
</td></tr>
4848
<tr><td>private</td><td>no</td><td>
4949

50-
Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`.
50+
Either `true` to make the repository private or `false` to make it public. Default: `false`.
5151
**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.
5252

5353
</td></tr>

scripts/update-endpoints/generated/endpoints.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8012,7 +8012,7 @@
80128012
},
80138013
{
80148014
"name": "private",
8015-
"description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.",
8015+
"description": "Either `true` to create a private repository or `false` to create a public one.",
80168016
"in": "BODY",
80178017
"type": "boolean",
80188018
"required": false,
@@ -12526,7 +12526,7 @@
1252612526
},
1252712527
{
1252812528
"name": "private",
12529-
"description": "Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.",
12529+
"description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.",
1253012530
"in": "BODY",
1253112531
"type": "boolean",
1253212532
"required": false,
@@ -37263,7 +37263,7 @@
3726337263
"url": "/repos/{template_owner}/{template_repo}/generate",
3726437264
"isDeprecated": false,
3726537265
"isLegacy": false,
37266-
"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://developer.github.com/v3/repos/#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.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\n\n\\`",
37266+
"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://developer.github.com/v3/repos/#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.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",
3726737267
"documentationUrl": "https://developer.github.com/v3/repos/#create-a-repository-using-a-template",
3726837268
"previews": [{ "name": "baptiste" }],
3726937269
"headers": [
@@ -42851,7 +42851,7 @@
4285142851
},
4285242852
{
4285342853
"name": "private",
42854-
"description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.",
42854+
"description": "Either `true` to create a private repository or `false` to create a public one.",
4285542855
"in": "BODY",
4285642856
"type": "boolean",
4285742857
"required": false,

src/generated/types.ts

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25737,7 +25737,7 @@ export type ReposCreateForAuthenticatedUserParams = {
2573725737
*/
2573825738
name: string;
2573925739
/**
25740-
* Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.
25740+
* Either `true` to create a private repository or `false` to create a public one.
2574125741
*/
2574225742
private?: boolean;
2574325743
/**
@@ -25837,7 +25837,7 @@ export type ReposCreateInOrgParams = {
2583725837
name: string;
2583825838
org: string;
2583925839
/**
25840-
* Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.
25840+
* Either `true` to create a private repository or `false` to create a public one.
2584125841
*/
2584225842
private?: boolean;
2584325843
/**
@@ -26915,7 +26915,7 @@ export type ReposUpdateParams = {
2691526915
name?: string;
2691626916
owner: string;
2691726917
/**
26918-
* Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`.
26918+
* Either `true` to make the repository private or `false` to make it public. Default: `false`.
2691926919
* **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.
2692026920
*/
2692126921
private?: boolean;
@@ -32701,8 +32701,6 @@ export type RestEndpointMethods = {
3270132701
*
3270232702
* * `public_repo` scope or `repo` scope to create a public repository
3270332703
* * `repo` scope to create a private repository
32704-
*
32705-
* \`
3270632704
*/
3270732705
createUsingTemplate: {
3270832706
(params?: RequestParameters & ReposCreateUsingTemplateParams): Promise<

0 commit comments

Comments
 (0)