diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 2913ab09..d5d89a2a 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "18.1.0", + "version": "18.2.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -16935,6 +16935,234 @@ "x-octokit": {} } }, + "/orgs/{org}/issue-types": { + "get": { + "summary": "List issue types for an organization", + "description": "Lists all issue types for an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-issue-types", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-type" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-type-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create issue type for an organization", + "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).", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-create-issue-type" + }, + "examples": { + "default": { + "value": { + "name": "Epic", + "description": "An issue type for a multi-week tracking of work", + "is_enabled": true, + "color": "green", + "is_private": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-type" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-type" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/issue-types/{issue_type_id}": { + "put": { + "summary": "Update issue type for an organization", + "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).", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/issue-type-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-update-issue-type" + }, + "examples": { + "default": { + "value": { + "name": "Epic", + "description": "An issue type for a multi-week tracking of work", + "is_enabled": true, + "color": "green", + "is_private": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-type" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-type" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete issue type for an organization", + "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).", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/issue-type-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + }, + "x-octokit": {} + } + }, "/orgs/{org}/issues": { "get": { "summary": "List organization issues assigned to the authenticated user", @@ -16987,6 +17215,15 @@ { "$ref": "#/components/parameters/labels" }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "sort", "description": "What to sort results by.", @@ -19303,6 +19540,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -19650,6 +19890,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -20612,7 +20855,7 @@ }, "patch": { "summary": "Create or update custom properties for an organization", - "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.", "tags": [ "orgs" ], @@ -39128,7 +39371,7 @@ }, "put": { "summary": "Create or update a repository secret", - "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.", "tags": [ "codespaces" ], @@ -39207,7 +39450,7 @@ }, "delete": { "summary": "Delete a repository secret", - "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.", "tags": [ "codespaces" ], @@ -43600,7 +43843,7 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "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.", "tags": [ "repos" ], @@ -47621,6 +47864,15 @@ "type": "string" } }, + { + "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", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "creator", "description": "The user that created the issue.", @@ -47806,6 +48058,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue.", + "nullable": true, + "example": "Epic" } }, "required": [ @@ -48661,6 +48919,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "nullable": true, + "example": "Epic" } } }, @@ -60940,7 +61204,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "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/).", "tags": [ "search" ], @@ -96821,6 +97085,7 @@ "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", + "format": "int64", "example": 42 }, "guid": { @@ -96868,12 +97133,14 @@ "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, @@ -97215,7 +97482,7 @@ }, "dependabot_secrets": { "type": "string", - "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.", "enum": [ "read", "write" @@ -100546,6 +100813,66 @@ ], "nullable": true }, + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, "nullable-integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -100972,6 +101299,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -104206,12 +104536,12 @@ "type": "object", "properties": { "id": { - "description": "The id of the runner.", + "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The id of the runner group.", + "description": "The ID of the runner group.", "type": "integer", "example": 1 }, @@ -106971,6 +107301,88 @@ "limit" ] }, + "organization-create-issue-type": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue type.", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the issue type is enabled at the organization level.", + "type": "boolean" + }, + "is_private": { + "description": "Whether or not the issue type is restricted to issues in private repositories.", + "type": "boolean" + }, + "description": { + "description": "Description of the issue type.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the issue type.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + } + }, + "required": [ + "name", + "is_enabled" + ] + }, + "organization-update-issue-type": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue type.", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the issue type is enabled at the organization level.", + "type": "boolean" + }, + "is_private": { + "description": "Whether or not the issue type is restricted to issues in private repositories.", + "type": "boolean" + }, + "description": { + "description": "Description of the issue type.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the issue type.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + } + }, + "required": [ + "name", + "is_enabled" + ] + }, "org-membership": { "title": "Org Membership", "description": "Org Membership", @@ -108157,6 +108569,16 @@ "maxItems": 200, "nullable": true, "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -121479,6 +121901,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -127360,6 +127785,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "performed_via_github_app": { "$ref": "#/components/schemas/nullable-integration" }, @@ -133378,6 +133806,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -134769,6 +135200,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -158832,6 +159266,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -160414,6 +160851,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -162005,6 +162445,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -163630,6 +164073,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -165071,6 +165517,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -166333,6 +166782,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -167584,6 +168036,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -168832,6 +169287,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -170106,6 +170564,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -171348,6 +171809,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -174396,6 +174860,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -175802,6 +176269,9 @@ "type": "string" } } + }, + "type": { + "$ref": "#/components/schemas/issue-type" } } }, @@ -176912,6 +177382,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -178882,6 +179355,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -276687,6 +277163,36 @@ } ] }, + "issue-type-items": { + "value": [ + { + "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" + } + ] + }, + "issue-type": { + "value": { + "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" + } + }, "codespace": { "value": { "id": 1, @@ -300498,6 +301004,15 @@ "type": "integer" } }, + "issue-type-id": { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "codespace-name": { "name": "codespace_name", "in": "path", @@ -300659,6 +301174,20 @@ "format": "date-time" } }, + "personal-access-token-token-id": { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "example": "token_id[]=1,token_id[]=2" + } + }, "fine-grained-personal-access-token-id": { "name": "pat_id", "description": "The unique identifier of the fine-grained personal access token.", diff --git a/cache/ghec.json b/cache/ghec.json index 4f011acd..6dc2c137 100644 --- a/cache/ghec.json +++ b/cache/ghec.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "18.1.0", + "version": "18.2.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -8297,7 +8297,7 @@ }, "patch": { "summary": "Create or update custom properties for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates new or updates existing custom properties defined for an enterprise in a batch.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates new or updates existing custom properties defined for an enterprise 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 an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -24055,6 +24055,234 @@ "x-octokit": {} } }, + "/orgs/{org}/issue-types": { + "get": { + "summary": "List issue types for an organization", + "description": "Lists all issue types for an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-issue-types", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-type" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-type-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create issue type for an organization", + "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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-create-issue-type" + }, + "examples": { + "default": { + "value": { + "name": "Epic", + "description": "An issue type for a multi-week tracking of work", + "is_enabled": true, + "color": "green", + "is_private": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-type" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-type" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/issue-types/{issue_type_id}": { + "put": { + "summary": "Update issue type for an organization", + "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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/issue-type-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-update-issue-type" + }, + "examples": { + "default": { + "value": { + "name": "Epic", + "description": "An issue type for a multi-week tracking of work", + "is_enabled": true, + "color": "green", + "is_private": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-type" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-type" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete issue type for an organization", + "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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/issue-type-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + }, + "x-octokit": {} + } + }, "/orgs/{org}/issues": { "get": { "summary": "List organization issues assigned to the authenticated user", @@ -24107,6 +24335,15 @@ { "$ref": "#/components/parameters/labels" }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "sort", "description": "What to sort results by.", @@ -26703,6 +26940,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -27050,6 +27290,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -28012,7 +28255,7 @@ }, "patch": { "summary": "Create or update custom properties for an organization", - "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.", "tags": [ "orgs" ], @@ -47451,7 +47694,7 @@ }, "put": { "summary": "Create or update a repository secret", - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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.", "tags": [ "codespaces" ], @@ -47530,7 +47773,7 @@ }, "delete": { "summary": "Delete a repository secret", - "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.", "tags": [ "codespaces" ], @@ -51923,7 +52166,7 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest//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.", "tags": [ "repos" ], @@ -55944,6 +56187,15 @@ "type": "string" } }, + { + "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", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "creator", "description": "The user that created the issue.", @@ -56129,6 +56381,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue.", + "nullable": true, + "example": "Epic" } }, "required": [ @@ -56984,6 +57242,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "nullable": true, + "example": "Epic" } } }, @@ -71042,7 +71306,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "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/).", "tags": [ "search" ], @@ -87712,7 +87976,193 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-comment-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-created": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was created.", + "operationId": "discussion/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-created" } } } @@ -87725,7 +88175,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -87734,13 +88184,13 @@ } } }, - "discussion-comment-edited": { + "discussion-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -87805,7 +88255,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-discussion-deleted" } } } @@ -87818,7 +88268,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -87827,11 +88277,11 @@ } } }, - "discussion-created": { + "discussion-edited": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -87898,7 +88348,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-edited" } } } @@ -87920,11 +88370,11 @@ } } }, - "discussion-deleted": { + "discussion-labeled": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -87991,7 +88441,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-labeled" } } } @@ -88013,11 +88463,11 @@ } } }, - "discussion-edited": { + "discussion-locked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -88084,7 +88534,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-locked" } } } @@ -88106,11 +88556,11 @@ } } }, - "discussion-labeled": { + "discussion-pinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -88177,7 +88627,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-pinned" } } } @@ -88199,11 +88649,104 @@ } } }, - "discussion-locked": { + "discussion-reopened": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "description": "A discussion was reopened.", + "operationId": "discussion/reopened", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussions", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -88270,7 +88813,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-transferred" } } } @@ -88292,11 +88835,11 @@ } } }, - "discussion-pinned": { + "discussion-unanswered": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -88363,7 +88906,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-unanswered" } } } @@ -88385,11 +88928,104 @@ } } }, - "discussion-reopened": { + "discussion-unlabeled": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was reopened.", - "operationId": "discussion/reopened", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-unlabeled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-unlocked": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -88413,7 +89049,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -88456,7 +89092,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-unlocked" } } } @@ -88478,11 +89114,11 @@ } } }, - "discussion-transferred": { + "discussion-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -88549,7 +89185,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-unpinned" } } } @@ -88571,13 +89207,13 @@ } } }, - "discussion-unanswered": { + "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal request was created.", + "operationId": "dismissal-request-code-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -88642,7 +89278,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -88653,9 +89289,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -88664,13 +89300,13 @@ } } }, - "discussion-unlabeled": { + "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal response was submitted.", + "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -88735,7 +89371,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -88746,9 +89382,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -88757,13 +89393,13 @@ } } }, - "discussion-unlocked": { + "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal request was created.", + "operationId": "dismissal-request-code-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -88828,7 +89464,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -88839,9 +89475,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -88850,13 +89486,13 @@ } } }, - "discussion-unpinned": { + "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal response was submitted.", + "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -88921,7 +89557,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -88932,9 +89568,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -108416,6 +109052,7 @@ "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", + "format": "int64", "example": 42 }, "guid": { @@ -108463,12 +109100,14 @@ "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, @@ -108810,7 +109449,7 @@ }, "dependabot_secrets": { "type": "string", - "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.", "enum": [ "read", "write" @@ -111649,12 +112288,12 @@ "type": "object", "properties": { "id": { - "description": "The id of the runner.", + "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The id of the runner group.", + "description": "The ID of the runner group.", "type": "integer", "example": 1 }, @@ -115067,6 +115706,16 @@ "maxItems": 200, "nullable": true, "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -117142,6 +117791,66 @@ ], "nullable": true }, + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, "nullable-integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -117568,6 +118277,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -122412,6 +123124,88 @@ "limit" ] }, + "organization-create-issue-type": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue type.", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the issue type is enabled at the organization level.", + "type": "boolean" + }, + "is_private": { + "description": "Whether or not the issue type is restricted to issues in private repositories.", + "type": "boolean" + }, + "description": { + "description": "Description of the issue type.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the issue type.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + } + }, + "required": [ + "name", + "is_enabled" + ] + }, + "organization-update-issue-type": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue type.", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the issue type is enabled at the organization level.", + "type": "boolean" + }, + "is_private": { + "description": "Whether or not the issue type is restricted to issues in private repositories.", + "type": "boolean" + }, + "description": { + "description": "Description of the issue type.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the issue type.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + } + }, + "required": [ + "name", + "is_enabled" + ] + }, "org-membership": { "title": "Org Membership", "description": "Org Membership", @@ -135372,6 +136166,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -142145,6 +142942,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "performed_via_github_app": { "$ref": "#/components/schemas/nullable-integration" }, @@ -145361,6 +146161,33 @@ } } }, + "dismissal-request-code-scanning": { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -145402,6 +146229,26 @@ } } }, + "dismissal-request-code-scanning-metadata": { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", @@ -145472,7 +146319,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -145485,6 +146333,9 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -145512,12 +146363,15 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "oneOf": [ + "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" } ] }, @@ -148467,6 +149321,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -149858,6 +150715,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -174104,6 +174964,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -175686,6 +176549,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -177277,6 +178143,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -178902,6 +179771,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -180343,6 +181215,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -181605,6 +182480,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -182856,6 +183734,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -184104,6 +184985,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -185378,6 +186262,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -186620,6 +187507,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -189668,6 +190558,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -191074,6 +191967,9 @@ "type": "string" } } + }, + "type": { + "$ref": "#/components/schemas/issue-type" } } }, @@ -192184,6 +193080,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -194154,6 +195053,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -293082,6 +293984,36 @@ } ] }, + "issue-type-items": { + "value": [ + { + "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" + } + ] + }, + "issue-type": { + "value": { + "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" + } + }, "codespace": { "value": { "id": 1, @@ -317529,6 +318461,15 @@ "type": "integer" } }, + "issue-type-id": { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "codespace-name": { "name": "codespace_name", "in": "path", @@ -317672,6 +318613,20 @@ "format": "date-time" } }, + "personal-access-token-token-id": { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "example": "token_id[]=1,token_id[]=2" + } + }, "fine-grained-personal-access-token-id": { "name": "pat_id", "description": "The unique identifier of the fine-grained personal access token.", diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json index f5ce9f8e..99770385 100644 --- a/cache/ghes-3.12.json +++ b/cache/ghes-3.12.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "18.1.0", + "version": "18.2.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -18611,6 +18611,15 @@ { "$ref": "#/components/parameters/labels" }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "sort", "description": "What to sort results by.", @@ -20196,6 +20205,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -20543,6 +20555,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -40882,7 +40897,7 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "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/enterprise-server@3.12/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/enterprise-server@3.12/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.12/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.", "tags": [ "repos" ], @@ -44130,6 +44145,15 @@ "type": "string" } }, + { + "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", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "creator", "description": "The user that created the issue.", @@ -44315,6 +44339,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue.", + "nullable": true, + "example": "Epic" } }, "required": [ @@ -45170,6 +45200,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "nullable": true, + "example": "Epic" } } }, @@ -92735,7 +92771,7 @@ }, "dependabot_secrets": { "type": "string", - "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.", "enum": [ "read", "write" @@ -94048,6 +94084,7 @@ "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", + "format": "int64", "example": 42 }, "guid": { @@ -94095,12 +94132,14 @@ "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, @@ -95875,12 +95914,12 @@ "type": "object", "properties": { "id": { - "description": "The id of the runner.", + "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The id of the runner group.", + "description": "The ID of the runner group.", "type": "integer", "example": 1 }, @@ -97539,6 +97578,66 @@ ], "nullable": true }, + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, "nullable-integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -97961,6 +98060,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -114485,6 +114587,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -120052,6 +120157,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "performed_via_github_app": { "$ref": "#/components/schemas/nullable-integration" }, @@ -126093,6 +126201,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -127484,6 +127595,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -151035,6 +151149,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -152617,6 +152734,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -154208,6 +154328,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -155833,6 +155956,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -157274,6 +157400,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -158536,6 +158665,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -159787,6 +159919,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -161035,6 +161170,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -162309,6 +162447,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -163551,6 +163692,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -166594,6 +166738,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -168000,6 +168147,9 @@ "type": "string" } } + }, + "type": { + "$ref": "#/components/schemas/issue-type" } } }, @@ -169110,6 +169260,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -171075,6 +171228,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -281603,6 +281759,20 @@ "format": "date-time" } }, + "personal-access-token-token-id": { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "example": "token_id[]=1,token_id[]=2" + } + }, "fine-grained-personal-access-token-id": { "name": "pat_id", "description": "The unique identifier of the fine-grained personal access token.", diff --git a/cache/ghes-3.13.json b/cache/ghes-3.13.json index c4fd4016..71630422 100644 --- a/cache/ghes-3.13.json +++ b/cache/ghes-3.13.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "18.1.0", + "version": "18.2.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -18633,6 +18633,15 @@ { "$ref": "#/components/parameters/labels" }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "sort", "description": "What to sort results by.", @@ -20218,6 +20227,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -20565,6 +20577,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -21297,7 +21312,7 @@ }, "patch": { "summary": "Create or update custom properties for an organization", - "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.", "tags": [ "orgs" ], @@ -41369,7 +41384,7 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "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/enterprise-server@3.13/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/enterprise-server@3.13/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.13/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.", "tags": [ "repos" ], @@ -44617,6 +44632,15 @@ "type": "string" } }, + { + "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", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "creator", "description": "The user that created the issue.", @@ -44802,6 +44826,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue.", + "nullable": true, + "example": "Epic" } }, "required": [ @@ -45657,6 +45687,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "nullable": true, + "example": "Epic" } } }, @@ -93551,7 +93587,7 @@ }, "dependabot_secrets": { "type": "string", - "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.", "enum": [ "read", "write" @@ -94872,6 +94908,7 @@ "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", + "format": "int64", "example": 42 }, "guid": { @@ -94919,12 +94956,14 @@ "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, @@ -96699,12 +96738,12 @@ "type": "object", "properties": { "id": { - "description": "The id of the runner.", + "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The id of the runner group.", + "description": "The ID of the runner group.", "type": "integer", "example": 1 }, @@ -98368,6 +98407,66 @@ ], "nullable": true }, + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, "nullable-integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -98790,6 +98889,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -103974,6 +104076,16 @@ "maxItems": 200, "nullable": true, "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -115589,6 +115701,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -121191,6 +121306,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "performed_via_github_app": { "$ref": "#/components/schemas/nullable-integration" }, @@ -127237,6 +127355,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -128628,6 +128749,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -152184,6 +152308,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -153766,6 +153893,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -155357,6 +155487,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -156982,6 +157115,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -158423,6 +158559,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -159685,6 +159824,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -160936,6 +161078,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -162184,6 +162329,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -163458,6 +163606,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -164700,6 +164851,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -167748,6 +167902,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -169154,6 +169311,9 @@ "type": "string" } } + }, + "type": { + "$ref": "#/components/schemas/issue-type" } } }, @@ -170264,6 +170424,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -172234,6 +172397,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -282961,6 +283127,20 @@ "format": "date-time" } }, + "personal-access-token-token-id": { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "example": "token_id[]=1,token_id[]=2" + } + }, "fine-grained-personal-access-token-id": { "name": "pat_id", "description": "The unique identifier of the fine-grained personal access token.", diff --git a/cache/ghes-3.14.json b/cache/ghes-3.14.json index 0c8a064c..bf42a489 100644 --- a/cache/ghes-3.14.json +++ b/cache/ghes-3.14.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "18.1.0", + "version": "18.2.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -18639,6 +18639,15 @@ { "$ref": "#/components/parameters/labels" }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "sort", "description": "What to sort results by.", @@ -20976,6 +20985,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -21323,6 +21335,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -22055,7 +22070,7 @@ }, "patch": { "summary": "Create or update custom properties for an organization", - "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.", "tags": [ "orgs" ], @@ -42127,7 +42142,7 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "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/enterprise-server@3.14/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/enterprise-server@3.14/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.14/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.", "tags": [ "repos" ], @@ -45375,6 +45390,15 @@ "type": "string" } }, + { + "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", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "creator", "description": "The user that created the issue.", @@ -45560,6 +45584,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue.", + "nullable": true, + "example": "Epic" } }, "required": [ @@ -46415,6 +46445,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "nullable": true, + "example": "Epic" } } }, @@ -94699,7 +94735,7 @@ }, "dependabot_secrets": { "type": "string", - "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.", "enum": [ "read", "write" @@ -96020,6 +96056,7 @@ "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", + "format": "int64", "example": 42 }, "guid": { @@ -96067,12 +96104,14 @@ "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, @@ -97847,12 +97886,12 @@ "type": "object", "properties": { "id": { - "description": "The id of the runner.", + "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The id of the runner group.", + "description": "The ID of the runner group.", "type": "integer", "example": 1 }, @@ -99516,6 +99555,66 @@ ], "nullable": true }, + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, "nullable-integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -99938,6 +100037,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -105668,6 +105770,16 @@ "maxItems": 200, "nullable": true, "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -117186,6 +117298,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -122856,6 +122971,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "performed_via_github_app": { "$ref": "#/components/schemas/nullable-integration" }, @@ -126103,6 +126221,33 @@ } } }, + "dismissal-request-code-scanning": { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -126144,6 +126289,26 @@ } } }, + "dismissal-request-code-scanning-metadata": { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", @@ -126214,7 +126379,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -126227,6 +126393,9 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -126254,12 +126423,15 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "oneOf": [ + "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" } ] }, @@ -129206,6 +129378,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -130597,6 +130772,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -154390,6 +154568,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -155972,6 +156153,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -157563,6 +157747,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -159188,6 +159375,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -160629,6 +160819,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -161891,6 +162084,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -163142,6 +163338,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -164390,6 +164589,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -165664,6 +165866,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -166906,6 +167111,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -169954,6 +170162,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -171360,6 +171571,9 @@ "type": "string" } } + }, + "type": { + "$ref": "#/components/schemas/issue-type" } } }, @@ -172470,6 +172684,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -174440,6 +174657,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -285340,6 +285560,20 @@ "format": "date-time" } }, + "personal-access-token-token-id": { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "example": "token_id[]=1,token_id[]=2" + } + }, "fine-grained-personal-access-token-id": { "name": "pat_id", "description": "The unique identifier of the fine-grained personal access token.", diff --git a/cache/ghes-3.15.json b/cache/ghes-3.15.json index 9ef5ed53..4680cf0a 100644 --- a/cache/ghes-3.15.json +++ b/cache/ghes-3.15.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "18.1.0", + "version": "18.2.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -19674,6 +19674,15 @@ { "$ref": "#/components/parameters/labels" }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "sort", "description": "What to sort results by.", @@ -22011,6 +22020,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -22358,6 +22370,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -22878,7 +22893,7 @@ "/orgs/{org}/projects": { "get": { "summary": "List organization projects", - "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -22945,13 +22960,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "post": { "summary": "Create an organization project", - "description": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -23032,8 +23050,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -23090,7 +23111,7 @@ }, "patch": { "summary": "Create or update custom properties for an organization", - "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.", "tags": [ "orgs" ], @@ -26736,7 +26757,7 @@ "/orgs/{org}/teams/{team_slug}/projects": { "get": { "summary": "List team projects", - "description": "Lists the organization projects for a team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -26788,15 +26809,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams" + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project", - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -26840,13 +26864,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams" + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "put": { "summary": "Add or update team project permissions", - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -26931,13 +26958,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams" + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Remove a project from a team", - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -26966,8 +26996,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams" + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -27320,7 +27353,7 @@ "/projects/columns/cards/{card_id}": { "get": { "summary": "Get a project card", - "description": "Gets information about a project card.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -27367,13 +27400,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "patch": { "summary": "Update an existing project card", - "description": "", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -27454,13 +27490,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Delete a project card", - "description": "Deletes a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -27516,15 +27555,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/columns/cards/{card_id}/moves": { "post": { "summary": "Move a project card", - "description": "", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -27678,15 +27720,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/columns/{column_id}": { "get": { "summary": "Get a project column", - "description": "Gets information about a project column.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -27733,13 +27778,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "patch": { "summary": "Update an existing project column", - "description": "", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -27811,13 +27859,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Delete a project column", - "description": "Deletes a project column.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -27849,15 +27900,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/columns/{column_id}/cards": { "get": { "summary": "List project cards", - "description": "Lists the project cards in a project.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -27930,13 +27984,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "post": { "summary": "Create a project card", - "description": "", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -28084,15 +28141,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/columns/{column_id}/moves": { "post": { "summary": "Move a project column", - "description": "", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -28170,15 +28230,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/{project_id}": { "get": { "summary": "Get a project", - "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -28222,13 +28285,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "patch": { "summary": "Update a project", - "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "operationId": "projects/update", "tags": [ "projects" @@ -28354,13 +28420,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Delete a project", - "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "operationId": "projects/delete", "tags": [ "projects" @@ -28419,15 +28488,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/{project_id}/collaborators": { "get": { "summary": "List project collaborators", - "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -28506,15 +28578,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "collaborators" + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/{project_id}/collaborators/{username}": { "put": { "summary": "Add project collaborator", - "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -28587,13 +28662,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "collaborators" + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Remove user as a collaborator", - "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -28634,15 +28712,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "collaborators" + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/{project_id}/collaborators/{username}/permission": { "get": { "summary": "Get project permission for a user", - "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -28695,15 +28776,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "collaborators" + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/{project_id}/columns": { "get": { "summary": "List project columns", - "description": "Lists the project columns in a project.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -28761,13 +28845,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "post": { "summary": "Create a project column", - "description": "Creates a new project column.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -28850,8 +28937,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -43230,7 +43320,7 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "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/enterprise-server@3.15/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/enterprise-server@3.15/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.15/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.", "tags": [ "repos" ], @@ -46478,6 +46568,15 @@ "type": "string" } }, + { + "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", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "creator", "description": "The user that created the issue.", @@ -46663,6 +46762,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue.", + "nullable": true, + "example": "Epic" } }, "required": [ @@ -47518,6 +47623,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "nullable": true, + "example": "Epic" } } }, @@ -51384,7 +51495,7 @@ "/repos/{owner}/{repo}/projects": { "get": { "summary": "List repository projects", - "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -51466,13 +51577,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "post": { "summary": "Create a repository project", - "description": "Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -51556,8 +51670,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -61505,7 +61622,7 @@ "/teams/{team_id}/projects": { "get": { "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -61556,8 +61673,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", + "removalDate": "2025-04-01", + "deprecationDate": "2024-05-23", "category": "teams", "subcategory": "teams" }, @@ -61568,7 +61685,7 @@ "/teams/{team_id}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -61608,8 +61725,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", + "removalDate": "2025-04-01", + "deprecationDate": "2024-05-23", "category": "teams", "subcategory": "teams" }, @@ -61618,7 +61735,7 @@ }, "put": { "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -61704,8 +61821,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", + "removalDate": "2025-04-01", + "deprecationDate": "2024-05-23", "category": "teams", "subcategory": "teams" }, @@ -61714,7 +61831,7 @@ }, "delete": { "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -61745,8 +61862,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", + "removalDate": "2025-04-01", + "deprecationDate": "2024-05-23", "category": "teams", "subcategory": "teams" }, @@ -64806,7 +64923,7 @@ "/user/projects": { "post": { "summary": "Create a user project", - "description": "Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -64884,8 +65001,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -67683,7 +67803,7 @@ "/users/{username}/projects": { "get": { "summary": "List user projects", - "description": "Lists projects for a user.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -67750,8 +67870,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -95159,7 +95282,7 @@ }, "dependabot_secrets": { "type": "string", - "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.", "enum": [ "read", "write" @@ -96492,6 +96615,7 @@ "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", + "format": "int64", "example": 42 }, "guid": { @@ -96539,12 +96663,14 @@ "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, @@ -98319,12 +98445,12 @@ "type": "object", "properties": { "id": { - "description": "The id of the runner.", + "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The id of the runner group.", + "description": "The ID of the runner group.", "type": "integer", "example": 1 }, @@ -99993,6 +100119,66 @@ ], "nullable": true }, + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, "nullable-integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -100419,6 +100605,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -106400,6 +106589,16 @@ "maxItems": 200, "nullable": true, "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -118021,6 +118220,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -123728,6 +123930,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "performed_via_github_app": { "$ref": "#/components/schemas/nullable-integration" }, @@ -126493,6 +126698,33 @@ } } }, + "dismissal-request-code-scanning": { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -126534,6 +126766,26 @@ } } }, + "dismissal-request-code-scanning-metadata": { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", @@ -126604,7 +126856,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -126617,6 +126870,9 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -126644,12 +126900,15 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "oneOf": [ + "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" } ] }, @@ -129596,6 +129855,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -130987,6 +131249,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -154808,6 +155073,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -156390,6 +156658,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -157981,6 +158252,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -159606,6 +159880,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -161047,6 +161324,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -162309,6 +162589,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -163560,6 +163843,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -164808,6 +165094,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -166082,6 +166371,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -167324,6 +167616,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -170372,6 +170667,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -171778,6 +172076,9 @@ "type": "string" } } + }, + "type": { + "$ref": "#/components/schemas/issue-type" } } }, @@ -172888,6 +173189,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -174858,6 +175162,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -285828,6 +286135,20 @@ "format": "date-time" } }, + "personal-access-token-token-id": { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "example": "token_id[]=1,token_id[]=2" + } + }, "fine-grained-personal-access-token-id": { "name": "pat_id", "description": "The unique identifier of the fine-grained personal access token.", diff --git a/cache/ghes-3.16.json b/cache/ghes-3.16.json index 84a11ce5..010a9abd 100644 --- a/cache/ghes-3.16.json +++ b/cache/ghes-3.16.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "18.1.0", + "version": "18.2.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -20976,6 +20976,15 @@ { "$ref": "#/components/parameters/labels" }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "sort", "description": "What to sort results by.", @@ -23313,6 +23322,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -23660,6 +23672,9 @@ }, { "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" } ], "responses": { @@ -24636,7 +24651,7 @@ "/orgs/{org}/projects": { "get": { "summary": "List organization projects", - "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -24703,13 +24718,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "post": { "summary": "Create an organization project", - "description": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -24790,8 +24808,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -24848,7 +24869,7 @@ }, "patch": { "summary": "Create or update custom properties for an organization", - "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.", "tags": [ "orgs" ], @@ -28503,7 +28524,7 @@ "/orgs/{org}/teams/{team_slug}/projects": { "get": { "summary": "List team projects", - "description": "Lists the organization projects for a team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -28555,15 +28576,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams" + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project", - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -28607,13 +28631,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams" + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "put": { "summary": "Add or update team project permissions", - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -28698,13 +28725,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams" + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Remove a project from a team", - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -28733,8 +28763,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams" + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -29087,7 +29120,7 @@ "/projects/columns/cards/{card_id}": { "get": { "summary": "Get a project card", - "description": "Gets information about a project card.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29134,13 +29167,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "patch": { "summary": "Update an existing project card", - "description": "", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29221,13 +29257,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Delete a project card", - "description": "Deletes a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29283,15 +29322,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/columns/cards/{card_id}/moves": { "post": { "summary": "Move a project card", - "description": "", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29445,15 +29487,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/columns/{column_id}": { "get": { "summary": "Get a project column", - "description": "Gets information about a project column.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29500,13 +29545,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "patch": { "summary": "Update an existing project column", - "description": "", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29578,13 +29626,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Delete a project column", - "description": "Deletes a project column.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29616,15 +29667,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/columns/{column_id}/cards": { "get": { "summary": "List project cards", - "description": "Lists the project cards in a project.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29697,13 +29751,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "post": { "summary": "Create a project card", - "description": "", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29851,15 +29908,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "cards" + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/columns/{column_id}/moves": { "post": { "summary": "Move a project column", - "description": "", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29937,15 +29997,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/{project_id}": { "get": { "summary": "Get a project", - "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -29989,13 +30052,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "patch": { "summary": "Update a project", - "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "operationId": "projects/update", "tags": [ "projects" @@ -30121,13 +30187,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Delete a project", - "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "operationId": "projects/delete", "tags": [ "projects" @@ -30186,15 +30255,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/{project_id}/collaborators": { "get": { "summary": "List project collaborators", - "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -30273,15 +30345,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "collaborators" + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/{project_id}/collaborators/{username}": { "put": { "summary": "Add project collaborator", - "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -30354,13 +30429,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "collaborators" + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Remove user as a collaborator", - "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -30401,15 +30479,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "collaborators" + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/{project_id}/collaborators/{username}/permission": { "get": { "summary": "Get project permission for a user", - "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -30462,15 +30543,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "collaborators" + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, "/projects/{project_id}/columns": { "get": { "summary": "List project columns", - "description": "Lists the project columns in a project.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -30528,13 +30612,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "post": { "summary": "Create a project column", - "description": "Creates a new project column.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -30617,8 +30704,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "columns" + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -45047,7 +45137,7 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "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/enterprise-server@3.16/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/enterprise-server@3.16/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.16/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.", "tags": [ "repos" ], @@ -48295,6 +48385,15 @@ "type": "string" } }, + { + "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", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "creator", "description": "The user that created the issue.", @@ -48480,6 +48579,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue.", + "nullable": true, + "example": "Epic" } }, "required": [ @@ -49335,6 +49440,12 @@ "items": { "type": "string" } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "nullable": true, + "example": "Epic" } } }, @@ -53201,7 +53312,7 @@ "/repos/{owner}/{repo}/projects": { "get": { "summary": "List repository projects", - "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -53283,13 +53394,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} }, "post": { "summary": "Create a repository project", - "description": "Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -53373,8 +53487,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -63380,7 +63497,7 @@ "/teams/{team_id}/projects": { "get": { "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -63431,8 +63548,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", + "removalDate": "2025-04-01", + "deprecationDate": "2024-05-23", "category": "teams", "subcategory": "teams" }, @@ -63443,7 +63560,7 @@ "/teams/{team_id}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -63483,8 +63600,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", + "removalDate": "2025-04-01", + "deprecationDate": "2024-05-23", "category": "teams", "subcategory": "teams" }, @@ -63493,7 +63610,7 @@ }, "put": { "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -63579,8 +63696,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", + "removalDate": "2025-04-01", + "deprecationDate": "2024-05-23", "category": "teams", "subcategory": "teams" }, @@ -63589,7 +63706,7 @@ }, "delete": { "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "teams" ], @@ -63620,8 +63737,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", + "removalDate": "2025-04-01", + "deprecationDate": "2024-05-23", "category": "teams", "subcategory": "teams" }, @@ -66681,7 +66798,7 @@ "/user/projects": { "post": { "summary": "Create a user project", - "description": "Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -66759,8 +66876,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -69558,7 +69678,7 @@ "/users/{username}/projects": { "get": { "summary": "List user projects", - "description": "Lists projects for a user.", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects" ], @@ -69625,8 +69745,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "projects", - "subcategory": "projects" + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -97595,7 +97718,7 @@ }, "dependabot_secrets": { "type": "string", - "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.", "enum": [ "read", "write" @@ -98936,6 +99059,7 @@ "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", + "format": "int64", "example": 42 }, "guid": { @@ -98983,12 +99107,14 @@ "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", + "format": "int64", "example": 123, "nullable": true }, @@ -100763,12 +100889,12 @@ "type": "object", "properties": { "id": { - "description": "The id of the runner.", + "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The id of the runner group.", + "description": "The ID of the runner group.", "type": "integer", "example": 1 }, @@ -103085,6 +103211,66 @@ ], "nullable": true }, + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, "nullable-integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -103511,6 +103697,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -109397,6 +109586,16 @@ "maxItems": 200, "nullable": true, "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -121190,6 +121389,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "repository": { "$ref": "#/components/schemas/repository" }, @@ -126996,6 +127198,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "performed_via_github_app": { "$ref": "#/components/schemas/nullable-integration" }, @@ -129761,6 +129966,33 @@ } } }, + "dismissal-request-code-scanning": { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -129802,6 +130034,26 @@ } } }, + "dismissal-request-code-scanning-metadata": { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", @@ -129872,7 +130124,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -129885,6 +130138,9 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -129912,12 +130168,15 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "oneOf": [ + "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" } ] }, @@ -132867,6 +133126,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -134258,6 +134520,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -158103,6 +158368,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -159685,6 +159953,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -161276,6 +161547,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -162901,6 +163175,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -164342,6 +164619,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -165604,6 +165884,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -166855,6 +167138,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -168103,6 +168389,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -169377,6 +169666,9 @@ "type": "string", "format": "uri" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "title": { "description": "Title of the issue", "type": "string" @@ -170619,6 +170911,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -173667,6 +173962,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -175073,6 +175371,9 @@ "type": "string" } } + }, + "type": { + "$ref": "#/components/schemas/issue-type" } } }, @@ -176183,6 +176484,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -178153,6 +178457,9 @@ "description": "Title of the issue", "type": "string" }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, "updated_at": { "type": "string", "format": "date-time" @@ -289532,6 +289839,20 @@ "format": "date-time" } }, + "personal-access-token-token-id": { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "example": "token_id[]=1,token_id[]=2" + } + }, "fine-grained-personal-access-token-id": { "name": "pat_id", "description": "The unique identifier of the fine-grained personal access token.", diff --git a/packages/openapi-types-ghec/package.json b/packages/openapi-types-ghec/package.json index 7399ee7b..ed15cf78 100644 --- a/packages/openapi-types-ghec/package.json +++ b/packages/openapi-types-ghec/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "18.1.0" + "openapi-version": "18.2.0" } } diff --git a/packages/openapi-types-ghec/types.d.ts b/packages/openapi-types-ghec/types.d.ts index 8b0dc25a..0310839d 100644 --- a/packages/openapi-types-ghec/types.d.ts +++ b/packages/openapi-types-ghec/types.d.ts @@ -1048,6 +1048,10 @@ export interface paths { * * Creates new or updates existing custom properties defined for an enterprise 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 an administrator for the enterprise. */ patch: operations["enterprise-admin/create-or-update-enterprise-custom-properties"]; @@ -3511,6 +3515,36 @@ export interface paths { */ get: operations["orgs/list-invitation-teams"]; }; + "/orgs/{org}/issue-types": { + /** + * List issue types for an organization + * @description Lists all issue types for an organization. + */ + get: operations["orgs/list-issue-types"]; + /** + * Create issue type for an organization + * @description 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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + */ + post: operations["orgs/create-issue-type"]; + }; + "/orgs/{org}/issue-types/{issue_type_id}": { + /** + * Update issue type for an organization + * @description 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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + */ + put: operations["orgs/update-issue-type"]; + /** + * Delete issue type for an organization + * @description 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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + */ + delete: operations["orgs/delete-issue-type"]; + }; "/orgs/{org}/issues": { /** * List organization issues assigned to the authenticated user @@ -4119,6 +4153,10 @@ export interface paths { * Create or update custom properties for an organization * @description 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. @@ -6851,14 +6889,14 @@ export interface paths { * @description 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/enterprise-cloud@latest//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. */ put: operations["codespaces/create-or-update-repo-secret"]; /** * Delete a repository secret * @description 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. */ delete: operations["codespaces/delete-repo-secret"]; }; @@ -7633,7 +7671,7 @@ export interface paths { * * 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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest//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. */ @@ -10157,6 +10195,7 @@ export interface paths { * @deprecated * @description > [!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/). */ get: operations["search/issues-and-pull-requests"]; }; @@ -12333,6 +12372,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -12379,11 +12419,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -12573,7 +12615,7 @@ export interface components { */ contents?: "read" | "write"; /** - * @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. * @enum {string} */ dependabot_secrets?: "read" | "write"; @@ -14270,12 +14312,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -16060,6 +16102,12 @@ export interface components { * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; /** * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target. @@ -16968,6 +17016,46 @@ export interface components { */ due_on: string | null; } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -17190,6 +17278,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -19812,6 +19901,54 @@ export interface components { limit: components["schemas"]["interaction-group"]; expiry?: components["schemas"]["interaction-expiry"]; }; + "organization-create-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Whether or not the issue type is restricted to issues in private repositories. */ + is_private?: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + }; + "organization-update-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Whether or not the issue type is restricted to issues in private repositories. */ + is_private?: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + }; /** * Org Membership * @description Org Membership @@ -26531,6 +26668,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -29592,6 +29730,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; }; @@ -31167,6 +31306,22 @@ export interface components { alert_number?: string; }[]; }; + /** + * Code scanning alert dismissal request data + * @description Code scanning alerts that have dismissal requests. + */ + "dismissal-request-code-scanning": { + /** + * @description The type of request + * @enum {string} + */ + type?: "code_scanning_alert_dismissal"; + /** @description The data related to the code scanning alerts that have dismissal requests. */ + data?: { + /** @description The number of the alert to be dismissed */ + alert_number?: string; + }[]; + }; /** * Secret Scanning Push Protection Exemption Request Metadata * @description Metadata for a secret scanning push protection exemption request. @@ -31193,6 +31348,19 @@ export interface components { */ reason?: "fixed_later" | "false_positive" | "tests" | "revoked"; }; + /** + * Code scanning alert dismissal request metadata + * @description Metadata for a code scanning alert dismissal request. + */ + "dismissal-request-code-scanning-metadata": { + /** @description The title of the code scanning alert */ + alert_title?: string; + /** + * @description The reason for the dismissal request + * @enum {string} + */ + reason?: "false positive" | "won't fix" | "used in tests"; + }; /** * Exemption response * @description A response to an exemption request by a delegated bypasser. @@ -31239,11 +31407,13 @@ export interface components { request_type?: | "push_ruleset_bypass" | "secret_scanning" - | "secret_scanning_closure"; + | "secret_scanning_closure" + | "code_scanning_alert_dismissal"; exemption_request_data?: | components["schemas"]["exemption-request-push-ruleset-bypass"] | components["schemas"]["exemption-request-secret-scanning"] - | components["schemas"]["dismissal-request-secret-scanning"]; + | components["schemas"]["dismissal-request-secret-scanning"] + | components["schemas"]["dismissal-request-code-scanning"]; /** * @description The unique identifier for the request type of the exemption request. For example, a commit SHA. * @example 827efc6d56897b048c772eb4087f854f46256132 @@ -31258,8 +31428,11 @@ export interface components { requester_comment?: string | null; /** @description Metadata about the exemption request. */ metadata?: - | components["schemas"]["exemption-request-secret-scanning-metadata"] - | components["schemas"]["dismissal-request-secret-scanning-metadata"] + | ( + | components["schemas"]["exemption-request-secret-scanning-metadata"] + | components["schemas"]["dismissal-request-secret-scanning-metadata"] + | components["schemas"]["dismissal-request-code-scanning-metadata"] + ) | null; /** * Format: date-time @@ -32450,6 +32623,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -33003,6 +33177,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -42304,6 +42479,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -42907,6 +43083,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -43514,6 +43691,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -44137,6 +44315,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -44689,6 +44868,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -45178,6 +45358,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -45681,6 +45862,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -46174,6 +46356,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -46669,6 +46852,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -47161,6 +47345,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -48386,6 +48571,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -48934,6 +49120,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -49378,6 +49565,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -50151,6 +50339,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -86168,6 +86357,8 @@ export interface components { "api-insights-actor-name-substring"?: string; /** @description The unique identifier of the invitation. */ "invitation-id": number; + /** @description The unique identifier of the issue type. */ + "issue-type-id": number; /** @description The name of the codespace. */ "codespace-name": string; /** @description The unique identifier of the migration. */ @@ -86205,6 +86396,8 @@ export interface components { "personal-access-token-before"?: string; /** @description 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`. */ "personal-access-token-after"?: string; + /** @description The ID of the token */ + "personal-access-token-token-id"?: string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @@ -90325,6 +90518,10 @@ export interface operations { * * Creates new or updates existing custom properties defined for an enterprise 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 an administrator for the enterprise. */ "enterprise-admin/create-or-update-enterprise-custom-properties": { @@ -98011,6 +98208,105 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * List issue types for an organization + * @description Lists all issue types for an organization. + */ + "orgs/list-issue-types": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["issue-type"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create issue type for an organization + * @description 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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + */ + "orgs/create-issue-type": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-create-issue-type"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["issue-type"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + /** + * Update issue type for an organization + * @description 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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + */ + "orgs/update-issue-type": { + parameters: { + path: { + org: components["parameters"]["org"]; + issue_type_id: components["parameters"]["issue-type-id"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-update-issue-type"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["issue-type"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + /** + * Delete issue type for an organization + * @description 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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + */ + "orgs/delete-issue-type": { + parameters: { + path: { + org: components["parameters"]["org"]; + issue_type_id: components["parameters"]["issue-type-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; /** * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. @@ -98039,6 +98335,8 @@ export interface operations { /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; direction?: components["parameters"]["direction"]; @@ -99359,6 +99657,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -99501,6 +99800,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -99941,6 +100241,10 @@ export interface operations { * Create or update custom properties for an organization * @description 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. @@ -109155,7 +109459,7 @@ export interface operations { * @description 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/enterprise-cloud@latest//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. */ "codespaces/create-or-update-repo-secret": { parameters: { @@ -109192,7 +109496,7 @@ export interface operations { * Delete a repository secret * @description 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. */ "codespaces/delete-repo-secret": { parameters: { @@ -111459,7 +111763,7 @@ export interface operations { * * 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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest//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. */ @@ -113452,6 +113756,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @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. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -113529,6 +113835,11 @@ export interface operations { >[]; /** @description 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._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. + * @example Epic + */ + type?: string | null; }; }; }; @@ -113933,6 +114244,11 @@ export interface operations { >[]; /** @description 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. */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. + * @example Epic + */ + type?: string | null; }; }; }; @@ -120240,6 +120556,7 @@ export interface operations { * @deprecated * @description > [!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/). */ "search/issues-and-pull-requests": { parameters: { diff --git a/packages/openapi-types-ghes-3.12/package.json b/packages/openapi-types-ghes-3.12/package.json index 66cc5e90..b0054e14 100644 --- a/packages/openapi-types-ghes-3.12/package.json +++ b/packages/openapi-types-ghes-3.12/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "18.1.0" + "openapi-version": "18.2.0" } } diff --git a/packages/openapi-types-ghes-3.12/types.d.ts b/packages/openapi-types-ghes-3.12/types.d.ts index cb29e4b4..b50c0884 100644 --- a/packages/openapi-types-ghes-3.12/types.d.ts +++ b/packages/openapi-types-ghes-3.12/types.d.ts @@ -5774,7 +5774,7 @@ export interface paths { * * 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/enterprise-server@3.12/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/enterprise-server@3.12/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.12/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. */ @@ -9796,7 +9796,7 @@ export interface components { */ contents?: "read" | "write"; /** - * @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. * @enum {string} */ dependabot_secrets?: "read" | "write"; @@ -10488,6 +10488,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -10534,11 +10535,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -11495,12 +11498,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -12381,6 +12384,46 @@ export interface components { */ due_on: string | null; } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -12601,6 +12644,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -21046,6 +21090,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -23603,6 +23648,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; }; @@ -26128,6 +26174,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -26681,6 +26728,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -35737,6 +35785,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -36340,6 +36389,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -36947,6 +36997,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -37570,6 +37621,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -38122,6 +38174,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -38611,6 +38664,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -39114,6 +39168,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -39607,6 +39662,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -40102,6 +40158,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -40594,6 +40651,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -41815,6 +41873,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -42363,6 +42422,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -42807,6 +42867,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -43576,6 +43637,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -76552,6 +76614,8 @@ export interface components { "personal-access-token-before"?: string; /** @description 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`. */ "personal-access-token-after"?: string; + /** @description The ID of the token */ + "personal-access-token-token-id"?: string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @@ -85395,6 +85459,8 @@ export interface operations { /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; direction?: components["parameters"]["direction"]; @@ -86154,6 +86220,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -86296,6 +86363,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -96154,7 +96222,7 @@ export interface operations { * * 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/enterprise-server@3.12/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/enterprise-server@3.12/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.12/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. */ @@ -97753,6 +97821,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @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. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -97830,6 +97900,11 @@ export interface operations { >[]; /** @description 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._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. + * @example Epic + */ + type?: string | null; }; }; }; @@ -98234,6 +98309,11 @@ export interface operations { >[]; /** @description 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. */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. + * @example Epic + */ + type?: string | null; }; }; }; diff --git a/packages/openapi-types-ghes-3.13/package.json b/packages/openapi-types-ghes-3.13/package.json index 6924333d..2868bc5e 100644 --- a/packages/openapi-types-ghes-3.13/package.json +++ b/packages/openapi-types-ghes-3.13/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "18.1.0" + "openapi-version": "18.2.0" } } diff --git a/packages/openapi-types-ghes-3.13/types.d.ts b/packages/openapi-types-ghes-3.13/types.d.ts index b3908bb4..98c615e7 100644 --- a/packages/openapi-types-ghes-3.13/types.d.ts +++ b/packages/openapi-types-ghes-3.13/types.d.ts @@ -2919,6 +2919,10 @@ export interface paths { * Create or update custom properties for an organization * @description 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. @@ -5844,7 +5848,7 @@ export interface paths { * * 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/enterprise-server@3.13/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/enterprise-server@3.13/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.13/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. */ @@ -9900,7 +9904,7 @@ export interface components { */ contents?: "read" | "write"; /** - * @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. * @enum {string} */ dependabot_secrets?: "read" | "write"; @@ -10597,6 +10601,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -10643,11 +10648,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -11604,12 +11611,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -12495,6 +12502,46 @@ export interface components { */ due_on: string | null; } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -12715,6 +12762,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -15239,6 +15287,12 @@ export interface components { * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; /** * Custom Property Value @@ -21278,6 +21332,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -23856,6 +23911,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; }; @@ -26385,6 +26441,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -26938,6 +26995,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -35998,6 +36056,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -36601,6 +36660,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -37208,6 +37268,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -37831,6 +37892,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -38383,6 +38445,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -38872,6 +38935,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -39375,6 +39439,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -39868,6 +39933,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -40363,6 +40429,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -40855,6 +40922,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -42080,6 +42148,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -42628,6 +42697,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -43072,6 +43142,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -43845,6 +43916,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -76859,6 +76931,8 @@ export interface components { "personal-access-token-before"?: string; /** @description 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`. */ "personal-access-token-after"?: string; + /** @description The ID of the token */ + "personal-access-token-token-id"?: string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description The custom property name */ @@ -85728,6 +85802,8 @@ export interface operations { /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; direction?: components["parameters"]["direction"]; @@ -86487,6 +86563,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -86629,6 +86706,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -86930,6 +87008,10 @@ export interface operations { * Create or update custom properties for an organization * @description 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. @@ -96686,7 +96768,7 @@ export interface operations { * * 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/enterprise-server@3.13/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/enterprise-server@3.13/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.13/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. */ @@ -98285,6 +98367,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @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. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -98362,6 +98446,11 @@ export interface operations { >[]; /** @description 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._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. + * @example Epic + */ + type?: string | null; }; }; }; @@ -98766,6 +98855,11 @@ export interface operations { >[]; /** @description 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. */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. + * @example Epic + */ + type?: string | null; }; }; }; diff --git a/packages/openapi-types-ghes-3.14/package.json b/packages/openapi-types-ghes-3.14/package.json index 84412c4a..38bff7d3 100644 --- a/packages/openapi-types-ghes-3.14/package.json +++ b/packages/openapi-types-ghes-3.14/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "18.1.0" + "openapi-version": "18.2.0" } } diff --git a/packages/openapi-types-ghes-3.14/types.d.ts b/packages/openapi-types-ghes-3.14/types.d.ts index cc4f4556..1e30b6e7 100644 --- a/packages/openapi-types-ghes-3.14/types.d.ts +++ b/packages/openapi-types-ghes-3.14/types.d.ts @@ -3090,6 +3090,10 @@ export interface paths { * Create or update custom properties for an organization * @description 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. @@ -6019,7 +6023,7 @@ export interface paths { * * 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/enterprise-server@3.14/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/enterprise-server@3.14/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.14/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. */ @@ -10059,7 +10063,7 @@ export interface components { */ contents?: "read" | "write"; /** - * @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. * @enum {string} */ dependabot_secrets?: "read" | "write"; @@ -10756,6 +10760,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -10802,11 +10807,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -11763,12 +11770,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -12654,6 +12661,46 @@ export interface components { */ due_on: string | null; } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -12874,6 +12921,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -15721,6 +15769,12 @@ export interface components { * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; /** * Custom Property Value @@ -21671,6 +21725,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -24289,6 +24344,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; }; @@ -25714,6 +25770,22 @@ export interface components { alert_number?: string; }[]; }; + /** + * Code scanning alert dismissal request data + * @description Code scanning alerts that have dismissal requests. + */ + "dismissal-request-code-scanning": { + /** + * @description The type of request + * @enum {string} + */ + type?: "code_scanning_alert_dismissal"; + /** @description The data related to the code scanning alerts that have dismissal requests. */ + data?: { + /** @description The number of the alert to be dismissed */ + alert_number?: string; + }[]; + }; /** * Secret Scanning Push Protection Exemption Request Metadata * @description Metadata for a secret scanning push protection exemption request. @@ -25740,6 +25812,19 @@ export interface components { */ reason?: "fixed_later" | "false_positive" | "tests" | "revoked"; }; + /** + * Code scanning alert dismissal request metadata + * @description Metadata for a code scanning alert dismissal request. + */ + "dismissal-request-code-scanning-metadata": { + /** @description The title of the code scanning alert */ + alert_title?: string; + /** + * @description The reason for the dismissal request + * @enum {string} + */ + reason?: "false positive" | "won't fix" | "used in tests"; + }; /** * Exemption response * @description A response to an exemption request by a delegated bypasser. @@ -25786,11 +25871,13 @@ export interface components { request_type?: | "push_ruleset_bypass" | "secret_scanning" - | "secret_scanning_closure"; + | "secret_scanning_closure" + | "code_scanning_alert_dismissal"; exemption_request_data?: | components["schemas"]["exemption-request-push-ruleset-bypass"] | components["schemas"]["exemption-request-secret-scanning"] - | components["schemas"]["dismissal-request-secret-scanning"]; + | components["schemas"]["dismissal-request-secret-scanning"] + | components["schemas"]["dismissal-request-code-scanning"]; /** * @description The unique identifier for the request type of the exemption request. For example, a commit SHA. * @example 827efc6d56897b048c772eb4087f854f46256132 @@ -25805,8 +25892,11 @@ export interface components { requester_comment?: string | null; /** @description Metadata about the exemption request. */ metadata?: - | components["schemas"]["exemption-request-secret-scanning-metadata"] - | components["schemas"]["dismissal-request-secret-scanning-metadata"] + | ( + | components["schemas"]["exemption-request-secret-scanning-metadata"] + | components["schemas"]["dismissal-request-secret-scanning-metadata"] + | components["schemas"]["dismissal-request-code-scanning-metadata"] + ) | null; /** * Format: date-time @@ -26996,6 +27086,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -27549,6 +27640,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -36691,6 +36783,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -37294,6 +37387,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -37901,6 +37995,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -38524,6 +38619,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -39076,6 +39172,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -39565,6 +39662,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -40068,6 +40166,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -40561,6 +40660,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -41056,6 +41156,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -41548,6 +41649,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -42773,6 +42875,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -43321,6 +43424,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -43765,6 +43869,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -44538,6 +44643,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -77578,6 +77684,8 @@ export interface components { "personal-access-token-before"?: string; /** @description 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`. */ "personal-access-token-after"?: string; + /** @description The ID of the token */ + "personal-access-token-token-id"?: string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description The custom property name */ @@ -86468,6 +86576,8 @@ export interface operations { /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; direction?: components["parameters"]["direction"]; @@ -87645,6 +87755,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -87787,6 +87898,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -88088,6 +88200,10 @@ export interface operations { * Create or update custom properties for an organization * @description 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. @@ -97844,7 +97960,7 @@ export interface operations { * * 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/enterprise-server@3.14/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/enterprise-server@3.14/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.14/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. */ @@ -99443,6 +99559,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @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. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -99520,6 +99638,11 @@ export interface operations { >[]; /** @description 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._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. + * @example Epic + */ + type?: string | null; }; }; }; @@ -99924,6 +100047,11 @@ export interface operations { >[]; /** @description 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. */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. + * @example Epic + */ + type?: string | null; }; }; }; diff --git a/packages/openapi-types-ghes-3.15/package.json b/packages/openapi-types-ghes-3.15/package.json index 44ba61be..68935b1c 100644 --- a/packages/openapi-types-ghes-3.15/package.json +++ b/packages/openapi-types-ghes-3.15/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "18.1.0" + "openapi-version": "18.2.0" } } diff --git a/packages/openapi-types-ghes-3.15/types.d.ts b/packages/openapi-types-ghes-3.15/types.d.ts index 0fc83077..1e298191 100644 --- a/packages/openapi-types-ghes-3.15/types.d.ts +++ b/packages/openapi-types-ghes-3.15/types.d.ts @@ -3211,12 +3211,18 @@ export interface paths { "/orgs/{org}/projects": { /** * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-for-org"]; /** * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ post: operations["projects/create-for-org"]; }; @@ -3231,6 +3237,10 @@ export interface paths { * Create or update custom properties for an organization * @description 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. @@ -3750,36 +3760,36 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/projects": { /** * List team projects - * @description Lists the organization projects for a team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["teams/list-projects-in-org"]; }; "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { /** * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions - * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ put: operations["teams/add-or-update-project-permissions-in-org"]; /** * Remove a project from a team - * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["teams/remove-project-in-org"]; }; @@ -3855,100 +3865,172 @@ export interface paths { "/projects/columns/cards/{card_id}": { /** * Get a project card - * @description Gets information about a project card. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/get-card"]; /** * Delete a project card - * @description Deletes a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["projects/delete-card"]; - /** Update an existing project card */ + /** + * Update an existing project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ patch: operations["projects/update-card"]; }; "/projects/columns/cards/{card_id}/moves": { - /** Move a project card */ + /** + * Move a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ post: operations["projects/move-card"]; }; "/projects/columns/{column_id}": { /** * Get a project column - * @description Gets information about a project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/get-column"]; /** * Delete a project column - * @description Deletes a project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["projects/delete-column"]; - /** Update an existing project column */ + /** + * Update an existing project column + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ patch: operations["projects/update-column"]; }; "/projects/columns/{column_id}/cards": { /** * List project cards - * @description Lists the project cards in a project. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-cards"]; - /** Create a project card */ + /** + * Create a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ post: operations["projects/create-card"]; }; "/projects/columns/{column_id}/moves": { - /** Move a project column */ + /** + * Move a project column + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ post: operations["projects/move-column"]; }; "/projects/{project_id}": { /** * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/get"]; /** * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["projects/delete"]; /** * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ patch: operations["projects/update"]; }; "/projects/{project_id}/collaborators": { /** * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-collaborators"]; }; "/projects/{project_id}/collaborators/{username}": { /** * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ put: operations["projects/add-collaborator"]; /** * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["projects/remove-collaborator"]; }; "/projects/{project_id}/collaborators/{username}/permission": { /** * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/get-permission-for-user"]; }; "/projects/{project_id}/columns": { /** * List project columns - * @description Lists the project columns in a project. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-columns"]; /** * Create a project column - * @description Creates a new project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ post: operations["projects/create-column"]; }; @@ -6171,7 +6253,7 @@ export interface paths { * * 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/enterprise-server@3.15/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/enterprise-server@3.15/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.15/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. */ @@ -7223,12 +7305,18 @@ export interface paths { "/repos/{owner}/{repo}/projects": { /** * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-for-repo"]; /** * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ post: operations["projects/create-for-repo"]; }; @@ -8704,9 +8792,8 @@ export interface paths { * List team projects (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["teams/list-projects-legacy"]; }; @@ -8715,27 +8802,24 @@ export interface paths { * Check team permissions for a project (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["teams/check-permissions-for-project-legacy"]; /** * Add or update team project permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ put: operations["teams/add-or-update-project-permissions-legacy"]; /** * Remove a project from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-project-from-a-team) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["teams/remove-project-legacy"]; }; @@ -9139,7 +9223,10 @@ export interface paths { "/user/projects": { /** * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ post: operations["projects/create-for-authenticated-user"]; }; @@ -9506,7 +9593,10 @@ export interface paths { "/users/{username}/projects": { /** * List user projects - * @description Lists projects for a user. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-for-user"]; }; @@ -10123,7 +10213,7 @@ export interface components { */ contents?: "read" | "write"; /** - * @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. * @enum {string} */ dependabot_secrets?: "read" | "write"; @@ -10827,6 +10917,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -10873,11 +10964,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -11834,12 +11927,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -12730,6 +12823,46 @@ export interface components { */ due_on: string | null; } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -12952,6 +13085,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -15938,6 +16072,12 @@ export interface components { * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; /** * Custom Property Value @@ -21936,6 +22076,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -24574,6 +24715,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; }; @@ -25849,6 +25991,22 @@ export interface components { alert_number?: string; }[]; }; + /** + * Code scanning alert dismissal request data + * @description Code scanning alerts that have dismissal requests. + */ + "dismissal-request-code-scanning": { + /** + * @description The type of request + * @enum {string} + */ + type?: "code_scanning_alert_dismissal"; + /** @description The data related to the code scanning alerts that have dismissal requests. */ + data?: { + /** @description The number of the alert to be dismissed */ + alert_number?: string; + }[]; + }; /** * Secret Scanning Push Protection Exemption Request Metadata * @description Metadata for a secret scanning push protection exemption request. @@ -25875,6 +26033,19 @@ export interface components { */ reason?: "fixed_later" | "false_positive" | "tests" | "revoked"; }; + /** + * Code scanning alert dismissal request metadata + * @description Metadata for a code scanning alert dismissal request. + */ + "dismissal-request-code-scanning-metadata": { + /** @description The title of the code scanning alert */ + alert_title?: string; + /** + * @description The reason for the dismissal request + * @enum {string} + */ + reason?: "false positive" | "won't fix" | "used in tests"; + }; /** * Exemption response * @description A response to an exemption request by a delegated bypasser. @@ -25921,11 +26092,13 @@ export interface components { request_type?: | "push_ruleset_bypass" | "secret_scanning" - | "secret_scanning_closure"; + | "secret_scanning_closure" + | "code_scanning_alert_dismissal"; exemption_request_data?: | components["schemas"]["exemption-request-push-ruleset-bypass"] | components["schemas"]["exemption-request-secret-scanning"] - | components["schemas"]["dismissal-request-secret-scanning"]; + | components["schemas"]["dismissal-request-secret-scanning"] + | components["schemas"]["dismissal-request-code-scanning"]; /** * @description The unique identifier for the request type of the exemption request. For example, a commit SHA. * @example 827efc6d56897b048c772eb4087f854f46256132 @@ -25940,8 +26113,11 @@ export interface components { requester_comment?: string | null; /** @description Metadata about the exemption request. */ metadata?: - | components["schemas"]["exemption-request-secret-scanning-metadata"] - | components["schemas"]["dismissal-request-secret-scanning-metadata"] + | ( + | components["schemas"]["exemption-request-secret-scanning-metadata"] + | components["schemas"]["dismissal-request-secret-scanning-metadata"] + | components["schemas"]["dismissal-request-code-scanning-metadata"] + ) | null; /** * Format: date-time @@ -27131,6 +27307,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -27684,6 +27861,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -36833,6 +37011,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -37436,6 +37615,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -38043,6 +38223,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -38666,6 +38847,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -39218,6 +39400,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -39707,6 +39890,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -40210,6 +40394,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -40703,6 +40888,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -41198,6 +41384,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -41690,6 +41877,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -42915,6 +43103,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -43463,6 +43652,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -43907,6 +44097,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -44680,6 +44871,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -77723,6 +77915,8 @@ export interface components { "personal-access-token-before"?: string; /** @description 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`. */ "personal-access-token-after"?: string; + /** @description The ID of the token */ + "personal-access-token-token-id"?: string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description The custom property name */ @@ -87141,6 +87335,8 @@ export interface operations { /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; direction?: components["parameters"]["direction"]; @@ -88332,6 +88528,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -88474,6 +88671,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -88688,7 +88886,10 @@ export interface operations { }; /** * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-for-org": { parameters: { @@ -88717,7 +88918,10 @@ export interface operations { }; /** * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/create-for-org": { parameters: { @@ -88775,6 +88979,10 @@ export interface operations { * Create or update custom properties for an organization * @description 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. @@ -90618,10 +90826,10 @@ export interface operations { }; /** * List team projects - * @description Lists the organization projects for a team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/list-projects-in-org": { parameters: { @@ -90648,10 +90856,10 @@ export interface operations { }; /** * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/check-permissions-for-project-in-org": { parameters: { @@ -90676,10 +90884,10 @@ export interface operations { }; /** * Add or update team project permissions - * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/add-or-update-project-permissions-in-org": { parameters: { @@ -90718,10 +90926,10 @@ export interface operations { }; /** * Remove a project from a team - * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/remove-project-in-org": { parameters: { @@ -90938,7 +91146,10 @@ export interface operations { }; /** * Get a project card - * @description Gets information about a project card. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/get-card": { parameters: { @@ -90961,7 +91172,10 @@ export interface operations { }; /** * Delete a project card - * @description Deletes a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/delete-card": { parameters: { @@ -90989,7 +91203,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Update an existing project card */ + /** + * Update an existing project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ "projects/update-card": { parameters: { path: { @@ -91026,7 +91246,13 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** Move a project card */ + /** + * Move a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ "projects/move-card": { parameters: { path: { @@ -91092,7 +91318,10 @@ export interface operations { }; /** * Get a project column - * @description Gets information about a project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/get-column": { parameters: { @@ -91115,7 +91344,10 @@ export interface operations { }; /** * Delete a project column - * @description Deletes a project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/delete-column": { parameters: { @@ -91133,7 +91365,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Update an existing project column */ + /** + * Update an existing project column + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ "projects/update-column": { parameters: { path: { @@ -91165,7 +91403,10 @@ export interface operations { }; /** * List project cards - * @description Lists the project cards in a project. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-cards": { parameters: { @@ -91194,7 +91435,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Create a project card */ + /** + * Create a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ "projects/create-card": { parameters: { path: { @@ -91262,7 +91509,13 @@ export interface operations { }; }; }; - /** Move a project column */ + /** + * Move a project column + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ "projects/move-column": { parameters: { path: { @@ -91295,7 +91548,10 @@ export interface operations { }; /** * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/get": { parameters: { @@ -91317,7 +91573,10 @@ export interface operations { }; /** * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/delete": { parameters: { @@ -91348,7 +91607,10 @@ export interface operations { }; /** * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/update": { parameters: { @@ -91413,7 +91675,10 @@ export interface operations { }; /** * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-collaborators": { parameters: { @@ -91446,7 +91711,10 @@ export interface operations { }; /** * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/add-collaborator": { parameters: { @@ -91482,7 +91750,10 @@ export interface operations { }; /** * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/remove-collaborator": { parameters: { @@ -91505,7 +91776,10 @@ export interface operations { }; /** * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/get-permission-for-user": { parameters: { @@ -91530,7 +91804,10 @@ export interface operations { }; /** * List project columns - * @description Lists the project columns in a project. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-columns": { parameters: { @@ -91559,7 +91836,10 @@ export interface operations { }; /** * Create a project column - * @description Creates a new project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/create-column": { parameters: { @@ -98564,7 +98844,7 @@ export interface operations { * * 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/enterprise-server@3.15/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/enterprise-server@3.15/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.15/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. */ @@ -100163,6 +100443,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @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. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -100240,6 +100522,11 @@ export interface operations { >[]; /** @description 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._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. + * @example Epic + */ + type?: string | null; }; }; }; @@ -100644,6 +100931,11 @@ export interface operations { >[]; /** @description 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. */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. + * @example Epic + */ + type?: string | null; }; }; }; @@ -102340,7 +102632,10 @@ export interface operations { }; /** * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-for-repo": { parameters: { @@ -102374,7 +102669,10 @@ export interface operations { }; /** * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/create-for-repo": { parameters: { @@ -107109,9 +107407,8 @@ export interface operations { * List team projects (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/list-projects-legacy": { parameters: { @@ -107140,9 +107437,8 @@ export interface operations { * Check team permissions for a project (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/check-permissions-for-project-legacy": { parameters: { @@ -107168,9 +107464,8 @@ export interface operations { * Add or update team project permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/add-or-update-project-permissions-legacy": { parameters: { @@ -107212,9 +107507,8 @@ export interface operations { * Remove a project from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-project-from-a-team) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/remove-project-legacy": { parameters: { @@ -108571,7 +108865,10 @@ export interface operations { }; /** * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/create-for-authenticated-user": { requestBody: { @@ -109908,7 +110205,10 @@ export interface operations { }; /** * List user projects - * @description Lists projects for a user. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-for-user": { parameters: { diff --git a/packages/openapi-types-ghes-3.16/package.json b/packages/openapi-types-ghes-3.16/package.json index 89c84035..3f887cad 100644 --- a/packages/openapi-types-ghes-3.16/package.json +++ b/packages/openapi-types-ghes-3.16/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "18.1.0" + "openapi-version": "18.2.0" } } diff --git a/packages/openapi-types-ghes-3.16/types.d.ts b/packages/openapi-types-ghes-3.16/types.d.ts index 090f7cf8..0be5a6bd 100644 --- a/packages/openapi-types-ghes-3.16/types.d.ts +++ b/packages/openapi-types-ghes-3.16/types.d.ts @@ -3448,12 +3448,18 @@ export interface paths { "/orgs/{org}/projects": { /** * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-for-org"]; /** * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ post: operations["projects/create-for-org"]; }; @@ -3468,6 +3474,10 @@ export interface paths { * Create or update custom properties for an organization * @description 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. @@ -3981,36 +3991,36 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/projects": { /** * List team projects - * @description Lists the organization projects for a team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["teams/list-projects-in-org"]; }; "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { /** * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions - * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ put: operations["teams/add-or-update-project-permissions-in-org"]; /** * Remove a project from a team - * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["teams/remove-project-in-org"]; }; @@ -4086,100 +4096,172 @@ export interface paths { "/projects/columns/cards/{card_id}": { /** * Get a project card - * @description Gets information about a project card. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/get-card"]; /** * Delete a project card - * @description Deletes a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["projects/delete-card"]; - /** Update an existing project card */ + /** + * Update an existing project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ patch: operations["projects/update-card"]; }; "/projects/columns/cards/{card_id}/moves": { - /** Move a project card */ + /** + * Move a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ post: operations["projects/move-card"]; }; "/projects/columns/{column_id}": { /** * Get a project column - * @description Gets information about a project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/get-column"]; /** * Delete a project column - * @description Deletes a project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["projects/delete-column"]; - /** Update an existing project column */ + /** + * Update an existing project column + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ patch: operations["projects/update-column"]; }; "/projects/columns/{column_id}/cards": { /** * List project cards - * @description Lists the project cards in a project. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-cards"]; - /** Create a project card */ + /** + * Create a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ post: operations["projects/create-card"]; }; "/projects/columns/{column_id}/moves": { - /** Move a project column */ + /** + * Move a project column + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ post: operations["projects/move-column"]; }; "/projects/{project_id}": { /** * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/get"]; /** * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["projects/delete"]; /** * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ patch: operations["projects/update"]; }; "/projects/{project_id}/collaborators": { /** * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-collaborators"]; }; "/projects/{project_id}/collaborators/{username}": { /** * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ put: operations["projects/add-collaborator"]; /** * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["projects/remove-collaborator"]; }; "/projects/{project_id}/collaborators/{username}/permission": { /** * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/get-permission-for-user"]; }; "/projects/{project_id}/columns": { /** * List project columns - * @description Lists the project columns in a project. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-columns"]; /** * Create a project column - * @description Creates a new project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ post: operations["projects/create-column"]; }; @@ -6402,7 +6484,7 @@ export interface paths { * * 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/enterprise-server@3.16/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/enterprise-server@3.16/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.16/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. */ @@ -7454,12 +7536,18 @@ export interface paths { "/repos/{owner}/{repo}/projects": { /** * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-for-repo"]; /** * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ post: operations["projects/create-for-repo"]; }; @@ -8944,9 +9032,8 @@ export interface paths { * List team projects (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["teams/list-projects-legacy"]; }; @@ -8955,27 +9042,24 @@ export interface paths { * Check team permissions for a project (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#check-team-permissions-for-a-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["teams/check-permissions-for-project-legacy"]; /** * Add or update team project permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#add-or-update-team-project-permissions) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ put: operations["teams/add-or-update-project-permissions-legacy"]; /** * Remove a project from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#remove-a-project-from-a-team) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ delete: operations["teams/remove-project-legacy"]; }; @@ -9379,7 +9463,10 @@ export interface paths { "/user/projects": { /** * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ post: operations["projects/create-for-authenticated-user"]; }; @@ -9746,7 +9833,10 @@ export interface paths { "/users/{username}/projects": { /** * List user projects - * @description Lists projects for a user. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ get: operations["projects/list-for-user"]; }; @@ -10364,7 +10454,7 @@ export interface components { */ contents?: "read" | "write"; /** - * @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. * @enum {string} */ dependabot_secrets?: "read" | "write"; @@ -11073,6 +11163,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -11119,11 +11210,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -12080,12 +12173,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -13300,6 +13393,46 @@ export interface components { */ due_on: string | null; } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -13522,6 +13655,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -16454,6 +16588,12 @@ export interface components { * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; /** * Custom Property Value @@ -22515,6 +22655,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -25194,6 +25335,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; }; @@ -26469,6 +26611,22 @@ export interface components { alert_number?: string; }[]; }; + /** + * Code scanning alert dismissal request data + * @description Code scanning alerts that have dismissal requests. + */ + "dismissal-request-code-scanning": { + /** + * @description The type of request + * @enum {string} + */ + type?: "code_scanning_alert_dismissal"; + /** @description The data related to the code scanning alerts that have dismissal requests. */ + data?: { + /** @description The number of the alert to be dismissed */ + alert_number?: string; + }[]; + }; /** * Secret Scanning Push Protection Exemption Request Metadata * @description Metadata for a secret scanning push protection exemption request. @@ -26495,6 +26653,19 @@ export interface components { */ reason?: "fixed_later" | "false_positive" | "tests" | "revoked"; }; + /** + * Code scanning alert dismissal request metadata + * @description Metadata for a code scanning alert dismissal request. + */ + "dismissal-request-code-scanning-metadata": { + /** @description The title of the code scanning alert */ + alert_title?: string; + /** + * @description The reason for the dismissal request + * @enum {string} + */ + reason?: "false positive" | "won't fix" | "used in tests"; + }; /** * Exemption response * @description A response to an exemption request by a delegated bypasser. @@ -26541,11 +26712,13 @@ export interface components { request_type?: | "push_ruleset_bypass" | "secret_scanning" - | "secret_scanning_closure"; + | "secret_scanning_closure" + | "code_scanning_alert_dismissal"; exemption_request_data?: | components["schemas"]["exemption-request-push-ruleset-bypass"] | components["schemas"]["exemption-request-secret-scanning"] - | components["schemas"]["dismissal-request-secret-scanning"]; + | components["schemas"]["dismissal-request-secret-scanning"] + | components["schemas"]["dismissal-request-code-scanning"]; /** * @description The unique identifier for the request type of the exemption request. For example, a commit SHA. * @example 827efc6d56897b048c772eb4087f854f46256132 @@ -26560,8 +26733,11 @@ export interface components { requester_comment?: string | null; /** @description Metadata about the exemption request. */ metadata?: - | components["schemas"]["exemption-request-secret-scanning-metadata"] - | components["schemas"]["dismissal-request-secret-scanning-metadata"] + | ( + | components["schemas"]["exemption-request-secret-scanning-metadata"] + | components["schemas"]["dismissal-request-secret-scanning-metadata"] + | components["schemas"]["dismissal-request-code-scanning-metadata"] + ) | null; /** * Format: date-time @@ -27752,6 +27928,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -28305,6 +28482,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -37466,6 +37644,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -38069,6 +38248,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -38676,6 +38856,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -39299,6 +39480,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -39851,6 +40033,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -40340,6 +40523,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -40843,6 +41027,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -41336,6 +41521,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -41831,6 +42017,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -42323,6 +42510,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -43548,6 +43736,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -44096,6 +44285,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -44540,6 +44730,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -45313,6 +45504,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -78415,6 +78607,8 @@ export interface components { "personal-access-token-before"?: string; /** @description 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`. */ "personal-access-token-after"?: string; + /** @description The ID of the token */ + "personal-access-token-token-id"?: string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description The custom property name */ @@ -88495,6 +88689,8 @@ export interface operations { /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; direction?: components["parameters"]["direction"]; @@ -89686,6 +89882,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -89828,6 +90025,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -90268,7 +90466,10 @@ export interface operations { }; /** * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-for-org": { parameters: { @@ -90297,7 +90498,10 @@ export interface operations { }; /** * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/create-for-org": { parameters: { @@ -90355,6 +90559,10 @@ export interface operations { * Create or update custom properties for an organization * @description 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. @@ -92194,10 +92402,10 @@ export interface operations { }; /** * List team projects - * @description Lists the organization projects for a team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/list-projects-in-org": { parameters: { @@ -92224,10 +92432,10 @@ export interface operations { }; /** * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/check-permissions-for-project-in-org": { parameters: { @@ -92252,10 +92460,10 @@ export interface operations { }; /** * Add or update team project permissions - * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/add-or-update-project-permissions-in-org": { parameters: { @@ -92294,10 +92502,10 @@ export interface operations { }; /** * Remove a project from a team - * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/remove-project-in-org": { parameters: { @@ -92514,7 +92722,10 @@ export interface operations { }; /** * Get a project card - * @description Gets information about a project card. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/get-card": { parameters: { @@ -92537,7 +92748,10 @@ export interface operations { }; /** * Delete a project card - * @description Deletes a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/delete-card": { parameters: { @@ -92565,7 +92779,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Update an existing project card */ + /** + * Update an existing project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ "projects/update-card": { parameters: { path: { @@ -92602,7 +92822,13 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** Move a project card */ + /** + * Move a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ "projects/move-card": { parameters: { path: { @@ -92668,7 +92894,10 @@ export interface operations { }; /** * Get a project column - * @description Gets information about a project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/get-column": { parameters: { @@ -92691,7 +92920,10 @@ export interface operations { }; /** * Delete a project column - * @description Deletes a project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/delete-column": { parameters: { @@ -92709,7 +92941,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Update an existing project column */ + /** + * Update an existing project column + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ "projects/update-column": { parameters: { path: { @@ -92741,7 +92979,10 @@ export interface operations { }; /** * List project cards - * @description Lists the project cards in a project. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-cards": { parameters: { @@ -92770,7 +93011,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Create a project card */ + /** + * Create a project card + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ "projects/create-card": { parameters: { path: { @@ -92838,7 +93085,13 @@ export interface operations { }; }; }; - /** Move a project column */ + /** + * Move a project column + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. + */ "projects/move-column": { parameters: { path: { @@ -92871,7 +93124,10 @@ export interface operations { }; /** * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/get": { parameters: { @@ -92893,7 +93149,10 @@ export interface operations { }; /** * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/delete": { parameters: { @@ -92924,7 +93183,10 @@ export interface operations { }; /** * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/update": { parameters: { @@ -92989,7 +93251,10 @@ export interface operations { }; /** * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-collaborators": { parameters: { @@ -93022,7 +93287,10 @@ export interface operations { }; /** * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/add-collaborator": { parameters: { @@ -93058,7 +93326,10 @@ export interface operations { }; /** * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/remove-collaborator": { parameters: { @@ -93081,7 +93352,10 @@ export interface operations { }; /** * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/get-permission-for-user": { parameters: { @@ -93106,7 +93380,10 @@ export interface operations { }; /** * List project columns - * @description Lists the project columns in a project. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-columns": { parameters: { @@ -93135,7 +93412,10 @@ export interface operations { }; /** * Create a project column - * @description Creates a new project column. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/create-column": { parameters: { @@ -100160,7 +100440,7 @@ export interface operations { * * 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/enterprise-server@3.16/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/enterprise-server@3.16/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.16/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. */ @@ -101759,6 +102039,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @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. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -101836,6 +102118,11 @@ export interface operations { >[]; /** @description 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._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. + * @example Epic + */ + type?: string | null; }; }; }; @@ -102240,6 +102527,11 @@ export interface operations { >[]; /** @description 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. */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. + * @example Epic + */ + type?: string | null; }; }; }; @@ -103936,7 +104228,10 @@ export interface operations { }; /** * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-for-repo": { parameters: { @@ -103970,7 +104265,10 @@ export interface operations { }; /** * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/create-for-repo": { parameters: { @@ -108734,9 +109032,8 @@ export interface operations { * List team projects (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/list-projects-legacy": { parameters: { @@ -108765,9 +109062,8 @@ export interface operations { * Check team permissions for a project (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#check-team-permissions-for-a-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/check-permissions-for-project-legacy": { parameters: { @@ -108793,9 +109089,8 @@ export interface operations { * Add or update team project permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#add-or-update-team-project-permissions) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/add-or-update-project-permissions-legacy": { parameters: { @@ -108837,9 +109132,8 @@ export interface operations { * Remove a project from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.16/rest/teams/teams#remove-a-project-from-a-team) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "teams/remove-project-legacy": { parameters: { @@ -110196,7 +110490,10 @@ export interface operations { }; /** * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/create-for-authenticated-user": { requestBody: { @@ -111533,7 +111830,10 @@ export interface operations { }; /** * List user projects - * @description Lists projects for a user. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. + * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. */ "projects/list-for-user": { parameters: { diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index e4757b8c..7efe7279 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "18.1.0" + "openapi-version": "18.2.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index dadb6dbb..8a2a9073 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -2402,6 +2402,36 @@ export interface paths { */ get: operations["orgs/list-invitation-teams"]; }; + "/orgs/{org}/issue-types": { + /** + * List issue types for an organization + * @description Lists all issue types for an organization. + */ + get: operations["orgs/list-issue-types"]; + /** + * Create issue type for an organization + * @description 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). + */ + post: operations["orgs/create-issue-type"]; + }; + "/orgs/{org}/issue-types/{issue_type_id}": { + /** + * Update issue type for an organization + * @description 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). + */ + put: operations["orgs/update-issue-type"]; + /** + * Delete issue type for an organization + * @description 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). + */ + delete: operations["orgs/delete-issue-type"]; + }; "/orgs/{org}/issues": { /** * List organization issues assigned to the authenticated user @@ -2942,6 +2972,10 @@ export interface paths { * Create or update custom properties for an organization * @description 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. @@ -5541,14 +5575,14 @@ export interface paths { * @description 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. */ put: operations["codespaces/create-or-update-repo-secret"]; /** * Delete a repository secret * @description 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. */ delete: operations["codespaces/delete-repo-secret"]; }; @@ -6323,7 +6357,7 @@ export interface paths { * * 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. */ @@ -8653,6 +8687,7 @@ export interface paths { * @deprecated * @description > [!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/). */ get: operations["search/issues-and-pull-requests"]; }; @@ -10821,6 +10856,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -10867,11 +10903,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -11061,7 +11099,7 @@ export interface components { */ contents?: "read" | "write"; /** - * @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. * @enum {string} */ dependabot_secrets?: "read" | "write"; @@ -13088,6 +13126,46 @@ export interface components { */ due_on: string | null; } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -13310,6 +13388,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -14939,12 +15018,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -16469,6 +16548,54 @@ export interface components { limit: components["schemas"]["interaction-group"]; expiry?: components["schemas"]["interaction-expiry"]; }; + "organization-create-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Whether or not the issue type is restricted to issues in private repositories. */ + is_private?: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + }; + "organization-update-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Whether or not the issue type is restricted to issues in private repositories. */ + is_private?: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: + | "gray" + | "blue" + | "green" + | "yellow" + | "orange" + | "red" + | "pink" + | "purple" + | null; + }; /** * Org Membership * @description Org Membership @@ -17101,6 +17228,12 @@ export interface components { * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; /** * Custom Property Value @@ -23866,6 +23999,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; @@ -26437,6 +26571,7 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; }; @@ -29117,6 +29252,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -29670,6 +29806,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -38914,6 +39051,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -39517,6 +39655,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -40124,6 +40263,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -40747,6 +40887,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -41299,6 +41440,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -41788,6 +41930,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -42291,6 +42434,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -42784,6 +42928,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -43279,6 +43424,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -43771,6 +43917,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -44996,6 +45143,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -45544,6 +45692,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -45988,6 +46137,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -46761,6 +46911,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -82607,6 +82758,8 @@ export interface components { "api-insights-actor-name-substring"?: string; /** @description The unique identifier of the invitation. */ "invitation-id": number; + /** @description The unique identifier of the issue type. */ + "issue-type-id": number; /** @description The name of the codespace. */ "codespace-name": string; /** @description The unique identifier of the migration. */ @@ -82648,6 +82801,8 @@ export interface components { "personal-access-token-before"?: string; /** @description 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`. */ "personal-access-token-after"?: string; + /** @description The ID of the token */ + "personal-access-token-token-id"?: string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description The custom property name */ @@ -91120,6 +91275,105 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * List issue types for an organization + * @description Lists all issue types for an organization. + */ + "orgs/list-issue-types": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["issue-type"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create issue type for an organization + * @description 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). + */ + "orgs/create-issue-type": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-create-issue-type"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["issue-type"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + /** + * Update issue type for an organization + * @description 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). + */ + "orgs/update-issue-type": { + parameters: { + path: { + org: components["parameters"]["org"]; + issue_type_id: components["parameters"]["issue-type-id"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-update-issue-type"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["issue-type"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + /** + * Delete issue type for an organization + * @description 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). + */ + "orgs/delete-issue-type": { + parameters: { + path: { + org: components["parameters"]["org"]; + issue_type_id: components["parameters"]["issue-type-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; /** * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. @@ -91148,6 +91402,8 @@ export interface operations { /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; direction?: components["parameters"]["direction"]; @@ -92328,6 +92584,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -92470,6 +92727,7 @@ export interface operations { permission?: components["parameters"]["personal-access-token-permission"]; last_used_before?: components["parameters"]["personal-access-token-before"]; last_used_after?: components["parameters"]["personal-access-token-after"]; + token_id?: components["parameters"]["personal-access-token-token-id"]; }; path: { org: components["parameters"]["org"]; @@ -92910,6 +93168,10 @@ export interface operations { * Create or update custom properties for an organization * @description 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. @@ -101696,7 +101958,7 @@ export interface operations { * @description 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. */ "codespaces/create-or-update-repo-secret": { parameters: { @@ -101733,7 +101995,7 @@ export interface operations { * Delete a repository secret * @description 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. */ "codespaces/delete-repo-secret": { parameters: { @@ -104000,7 +104262,7 @@ export interface operations { * * 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. */ @@ -105993,6 +106255,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @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. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -106070,6 +106334,11 @@ export interface operations { >[]; /** @description 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._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. + * @example Epic + */ + type?: string | null; }; }; }; @@ -106474,6 +106743,11 @@ export interface operations { >[]; /** @description 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. */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. + * @example Epic + */ + type?: string | null; }; }; }; @@ -112001,6 +112275,7 @@ export interface operations { * @deprecated * @description > [!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/). */ "search/issues-and-pull-requests": { parameters: {