Skip to content

Commit d5d2c08

Browse files
fix(typescript): pagination parameters for octokit.issues.listCommentsForRepo() (#41)
1 parent 31a58de commit d5d2c08

File tree

8 files changed

+63
-19
lines changed

8 files changed

+63
-19
lines changed

docs/issues/listCommentsForRepo.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,16 @@ Either `asc` or `desc`. Ignored without the `sort` parameter.
4444

4545
Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
4646

47+
</td></tr>
48+
<tr><td>per_page</td><td>no</td><td>
49+
50+
Results per page (max 100)
51+
52+
</td></tr>
53+
<tr><td>page</td><td>no</td><td>
54+
55+
Page number of the results to fetch.
56+
4757
</td></tr>
4858
</tbody>
4959
</table>

docs/orgs/update.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Edit an organization
22

3-
**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).
3+
**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).
44

55
Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.
66

@@ -86,7 +86,7 @@ Default: `true`
8686
</td></tr>
8787
<tr><td>members_can_create_internal_repositories</td><td>no</td><td>
8888

89-
Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud. Can be one of:
89+
Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of:
9090
\* `true` - all organization members can create internal repositories.
9191
\* `false` - only organization owners can create internal repositories.
9292
Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation.

docs/repos/createForAuthenticatedUser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Either `true` to create a private repository or `false` to create a public one.
4848
</td></tr>
4949
<tr><td>visibility</td><td>no</td><td>
5050

51-
Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)" in the GitHub Help documentation.
51+
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.
5252
The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.
5353

5454
</td></tr>

docs/repos/createInOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Either `true` to create a private repository or `false` to create a public one.
5454
</td></tr>
5555
<tr><td>visibility</td><td>no</td><td>
5656

57-
Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)" in the GitHub Help documentation.
57+
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.
5858
The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.
5959

6060
</td></tr>

docs/repos/listForOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ org parameter
2626
</td></tr>
2727
<tr><td>type</td><td>no</td><td>
2828

29-
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, `type` can also be `internal`.
29+
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`.
3030

3131
</td></tr>
3232
<tr><td>sort</td><td>no</td><td>

docs/repos/update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Either `true` to make the repository private or `false` to make it public. Creat
5353
</td></tr>
5454
<tr><td>visibility</td><td>no</td><td>
5555

56-
Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.
56+
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`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.
5757

5858
</td></tr>
5959
<tr><td>has_issues</td><td>no</td><td>

scripts/update-endpoints/generated/endpoints.json

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3168,7 +3168,7 @@
31683168
"url": "/orgs/{org}",
31693169
"isDeprecated": false,
31703170
"isLegacy": false,
3171-
"description": "\n\n**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.",
3171+
"description": "\n\n**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.",
31723172
"documentationUrl": "https://developer.github.com/v3/orgs/#edit-an-organization",
31733173
"previews": [],
31743174
"headers": [],
@@ -3318,7 +3318,7 @@
33183318
},
33193319
{
33203320
"name": "members_can_create_internal_repositories",
3321-
"description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.",
3321+
"description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.",
33223322
"in": "BODY",
33233323
"type": "boolean",
33243324
"required": false,
@@ -6112,7 +6112,7 @@
61126112
},
61136113
{
61146114
"name": "type",
6115-
"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, `type` can also be `internal`.",
6115+
"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`.",
61166116
"in": "QUERY",
61176117
"type": "string",
61186118
"required": false,
@@ -6277,7 +6277,7 @@
62776277
},
62786278
{
62796279
"name": "visibility",
6280-
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
6280+
"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.",
62816281
"in": "BODY",
62826282
"type": "string",
62836283
"required": false,
@@ -10584,7 +10584,7 @@
1058410584
},
1058510585
{
1058610586
"name": "visibility",
10587-
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.",
10587+
"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`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.",
1058810588
"in": "BODY",
1058910589
"type": "string",
1059010590
"required": false,
@@ -24424,6 +24424,32 @@
2442424424
"validation": null,
2442524425
"alias": null,
2442624426
"deprecated": null
24427+
},
24428+
{
24429+
"name": "per_page",
24430+
"description": "Results per page (max 100)",
24431+
"in": "QUERY",
24432+
"type": "integer",
24433+
"required": false,
24434+
"enum": null,
24435+
"allowNull": false,
24436+
"mapToData": null,
24437+
"validation": null,
24438+
"alias": null,
24439+
"deprecated": null
24440+
},
24441+
{
24442+
"name": "page",
24443+
"description": "Page number of the results to fetch.",
24444+
"in": "QUERY",
24445+
"type": "integer",
24446+
"required": false,
24447+
"enum": null,
24448+
"allowNull": false,
24449+
"mapToData": null,
24450+
"validation": null,
24451+
"alias": null,
24452+
"deprecated": null
2442724453
}
2442824454
],
2442924455
"responses": [
@@ -37375,7 +37401,7 @@
3737537401
},
3737637402
{
3737737403
"name": "visibility",
37378-
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
37404+
"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.",
3737937405
"in": "BODY",
3738037406
"type": "string",
3738137407
"required": false,

0 commit comments

Comments
 (0)