From c95e2d793d830b8230e36ef84ee937a6e8a47cf4 Mon Sep 17 00:00:00 2001 From: Octokit Bot <33075676+octokitbot@users.noreply.github.com> Date: Tue, 18 Mar 2025 23:13:50 +0000 Subject: [PATCH 1/2] WIP octokit/openapi updated --- docs/apps/createInstallationAccessToken.md | 2 +- docs/apps/scopeToken.md | 2 +- docs/codespaces/createOrUpdateRepoSecret.md | 2 +- docs/codespaces/deleteRepoSecret.md | 2 +- docs/issues/create.md | 5 + docs/issues/listForOrg.md | 5 + docs/issues/listForRepo.md | 5 + docs/issues/update.md | 5 + docs/orgs/createIssueType.md | 67 +++ docs/orgs/createOrUpdateCustomProperties.md | 4 + docs/orgs/createOrUpdateCustomProperty.md | 5 + docs/orgs/deleteIssueType.md | 46 ++ docs/orgs/listIssueTypes.md | 38 ++ docs/orgs/listPatGrantRequests.md | 5 + docs/orgs/listPatGrants.md | 5 + docs/orgs/updateIssueType.md | 73 +++ docs/repos/createDeploymentProtectionRule.md | 2 +- docs/search/issuesAndPullRequests.md | 1 + .../update-endpoints/generated/endpoints.json | 454 +++++++++++++++++- src/generated/endpoints.ts | 4 + src/generated/method-types.ts | 63 ++- .../parameters-and-response-types.ts | 20 + 22 files changed, 800 insertions(+), 15 deletions(-) create mode 100644 docs/orgs/createIssueType.md create mode 100644 docs/orgs/deleteIssueType.md create mode 100644 docs/orgs/listIssueTypes.md create mode 100644 docs/orgs/updateIssueType.md diff --git a/docs/apps/createInstallationAccessToken.md b/docs/apps/createInstallationAccessToken.md index 0a8083eba..94fe24d77 100644 --- a/docs/apps/createInstallationAccessToken.md +++ b/docs/apps/createInstallationAccessToken.md @@ -80,7 +80,7 @@ The level of permission to grant the access token for repository contents, commi permissions.dependabot_secretsno -The leve of permission to grant the access token to manage Dependabot secrets. +The level of permission to grant the access token to manage Dependabot secrets. permissions.deploymentsno diff --git a/docs/apps/scopeToken.md b/docs/apps/scopeToken.md index 9355744d8..4036caeea 100644 --- a/docs/apps/scopeToken.md +++ b/docs/apps/scopeToken.md @@ -94,7 +94,7 @@ The level of permission to grant the access token for repository contents, commi permissions.dependabot_secretsno -The leve of permission to grant the access token to manage Dependabot secrets. +The level of permission to grant the access token to manage Dependabot secrets. permissions.deploymentsno diff --git a/docs/codespaces/createOrUpdateRepoSecret.md b/docs/codespaces/createOrUpdateRepoSecret.md index 565fa0693..eaa56b43c 100644 --- a/docs/codespaces/createOrUpdateRepoSecret.md +++ b/docs/codespaces/createOrUpdateRepoSecret.md @@ -11,7 +11,7 @@ type: API method Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." -OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. ```js octokit.rest.codespaces.createOrUpdateRepoSecret({ diff --git a/docs/codespaces/deleteRepoSecret.md b/docs/codespaces/deleteRepoSecret.md index e9fb151d6..a4419183d 100644 --- a/docs/codespaces/deleteRepoSecret.md +++ b/docs/codespaces/deleteRepoSecret.md @@ -10,7 +10,7 @@ type: API method Deletes a development environment secret in a repository using the secret name. -OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. ```js octokit.rest.codespaces.deleteRepoSecret({ diff --git a/docs/issues/create.md b/docs/issues/create.md index 30bc93c12..cdc9bf8d6 100644 --- a/docs/issues/create.md +++ b/docs/issues/create.md @@ -76,6 +76,11 @@ Labels to associate with this issue. _NOTE: Only users with push access can set Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + +typeno + +The name of the issue type to associate with this issue. + diff --git a/docs/issues/listForOrg.md b/docs/issues/listForOrg.md index e3610097b..c288c72b7 100644 --- a/docs/issues/listForOrg.md +++ b/docs/issues/listForOrg.md @@ -56,6 +56,11 @@ Indicates the state of the issues to return. A list of comma separated label names. Example: `bug,ui,@high` + +typeno + +Can be the name of an issue type. + sortno diff --git a/docs/issues/listForRepo.md b/docs/issues/listForRepo.md index 11e389690..00dcb9864 100644 --- a/docs/issues/listForRepo.md +++ b/docs/issues/listForRepo.md @@ -62,6 +62,11 @@ Indicates the state of the issues to return. Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. + +typeno + +Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned. + creatorno diff --git a/docs/issues/update.md b/docs/issues/update.md index 1940076b7..b90366bcc 100644 --- a/docs/issues/update.md +++ b/docs/issues/update.md @@ -88,6 +88,11 @@ Labels to associate with this issue. Pass one or more labels to _replace_ the se Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. + +typeno + +The name of the issue type to associate with this issue or use `null` to remove the current issue type. + diff --git a/docs/orgs/createIssueType.md b/docs/orgs/createIssueType.md new file mode 100644 index 000000000..3921700fc --- /dev/null +++ b/docs/orgs/createIssueType.md @@ -0,0 +1,67 @@ +--- +name: Create issue type for an organization +example: octokit.rest.orgs.createIssueType({ org, name, is_enabled }) +route: POST /orgs/{org}/issue-types +scope: orgs +type: API method +--- + +# Create issue type for an organization + +Create a new issue type for an organization. + +You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + +```js +octokit.rest.orgs.createIssueType({ + org, + name, + is_enabled, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
nameyes + +Name of the issue type. + +
is_enabledyes + +Whether or not the issue type is enabled at the organization level. + +
is_privateno + +Whether or not the issue type is restricted to issues in private repositories. + +
descriptionno + +Description of the issue type. + +
colorno + +Color for the issue type. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization). diff --git a/docs/orgs/createOrUpdateCustomProperties.md b/docs/orgs/createOrUpdateCustomProperties.md index ecc23038d..e91c59a40 100644 --- a/docs/orgs/createOrUpdateCustomProperties.md +++ b/docs/orgs/createOrUpdateCustomProperties.md @@ -10,6 +10,10 @@ type: API method Creates new or updates existing custom properties defined for an organization in a batch. +If the property already exists, the existing property will be replaced with the new values. +Missing optional values will fall back to default values, previous values will be overwritten. +E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + To use this endpoint, the authenticated user must be one of: - An administrator for the organization. diff --git a/docs/orgs/createOrUpdateCustomProperty.md b/docs/orgs/createOrUpdateCustomProperty.md index 2d5babfe5..f904d4f0e 100644 --- a/docs/orgs/createOrUpdateCustomProperty.md +++ b/docs/orgs/createOrUpdateCustomProperty.md @@ -69,6 +69,11 @@ Short description of the property An ordered list of the allowed values of the property. The property can have up to 200 allowed values. + +values_editable_byno + +Who can edit the values of the property + diff --git a/docs/orgs/deleteIssueType.md b/docs/orgs/deleteIssueType.md new file mode 100644 index 000000000..d6d77a487 --- /dev/null +++ b/docs/orgs/deleteIssueType.md @@ -0,0 +1,46 @@ +--- +name: Delete issue type for an organization +example: octokit.rest.orgs.deleteIssueType({ org, issue_type_id }) +route: DELETE /orgs/{org}/issue-types/{issue_type_id} +scope: orgs +type: API method +--- + +# Delete issue type for an organization + +Deletes an issue type for an organization. + +You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + +```js +octokit.rest.orgs.deleteIssueType({ + org, + issue_type_id, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
issue_type_idyes + +The unique identifier of the issue type. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization). diff --git a/docs/orgs/listIssueTypes.md b/docs/orgs/listIssueTypes.md new file mode 100644 index 000000000..199eff9b8 --- /dev/null +++ b/docs/orgs/listIssueTypes.md @@ -0,0 +1,38 @@ +--- +name: List issue types for an organization +example: octokit.rest.orgs.listIssueTypes({ org }) +route: GET /orgs/{org}/issue-types +scope: orgs +type: API method +--- + +# List issue types for an organization + +Lists all issue types for an organization. + +```js +octokit.rest.orgs.listIssueTypes({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization). diff --git a/docs/orgs/listPatGrantRequests.md b/docs/orgs/listPatGrantRequests.md index 04d56df9b..12c7885ca 100644 --- a/docs/orgs/listPatGrantRequests.md +++ b/docs/orgs/listPatGrantRequests.md @@ -78,6 +78,11 @@ Only show fine-grained personal access tokens used before the given time. This i Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + +token_idno + +The ID of the token + diff --git a/docs/orgs/listPatGrants.md b/docs/orgs/listPatGrants.md index 7ba13ba7e..554c8fb53 100644 --- a/docs/orgs/listPatGrants.md +++ b/docs/orgs/listPatGrants.md @@ -78,6 +78,11 @@ Only show fine-grained personal access tokens used before the given time. This i Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + +token_idno + +The ID of the token + diff --git a/docs/orgs/updateIssueType.md b/docs/orgs/updateIssueType.md new file mode 100644 index 000000000..e7b8e3879 --- /dev/null +++ b/docs/orgs/updateIssueType.md @@ -0,0 +1,73 @@ +--- +name: Update issue type for an organization +example: octokit.rest.orgs.updateIssueType({ org, issue_type_id, name, is_enabled }) +route: PUT /orgs/{org}/issue-types/{issue_type_id} +scope: orgs +type: API method +--- + +# Update issue type for an organization + +Updates an issue type for an organization. + +You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + +```js +octokit.rest.orgs.updateIssueType({ + org, + issue_type_id, + name, + is_enabled, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
issue_type_idyes + +The unique identifier of the issue type. + +
nameyes + +Name of the issue type. + +
is_enabledyes + +Whether or not the issue type is enabled at the organization level. + +
is_privateno + +Whether or not the issue type is restricted to issues in private repositories. + +
descriptionno + +Description of the issue type. + +
colorno + +Color for the issue type. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization). diff --git a/docs/repos/createDeploymentProtectionRule.md b/docs/repos/createDeploymentProtectionRule.md index 0eec78c65..bbcad604d 100644 --- a/docs/repos/createDeploymentProtectionRule.md +++ b/docs/repos/createDeploymentProtectionRule.md @@ -12,7 +12,7 @@ Enable a custom deployment protection rule for an environment. The authenticated user must have admin or owner permissions to the repository to use this endpoint. -For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). +For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. diff --git a/docs/search/issuesAndPullRequests.md b/docs/search/issuesAndPullRequests.md index ab5730db5..705cd4f13 100644 --- a/docs/search/issuesAndPullRequests.md +++ b/docs/search/issuesAndPullRequests.md @@ -11,6 +11,7 @@ type: API method **This method is deprecated.** > [!WARNING] > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. +> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/). ```js octokit.rest.search.issuesAndPullRequests({ diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 6404c1fa6..075e196be 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -12183,7 +12183,7 @@ }, { "name": "permissions.dependabot_secrets", - "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", "in": "BODY", "type": "string", "required": false, @@ -14572,7 +14572,7 @@ }, { "name": "permissions.dependabot_secrets", - "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", "in": "BODY", "type": "string", "required": false, @@ -23104,7 +23104,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.", "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret", "previews": [], "headers": [], @@ -23943,7 +23943,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a development environment secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Deletes a development environment secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.", "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret", "previews": [], "headers": [], @@ -33652,6 +33652,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "type", + "description": "The name of the issue type to associate with this issue.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -35496,6 +35509,19 @@ "alias": null, "deprecated": null }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "sort", "description": "What to sort results by.", @@ -35655,6 +35681,19 @@ "alias": null, "deprecated": null }, + { + "name": "type", + "description": "Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "creator", "description": "The user that created the issue.", @@ -37085,6 +37124,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "type", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -40342,6 +40394,127 @@ ], "renamed": null }, + { + "name": "Create issue type for an organization", + "scope": "orgs", + "id": "createIssueType", + "method": "POST", + "url": "/orgs/{org}/issue-types", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "documentationUrl": "https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name", + "description": "Name of the issue type.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "is_enabled", + "description": "Whether or not the issue type is enabled at the organization level.", + "in": "BODY", + "type": "boolean", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "is_private", + "description": "Whether or not the issue type is restricted to issues in private repositories.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "Description of the issue type.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "color", + "description": "Color for the issue type.", + "in": "BODY", + "type": "string", + "required": false, + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":410,\"node_id\":\"IT_kwDNAd3NAZo\",\"name\":\"Task\",\"description\":\"A specific piece of work\",\"created_at\":\"2024-12-11T14:39:09Z\",\"updated_at\":\"2024-12-11T14:39:09Z\"}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, { "name": "Create or update custom properties for an organization", "scope": "orgs", @@ -40351,7 +40524,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", "documentationUrl": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization", "previews": [], "headers": [], @@ -40715,6 +40888,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "values_editable_by", + "description": "Who can edit the values of the property", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["org_actors", "org_and_repo_actors"], + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -40948,6 +41134,58 @@ ], "renamed": null }, + { + "name": "Delete issue type for an organization", + "scope": "orgs", + "id": "deleteIssueType", + "method": "DELETE", + "url": "/orgs/{org}/issue-types/{issue_type_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "documentationUrl": "https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, { "name": "Delete an organization webhook", "scope": "orgs", @@ -42368,6 +42606,48 @@ ], "renamed": null }, + { + "name": "List issue types for an organization", + "scope": "orgs", + "id": "listIssueTypes", + "method": "GET", + "url": "/orgs/{org}/issue-types", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all issue types for an organization.", + "documentationUrl": "https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":410,\"node_id\":\"IT_kwDNAd3NAZo\",\"name\":\"Task\",\"description\":\"A specific piece of work\",\"created_at\":\"2024-12-11T14:39:09Z\",\"updated_at\":\"2024-12-11T14:39:09Z\"},{\"id\":411,\"node_id\":\"IT_kwDNAd3NAZs\",\"name\":\"Bug\",\"description\":\"An unexpected problem or behavior\",\"created_at\":\"2024-12-11T14:39:09Z\",\"updated_at\":\"2024-12-11T14:39:09Z\"}]" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "List organization members", "scope": "orgs", @@ -43208,6 +43488,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "token_id", + "description": "The ID of the token", + "in": "QUERY", + "type": "array", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -43374,6 +43667,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "token_id", + "description": "The ID of the token", + "in": "QUERY", + "type": "array", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -45134,6 +45440,140 @@ ], "renamed": null }, + { + "name": "Update issue type for an organization", + "scope": "orgs", + "id": "updateIssueType", + "method": "PUT", + "url": "/orgs/{org}/issue-types/{issue_type_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "documentationUrl": "https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name", + "description": "Name of the issue type.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "is_enabled", + "description": "Whether or not the issue type is enabled at the organization level.", + "in": "BODY", + "type": "boolean", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "is_private", + "description": "Whether or not the issue type is restricted to issues in private repositories.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "Description of the issue type.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "color", + "description": "Color for the issue type.", + "in": "BODY", + "type": "string", + "required": false, + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":410,\"node_id\":\"IT_kwDNAd3NAZo\",\"name\":\"Task\",\"description\":\"A specific piece of work\",\"created_at\":\"2024-12-11T14:39:09Z\",\"updated_at\":\"2024-12-11T14:39:09Z\"}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, { "name": "Update an organization membership for the authenticated user", "scope": "orgs", @@ -57498,7 +57938,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment", "previews": [], "headers": [], @@ -76942,7 +77382,7 @@ "isDeprecated": true, "deprecationDate": "2025-03-04", "removalDate": "2025-09-04", - "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).", "documentationUrl": "https://docs.github.com/rest/search/search#search-issues-and-pull-requests", "previews": [], "headers": [], diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index bfb7328e3..2d7053db5 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -1069,6 +1069,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "PUT /orgs/{org}/outside_collaborators/{username}", ], createInvitation: ["POST /orgs/{org}/invitations"], + createIssueType: ["POST /orgs/{org}/issue-types"], createOrUpdateCustomProperties: ["PATCH /orgs/{org}/properties/schema"], createOrUpdateCustomPropertiesValuesForRepos: [ "PATCH /orgs/{org}/properties/values", @@ -1078,6 +1079,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], createWebhook: ["POST /orgs/{org}/hooks"], delete: ["DELETE /orgs/{org}"], + deleteIssueType: ["DELETE /orgs/{org}/issue-types/{issue_type_id}"], deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], enableOrDisableSecurityProductOnAllOrgRepos: [ "POST /orgs/{org}/{security_product}/{enablement}", @@ -1113,6 +1115,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listForAuthenticatedUser: ["GET /user/orgs"], listForUser: ["GET /users/{username}/orgs"], listInvitationTeams: ["GET /orgs/{org}/invitations/{invitation_id}/teams"], + listIssueTypes: ["GET /orgs/{org}/issue-types"], listMembers: ["GET /orgs/{org}/members"], listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], listOrgRoleTeams: ["GET /orgs/{org}/organization-roles/{role_id}/teams"], @@ -1189,6 +1192,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], unblockUser: ["DELETE /orgs/{org}/blocks/{username}"], update: ["PATCH /orgs/{org}"], + updateIssueType: ["PUT /orgs/{org}/issue-types/{issue_type_id}"], updateMembershipForAuthenticatedUser: [ "PATCH /user/memberships/orgs/{org}", ], diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index 14c9ef48c..bbb0b1219 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -4401,7 +4401,7 @@ export type RestEndpointMethods = { * Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ createOrUpdateRepoSecret: { ( @@ -4502,7 +4502,7 @@ export type RestEndpointMethods = { /** * Deletes a development environment secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ deleteRepoSecret: { ( @@ -7551,9 +7551,27 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Create a new issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + */ + createIssueType: { + ( + params?: RestEndpointMethodTypes["orgs"]["createIssueType"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["createIssueType"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Creates new or updates existing custom properties defined for an organization in a batch. * + * If the property already exists, the existing property will be replaced with the new values. + * Missing optional values will fall back to default values, previous values will be overwritten. + * E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + * * To use this endpoint, the authenticated user must be one of: * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. @@ -7635,6 +7653,20 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Deletes an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + */ + deleteIssueType: { + ( + params?: RestEndpointMethodTypes["orgs"]["deleteIssueType"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["deleteIssueType"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Delete a webhook for an organization. * @@ -7953,6 +7985,16 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Lists all issue types for an organization. + */ + listIssueTypes: { + ( + params?: RestEndpointMethodTypes["orgs"]["listIssueTypes"]["parameters"], + ): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ @@ -8451,6 +8493,20 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Updates an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + */ + updateIssueType: { + ( + params?: RestEndpointMethodTypes["orgs"]["updateIssueType"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["updateIssueType"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. */ @@ -10739,7 +10795,7 @@ export type RestEndpointMethods = { * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -13343,6 +13399,7 @@ export type RestEndpointMethods = { /** * > [!WARNING] * > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. + * > You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/). * @deprecated octokit.rest.search.issuesAndPullRequests() is deprecated, see https://docs.github.com/rest/search/search#search-issues-and-pull-requests */ issuesAndPullRequests: { diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts index 64c96f4bb..9164b9bf0 100644 --- a/src/generated/parameters-and-response-types.ts +++ b/src/generated/parameters-and-response-types.ts @@ -2456,6 +2456,11 @@ export type RestEndpointMethodTypes = { Endpoints["POST /orgs/{org}/invitations"]["parameters"]; response: Endpoints["POST /orgs/{org}/invitations"]["response"]; }; + createIssueType: { + parameters: RequestParameters & + Endpoints["POST /orgs/{org}/issue-types"]["parameters"]; + response: Endpoints["POST /orgs/{org}/issue-types"]["response"]; + }; createOrUpdateCustomProperties: { parameters: RequestParameters & Endpoints["PATCH /orgs/{org}/properties/schema"]["parameters"]; @@ -2481,6 +2486,11 @@ export type RestEndpointMethodTypes = { Endpoints["DELETE /orgs/{org}"]["parameters"]; response: Endpoints["DELETE /orgs/{org}"]["response"]; }; + deleteIssueType: { + parameters: RequestParameters & + Endpoints["DELETE /orgs/{org}/issue-types/{issue_type_id}"]["parameters"]; + response: Endpoints["DELETE /orgs/{org}/issue-types/{issue_type_id}"]["response"]; + }; deleteWebhook: { parameters: RequestParameters & Endpoints["DELETE /orgs/{org}/hooks/{hook_id}"]["parameters"]; @@ -2590,6 +2600,11 @@ export type RestEndpointMethodTypes = { Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["parameters"]; response: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["response"]; }; + listIssueTypes: { + parameters: RequestParameters & + Endpoints["GET /orgs/{org}/issue-types"]["parameters"]; + response: Endpoints["GET /orgs/{org}/issue-types"]["response"]; + }; listMembers: { parameters: RequestParameters & Endpoints["GET /orgs/{org}/members"]["parameters"]; @@ -2760,6 +2775,11 @@ export type RestEndpointMethodTypes = { Endpoints["PATCH /orgs/{org}"]["parameters"]; response: Endpoints["PATCH /orgs/{org}"]["response"]; }; + updateIssueType: { + parameters: RequestParameters & + Endpoints["PUT /orgs/{org}/issue-types/{issue_type_id}"]["parameters"]; + response: Endpoints["PUT /orgs/{org}/issue-types/{issue_type_id}"]["response"]; + }; updateMembershipForAuthenticatedUser: { parameters: RequestParameters & Endpoints["PATCH /user/memberships/orgs/{org}"]["parameters"]; From 13fc0bb176844a9046612e885fd798eb9a3ac202 Mon Sep 17 00:00:00 2001 From: Octokit Bot <33075676+octokitbot@users.noreply.github.com> Date: Tue, 18 Mar 2025 23:36:32 +0000 Subject: [PATCH 2/2] WIP octokit/openapi updated --- package-lock.json | 16 ++++++++-------- package.json | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index 5fbaa0bc3..cb6e8a6e3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^13.9.0" + "@octokit/types": "^13.10.0" }, "devDependencies": { "@octokit/core": "^6.0.0", @@ -740,9 +740,9 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "24.1.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-24.1.0.tgz", - "integrity": "sha512-FnYcCZ7MV5dEB+E5ejjhFeg6IFLDcaCCCYcISBeSuTN891Oju1QPnR7k6v/JTwcn2+LjcVhVRcTtUIkVMyzHiw==", + "version": "24.2.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-24.2.0.tgz", + "integrity": "sha512-9sIH3nSUttelJSXUrmGzl7QUBFul0/mB8HRYl3fOlgHbIWG+WnYDXU3v/2zMtAvuzZ/ed00Ei6on975FhBfzrg==", "license": "MIT" }, "node_modules/@octokit/request": { @@ -783,12 +783,12 @@ "license": "MIT" }, "node_modules/@octokit/types": { - "version": "13.9.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.9.0.tgz", - "integrity": "sha512-gRWS+SLIhZV3JUWn9BJt+jd9L4hON2YxRTuZBw20ExPFbqTj7/2kjwzHX1V00wAN4/qJGLz1GF9Kr1DILxTBqg==", + "version": "13.10.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.10.0.tgz", + "integrity": "sha512-ifLaO34EbbPj0Xgro4G5lP5asESjwHracYJvVaPIyXMuiuXLlhic3S47cBdTb+jfODkTE5YtGCLt3Ay3+J97sA==", "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^24.1.0" + "@octokit/openapi-types": "^24.2.0" } }, "node_modules/@pkgjs/parseargs": { diff --git a/package.json b/package.json index 49133653d..cddc56845 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^13.9.0" + "@octokit/types": "^13.10.0" }, "devDependencies": { "@octokit/core": "^6.0.0",