Skip to content

Commit

Permalink
fix: update in-code documentation and generated Markdown documentatio…
Browse files Browse the repository at this point in the history
…n (see PR body for details) (#553)

WIP octokit/openapi updated
  • Loading branch information
octokitbot committed Sep 13, 2022
1 parent 3faa578 commit e683fc0
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/repos/createOrUpdateFileContents.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: API method

# Create or update file contents

Creates a new file or replaces an existing file in a repository.
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.

```js
octokit.rest.repos.createOrUpdateFileContents({
Expand Down
5 changes: 5 additions & 0 deletions docs/repos/listCollaborators.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ The name of the repository. The name is not case sensitive.

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.

</td></tr>
<tr><td>permission</td><td>no</td><td>

Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.

</td></tr>
<tr><td>per_page</td><td>no</td><td>

Expand Down
2 changes: 2 additions & 0 deletions docs/repos/listWebhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ type: API method

# List repository webhooks

Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.

```js
octokit.rest.repos.listWebhooks({
owner,
Expand Down
17 changes: 15 additions & 2 deletions scripts/update-endpoints/generated/endpoints.json
Original file line number Diff line number Diff line change
Expand Up @@ -44713,7 +44713,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
"description": "Creates a new file or replaces an existing file in a repository.",
"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.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#create-or-update-file-contents",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -51192,6 +51192,19 @@
"alias": null,
"deprecated": null
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "QUERY",
"type": "string",
"required": false,
"enum": ["pull", "triage", "push", "maintain", "admin"],
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "per_page",
"description": "The number of results per page (max 100).",
Expand Down Expand Up @@ -53516,7 +53529,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"documentationUrl": "https://docs.github.com/rest/webhooks/repos#list-repository-webhooks",
"previews": [],
"headers": [],
Expand Down
6 changes: 4 additions & 2 deletions src/generated/method-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8292,7 +8292,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
* Creates a new file or replaces an existing file in a repository.
* 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.
*/
createOrUpdateFileContents: {
(
Expand Down Expand Up @@ -9805,7 +9805,9 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};

/**
* Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
*/
listWebhooks: {
(
params?: RestEndpointMethodTypes["repos"]["listWebhooks"]["parameters"]
Expand Down

0 comments on commit e683fc0

Please sign in to comment.