Skip to content

Commit e683fc0

Browse files
authored
fix: update in-code documentation and generated Markdown documentation (see PR body for details) (#553)
WIP octokit/openapi updated
1 parent 3faa578 commit e683fc0

File tree

5 files changed

+27
-5
lines changed

5 files changed

+27
-5
lines changed

docs/repos/createOrUpdateFileContents.md

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

99
# Create or update file contents
1010

11-
Creates a new file or replaces an existing file in a repository.
11+
Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.
1212

1313
```js
1414
octokit.rest.repos.createOrUpdateFileContents({

docs/repos/listCollaborators.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ The name of the repository. The name is not case sensitive.
4949

5050
Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see.
5151

52+
</td></tr>
53+
<tr><td>permission</td><td>no</td><td>
54+
55+
Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.
56+
5257
</td></tr>
5358
<tr><td>per_page</td><td>no</td><td>
5459

docs/repos/listWebhooks.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ type: API method
88

99
# List repository webhooks
1010

11+
Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
12+
1113
```js
1214
octokit.rest.repos.listWebhooks({
1315
owner,

scripts/update-endpoints/generated/endpoints.json

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44713,7 +44713,7 @@
4471344713
"isDeprecated": false,
4471444714
"deprecationDate": null,
4471544715
"removalDate": null,
44716-
"description": "Creates a new file or replaces an existing file in a repository.",
44716+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
4471744717
"documentationUrl": "https://docs.github.com/rest/reference/repos#create-or-update-file-contents",
4471844718
"previews": [],
4471944719
"headers": [],
@@ -51192,6 +51192,19 @@
5119251192
"alias": null,
5119351193
"deprecated": null
5119451194
},
51195+
{
51196+
"name": "permission",
51197+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
51198+
"in": "QUERY",
51199+
"type": "string",
51200+
"required": false,
51201+
"enum": ["pull", "triage", "push", "maintain", "admin"],
51202+
"allowNull": false,
51203+
"mapToData": null,
51204+
"validation": null,
51205+
"alias": null,
51206+
"deprecated": null
51207+
},
5119551208
{
5119651209
"name": "per_page",
5119751210
"description": "The number of results per page (max 100).",
@@ -53516,7 +53529,7 @@
5351653529
"isDeprecated": false,
5351753530
"deprecationDate": null,
5351853531
"removalDate": null,
53519-
"description": "",
53532+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
5352053533
"documentationUrl": "https://docs.github.com/rest/webhooks/repos#list-repository-webhooks",
5352153534
"previews": [],
5352253535
"headers": [],

src/generated/method-types.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8292,7 +8292,7 @@ export type RestEndpointMethods = {
82928292
endpoint: EndpointInterface<{ url: string }>;
82938293
};
82948294
/**
8295-
* Creates a new file or replaces an existing file in a repository.
8295+
* Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.
82968296
*/
82978297
createOrUpdateFileContents: {
82988298
(
@@ -9805,7 +9805,9 @@ export type RestEndpointMethods = {
98059805
defaults: RequestInterface["defaults"];
98069806
endpoint: EndpointInterface<{ url: string }>;
98079807
};
9808-
9808+
/**
9809+
* Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
9810+
*/
98099811
listWebhooks: {
98109812
(
98119813
params?: RestEndpointMethodTypes["repos"]["listWebhooks"]["parameters"]

0 commit comments

Comments
 (0)