feat: new octokit.rest.apps.permissions.organization_custom_propertie…

…s(), 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)
octokit · Nov 28, 2023 · 56bab3e · 56bab3e
1 parent 7355fcf
commit 56bab3e
Show file tree

Hide file tree

Showing 20 changed files with 194 additions and 40 deletions.
diff --git a/docs/apps/createInstallationAccessToken.md b/docs/apps/createInstallationAccessToken.md
@@ -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>
 

diff --git a/docs/apps/scopeToken.md b/docs/apps/scopeToken.md
@@ -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>
 

diff --git a/docs/codespaces/deleteFromOrganization.md b/docs/codespaces/deleteFromOrganization.md
@@ -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({

diff --git a/docs/codespaces/getCodespacesForUserInOrg.md b/docs/codespaces/getCodespacesForUserInOrg.md
@@ -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({

diff --git a/docs/codespaces/listInOrganization.md b/docs/codespaces/listInOrganization.md
@@ -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({

diff --git a/docs/codespaces/stopInOrganization.md b/docs/codespaces/stopInOrganization.md
@@ -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({

diff --git a/docs/orgs/createOrUpdateCustomProperties.md b/docs/orgs/createOrUpdateCustomProperties.md
@@ -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).
diff --git a/docs/orgs/createOrUpdateCustomPropertiesValuesForRepos.md b/docs/orgs/createOrUpdateCustomPropertiesValuesForRepos.md
@@ -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).
diff --git a/docs/orgs/createOrUpdateCustomProperty.md b/docs/orgs/createOrUpdateCustomProperty.md
@@ -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).
diff --git a/docs/orgs/getAllCustomProperties.md b/docs/orgs/getAllCustomProperties.md
@@ -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).
diff --git a/docs/orgs/getCustomProperty.md b/docs/orgs/getCustomProperty.md
@@ -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).
diff --git a/docs/orgs/listCustomPropertiesValuesForRepos.md b/docs/orgs/listCustomPropertiesValuesForRepos.md
@@ -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).
diff --git a/docs/orgs/removeCustomProperty.md b/docs/orgs/removeCustomProperty.md
@@ -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).
diff --git a/docs/repos/createInOrg.md b/docs/repos/createInOrg.md
@@ -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>

diff --git a/docs/repos/getCustomPropertiesValues.md b/docs/repos/getCustomPropertiesValues.md
@@ -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).
diff --git a/docs/secretScanning/listAlertsForEnterprise.md b/docs/secretScanning/listAlertsForEnterprise.md
@@ -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>

diff --git a/docs/secretScanning/listAlertsForOrg.md b/docs/secretScanning/listAlertsForOrg.md
@@ -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>

diff --git a/docs/secretScanning/listAlertsForRepo.md b/docs/secretScanning/listAlertsForRepo.md
@@ -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>