Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: new octokit.rest.apps.permissions.organization_custom_properties(), octokit.rest.codespaces.deleteFromOrganization(), octokit.rest.codespaces.getCodespacesForUserInOrg(), octokit.rest.codespaces.listInOrganization(), octokit.rest.codespaces.stopInOrganization() auth, octokit.rest.orgs.listCustomPropertiesValuesForRepos(), octokit.rest.repos.createInOrg() description, octokit.rest.secretScanning.listAlertsForEnterprise.validity, octokit.rest.secretScanning.listAlertsForOrg.validity, octokit.rest.secretScanning.listAlertsForRepo.validity parameter #697

Merged
merged 1 commit into from
Nov 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/apps/createInstallationAccessToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,11 @@ The level of permission to grant the access token to manage access to an organiz

The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.

</td></tr>
<tr><td>permissions.organization_custom_properties</td><td>no</td><td>

The level of permission to grant the access token for custom property management.

</td></tr>
<tr><td>permissions.organization_announcement_banners</td><td>no</td><td>

Expand Down
5 changes: 5 additions & 0 deletions docs/apps/scopeToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,11 @@ The level of permission to grant the access token to manage access to an organiz

The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.

</td></tr>
<tr><td>permissions.organization_custom_properties</td><td>no</td><td>

The level of permission to grant the access token for custom property management.

</td></tr>
<tr><td>permissions.organization_announcement_banners</td><td>no</td><td>

Expand Down
5 changes: 4 additions & 1 deletion docs/codespaces/deleteFromOrganization.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ type: API method

Deletes a user's codespace.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
To use this endpoint you must authenticate using one of the following methods:

- An access token with the `admin:org` scope
- An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces`

```js
octokit.rest.codespaces.deleteFromOrganization({
Expand Down
2 changes: 1 addition & 1 deletion docs/codespaces/getCodespacesForUserInOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type: API method

Lists the codespaces that a member of an organization has for repositories in that organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint.

```js
octokit.rest.codespaces.getCodespacesForUserInOrg({
Expand Down
2 changes: 1 addition & 1 deletion docs/codespaces/listInOrganization.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type: API method

Lists the codespaces associated to a specified organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint.

```js
octokit.rest.codespaces.listInOrganization({
Expand Down
5 changes: 4 additions & 1 deletion docs/codespaces/stopInOrganization.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ type: API method

Stops a user's codespace.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
To use this endpoint you must authenticate using one of the following methods:

- An access token with the `admin:org` scope
- An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces`

```js
octokit.rest.codespaces.stopInOrganization({
Expand Down
2 changes: 1 addition & 1 deletion docs/orgs/createOrUpdateCustomProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ Ordered list of allowed values of the property
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#create-or-update-custom-properties-for-an-organization).
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization).
2 changes: 1 addition & 1 deletion docs/orgs/createOrUpdateCustomPropertiesValuesForRepos.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ The value assigned to the property
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#create-or-update-custom-property-values-for-organization-repositories).
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories).
2 changes: 1 addition & 1 deletion docs/orgs/createOrUpdateCustomProperty.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ Ordered list of allowed values of the property
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#create-or-update-a-custom-property-for-an-organization).
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization).
2 changes: 1 addition & 1 deletion docs/orgs/getAllCustomProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ The organization name. The name is not case sensitive.
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#get-all-custom-properties-for-an-organization).
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization).
2 changes: 1 addition & 1 deletion docs/orgs/getCustomProperty.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ The custom property name. The name is case sensitive.
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#get-a-custom-property-for-an-organization).
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization).
7 changes: 6 additions & 1 deletion docs/orgs/listCustomPropertiesValuesForRepos.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,13 @@ The number of results per page (max 100).

Page number of the results to fetch.

</td></tr>
<tr><td>repository_query</td><td>no</td><td>

Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#list-custom-property-values-for-organization-repositories).
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories).
2 changes: 1 addition & 1 deletion docs/orgs/removeCustomProperty.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ The custom property name. The name is case sensitive.
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#remove-a-custom-property-for-an-organization).
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization).
8 changes: 8 additions & 0 deletions docs/repos/createInOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,14 @@ The default value for a merge commit message.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message.

</td></tr>
<tr><td>custom_properties</td><td>no</td><td>

The custom properties for the new respository. The keys are the custom property names, and the values are the corresponding custom property values.

</td></tr>
<tr><td>custom_properties.*</td><td>no</td><td>

</td></tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/repos/getCustomPropertiesValues.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ The name of the repository without the `.git` extension. The name is not case se
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/properties#get-all-custom-property-values-for-a-repository).
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository).
5 changes: 5 additions & 0 deletions docs/secretScanning/listAlertsForEnterprise.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ A cursor, as given in the [Link header](https://docs.github.com/rest/guides/usin

A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.

</td></tr>
<tr><td>validity</td><td>no</td><td>

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.

</td></tr>
</tbody>
</table>
Expand Down
5 changes: 5 additions & 0 deletions docs/secretScanning/listAlertsForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,11 @@ A cursor, as given in the [Link header](https://docs.github.com/rest/guides/usin

A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string.

</td></tr>
<tr><td>validity</td><td>no</td><td>

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.

</td></tr>
</tbody>
</table>
Expand Down
5 changes: 5 additions & 0 deletions docs/secretScanning/listAlertsForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ A cursor, as given in the [Link header](https://docs.github.com/rest/guides/usin

A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string.

</td></tr>
<tr><td>validity</td><td>no</td><td>

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.

</td></tr>
</tbody>
</table>
Expand Down
Loading