diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 39344d004f..cc064f7f85 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -10218,6 +10218,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -10226,6 +10235,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -26163,7 +26176,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26246,14 +26259,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26289,12 +26303,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -26341,6 +26367,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -26495,7 +26533,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26588,7 +26626,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26624,12 +26663,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -55337,6 +55388,346 @@ "category": "issues", "subcategory": "issue-field-values" } + }, + "post": { + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/add-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Add multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after adding the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + }, + "put": { + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/set-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Set multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after setting the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { + "delete": { + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/delete-issue-field-value", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/issue-field-id" + } + ], + "responses": { + "204": { + "description": "Issue field value deleted successfully" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } } }, "/repos/{owner}/{repo}/issues/{issue_number}/labels": { @@ -59967,6 +60358,94 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -66513,339 +66992,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - }, - { - "$ref": "#/components/parameters/issue-field-id" - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/search/code": { "get": { "summary": "Search code", @@ -118024,7 +118170,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -118093,6 +118240,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -118148,7 +118307,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -118223,6 +118383,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 5d8a0c68b0..e712cc85c7 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -7332,6 +7332,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -7342,6 +7351,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -19044,7 +19058,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19136,8 +19150,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -19145,6 +19159,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19176,13 +19191,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -19221,6 +19248,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -19329,7 +19366,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19426,6 +19463,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19457,13 +19495,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -40439,6 +40489,268 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/issue-field-id" + responses: + '204': + description: Issue field value deleted successfully + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -43651,6 +43963,67 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -48271,266 +48644,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - - "$ref": "#/components/parameters/issue-field-id" - responses: - '204': - description: Issue field value deleted successfully - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/search/code": get: summary: Search code @@ -86409,6 +86522,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86465,6 +86579,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -86513,6 +86636,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86575,6 +86699,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index 3cc0a2852c..ca0d6e928a 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/api.github.com/api.github.com.2026-03-10.json @@ -10217,6 +10217,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -10225,6 +10234,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -26122,7 +26135,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26205,14 +26218,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26248,12 +26262,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -26300,6 +26326,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -26454,7 +26492,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26547,7 +26585,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26583,12 +26622,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -55254,6 +55305,346 @@ "category": "issues", "subcategory": "issue-field-values" } + }, + "post": { + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/add-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Add multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after adding the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + }, + "put": { + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/set-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Set multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after setting the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { + "delete": { + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/delete-issue-field-value", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/issue-field-id" + } + ], + "responses": { + "204": { + "description": "Issue field value deleted successfully" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } } }, "/repos/{owner}/{repo}/issues/{issue_number}/labels": { @@ -59884,6 +60275,94 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -66430,339 +66909,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - }, - { - "$ref": "#/components/parameters/issue-field-id" - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/search/code": { "get": { "summary": "Search code", @@ -117525,7 +117671,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -117594,6 +117741,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -117649,7 +117808,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -117724,6 +117884,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index c059b19cff..5b9f03cae3 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/api.github.com/api.github.com.2026-03-10.yaml @@ -7330,6 +7330,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -7340,6 +7349,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -19013,7 +19027,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19105,8 +19119,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -19114,6 +19128,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19145,13 +19160,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -19190,6 +19217,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -19298,7 +19335,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19395,6 +19432,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19426,13 +19464,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -40368,6 +40418,268 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/issue-field-id" + responses: + '204': + description: Issue field value deleted successfully + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -43580,6 +43892,67 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -48200,266 +48573,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - - "$ref": "#/components/parameters/issue-field-id" - responses: - '204': - description: Issue field value deleted successfully - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/search/code": get: summary: Search code @@ -86016,6 +86129,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86072,6 +86186,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -86120,6 +86243,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86182,6 +86306,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index bad14541f6..2be99c03f4 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -10264,6 +10264,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -10272,6 +10281,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -26342,7 +26355,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26425,14 +26438,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26468,12 +26482,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -26520,6 +26546,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -26674,7 +26712,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26767,7 +26805,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26803,12 +26842,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -55639,6 +55690,346 @@ "category": "issues", "subcategory": "issue-field-values" } + }, + "post": { + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/add-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Add multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after adding the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + }, + "put": { + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/set-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Set multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after setting the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { + "delete": { + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/delete-issue-field-value", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/issue-field-id" + } + ], + "responses": { + "204": { + "description": "Issue field value deleted successfully" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } } }, "/repos/{owner}/{repo}/issues/{issue_number}/labels": { @@ -60269,6 +60660,94 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -66815,339 +67294,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - }, - { - "$ref": "#/components/parameters/issue-field-id" - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/search/code": { "get": { "summary": "Search code", @@ -118801,7 +118947,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -118870,6 +119017,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -118925,7 +119084,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -119000,6 +119160,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index cd14a5fbf3..39e4b63ca7 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -7357,6 +7357,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -7367,6 +7376,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -19139,7 +19153,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19231,8 +19245,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -19240,6 +19254,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19271,13 +19286,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -19316,6 +19343,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -19424,7 +19461,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19521,6 +19558,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19552,13 +19590,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -40624,6 +40674,268 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/issue-field-id" + responses: + '204': + description: Issue field value deleted successfully + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -43836,6 +44148,67 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -48456,266 +48829,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - - "$ref": "#/components/parameters/issue-field-id" - responses: - '204': - description: Issue field value deleted successfully - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/search/code": get: summary: Search code @@ -86914,6 +87027,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86970,6 +87084,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -87018,6 +87141,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -87080,6 +87204,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index fe7bdee7c5..bd38039225 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -76753,6 +76753,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -76761,6 +76770,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -162607,7 +162620,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -162676,6 +162690,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -162820,7 +162846,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -162909,14 +162935,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -162952,12 +162979,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -163004,6 +163043,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -163052,7 +163103,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -163127,6 +163179,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -163453,7 +163517,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -163522,6 +163587,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -163590,7 +163667,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -163695,7 +163772,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -163731,12 +163809,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -428287,259 +428377,17 @@ "category": "issues", "subcategory": "issue-field-values" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - "get": { - "summary": "List labels for an issue", - "description": "Lists all labels for an issue.", - "tags": [ - "issues" - ], - "operationId": "issues/list-labels-on-issue", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#list-labels-for-an-issue" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "example": 208045946 - }, - "node_id": { - "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" - }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", - "nullable": true - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "301": { - "description": "Moved permanently", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "labels" - } }, "post": { - "summary": "Add labels to an issue", - "description": "Adds labels to an issue.", + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/add-labels", + "operationId": "issues/add-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" }, "parameters": [ { @@ -428571,52 +428419,76 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\"", - "items": { - "type": "string" - } - } - } - }, - { - "type": "array", - "items": { - "type": "string" - } - }, - { + "type": "object", + "properties": { + "issue_field_values": { "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", "items": { "type": "object", "properties": { - "name": { - "type": "string" + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" } }, "required": [ - "name" - ] - } + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 } - ] + } }, "examples": { "default": { + "summary": "Add multiple field values", "value": { - "labels": [ - "bug", - "enhancement" + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } ] } } @@ -428631,57 +428503,85 @@ "application/json": { "schema": { "type": "array", + "description": "The current issue field values for this issue after adding the new values", "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "title": "Issue Field Value", + "description": "A value assigned to an issue field", "type": "object", "properties": { - "id": { - "description": "Unique identifier for the label.", + "issue_field_id": { + "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", - "example": 208045946 + "example": 1 }, "node_id": { "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + "example": "IFT_GDKND" }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", + "data_type": { + "description": "The data type of the issue field", "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], "nullable": true }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true } }, "required": [ - "id", + "issue_field_id", "node_id", - "url", - "name", - "description", - "color", - "default" + "data_type", + "value" ] } }, @@ -428689,22 +428589,33 @@ "default": { "value": [ { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" }, { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" } ] } @@ -428712,8 +428623,8 @@ } } }, - "301": { - "description": "Moved permanently", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -428735,11 +428646,45 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -428764,8 +428709,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -428858,25 +428803,47 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "labels" + "subcategory": "issue-field-values" } }, "put": { - "summary": "Set labels for an issue", - "description": "Removes any previous labels and sets the new labels for an issue.", + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/set-labels", + "operationId": "issues/set-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#set-labels-for-an-issue" + "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" }, "parameters": [ { @@ -428908,77 +428875,76 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue).\"", - "items": { - "type": "string" - } - } - } - }, - { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - { - "type": "object", - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - }, - "required": [ - "name" - ] - } - } - } - }, - { + "type": "object", + "properties": { + "issue_field_values": { "type": "array", - "minItems": 1, + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", "items": { "type": "object", "properties": { - "name": { - "type": "string" + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" } }, "required": [ - "name" - ] - } - }, - { - "type": "string" + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 } - ] + } }, "examples": { "default": { + "summary": "Set multiple field values", "value": { - "labels": [ - "bug", - "enhancement" + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } ] } } @@ -428993,57 +428959,85 @@ "application/json": { "schema": { "type": "array", + "description": "The current issue field values for this issue after setting the new values", "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "title": "Issue Field Value", + "description": "A value assigned to an issue field", "type": "object", "properties": { - "id": { - "description": "Unique identifier for the label.", + "issue_field_id": { + "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", - "example": 208045946 + "example": 1 }, "node_id": { "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + "example": "IFT_GDKND" }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", + "data_type": { + "description": "The data type of the issue field", "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], "nullable": true }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true } }, "required": [ - "id", + "issue_field_id", "node_id", - "url", - "name", - "description", - "color", - "default" + "data_type", + "value" ] } }, @@ -429051,22 +429045,33 @@ "default": { "value": [ { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" }, { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" } ] } @@ -429074,8 +429079,8 @@ } } }, - "301": { - "description": "Moved permanently", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -429097,11 +429102,45 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -429126,8 +429165,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -429220,25 +429259,49 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "labels" + "subcategory": "issue-field-values" } - }, + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { "delete": { - "summary": "Remove all labels from an issue", - "description": "Removes all labels from an issue.", + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/remove-all-labels", + "operationId": "issues/delete-issue-field-value", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue" + "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" }, "parameters": [ { @@ -429267,14 +429330,23 @@ "schema": { "type": "integer" } + }, + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { "204": { - "description": "Response" + "description": "Issue field value deleted successfully" }, - "301": { - "description": "Moved permanently", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -429325,14 +429397,18 @@ } } }, - "410": { - "description": "Gone", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -429340,10 +429416,70 @@ "documentation_url": { "type": "string" }, - "url": { + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { "type": "string" }, - "status": { + "message": { + "type": "string" + }, + "documentation_url": { "type": "string" } } @@ -429353,24 +429489,25 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "labels" + "subcategory": "issue-field-values" } } }, - "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { - "delete": { - "summary": "Remove a label from an issue", - "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + "get": { + "summary": "List labels for an issue", + "description": "Lists all labels for an issue.", "tags": [ "issues" ], - "operationId": "issues/remove-label", + "operationId": "issues/list-labels-on-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue" + "url": "https://docs.github.com/rest/issues/labels#list-labels-for-an-issue" }, "parameters": [ { @@ -429401,11 +429538,21 @@ } }, { - "name": "name", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } ], @@ -429481,11 +429628,28 @@ "description": "Something isn't working", "color": "f29513", "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false } ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, "301": { @@ -429573,19 +429737,17 @@ "category": "issues", "subcategory": "labels" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/lock": { - "put": { - "summary": "Lock an issue", - "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + }, + "post": { + "summary": "Add labels to an issue", + "description": "Adds labels to an issue.", "tags": [ "issues" ], - "operationId": "issues/lock", + "operationId": "issues/add-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#lock-an-issue" + "url": "https://docs.github.com/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -429621,26 +429783,49 @@ "content": { "application/json": { "schema": { - "type": "object", - "nullable": true, - "properties": { - "lock_reason": { - "type": "string", - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`", - "enum": [ - "off-topic", - "too heated", - "resolved", - "spam" - ] + "oneOf": [ + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\"", + "items": { + "type": "string" + } + } + } + }, + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } } - } + ] }, "examples": { "default": { - "summary": "Example of locking an issue as off-topic", "value": { - "lock_reason": "off-topic" + "labels": [ + "bug", + "enhancement" + ] } } } @@ -429648,11 +429833,95 @@ } }, "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + } + } + } + } }, - "403": { - "description": "Forbidden", + "301": { + "description": "Moved permanently", "content": { "application/json": { "schema": { @@ -429677,8 +429946,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -429703,8 +429972,8 @@ } } }, - "404": { - "description": "Resource not found", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -429803,19 +430072,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "labels" } }, - "delete": { - "summary": "Unlock an issue", - "description": "Users with push access can unlock an issue's conversation.", + "put": { + "summary": "Set labels for an issue", + "description": "Removes any previous labels and sets the new labels for an issue.", "tags": [ "issues" ], - "operationId": "issues/unlock", + "operationId": "issues/set-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#unlock-an-issue" + "url": "https://docs.github.com/rest/issues/labels#set-labels-for-an-issue" }, "parameters": [ { @@ -429846,65 +430115,1004 @@ } } ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue).\"", + "items": { + "type": "string" + } + } } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { + }, + { + "type": "array", + "minItems": 1, + "items": { "type": "string" } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, + }, + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + { + "type": "string" + } + ] + }, + "examples": { + "default": { + "value": { + "labels": [ + "bug", + "enhancement" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + } + } + } + } + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "delete": { + "summary": "Remove all labels from an issue", + "description": "Removes all labels from an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-all-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + "delete": { + "summary": "Remove a label from an issue", + "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ] + } + } + } + } + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + "put": { + "summary": "Lock an issue", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "issues" + ], + "operationId": "issues/lock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#lock-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "lock_reason": { + "type": "string", + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`", + "enum": [ + "off-topic", + "too heated", + "resolved", + "spam" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of locking an issue as off-topic", + "value": { + "lock_reason": "off-topic" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + } + }, + "delete": { + "summary": "Unlock an issue", + "description": "Users with push access can unlock an issue's conversation.", + "tags": [ + "issues" + ], + "operationId": "issues/unlock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#unlock-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", "subcategory": "issues" @@ -489652,6 +490860,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -556183,1099 +557739,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_field_id", - "description": "The unique identifier of the issue field.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/search/code": { "get": { "summary": "Search code", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index b097f3bb4f..0922a4cfbc 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1023,7 +1023,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &664 + - &665 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -12058,7 +12058,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &572 + properties: &573 pinned_at: type: string format: date-time @@ -12070,7 +12070,7 @@ paths: properties: *20 required: *21 nullable: true - required: &573 + required: &574 - pinned_at - pinned_by nullable: true @@ -12866,7 +12866,7 @@ paths: type: string release: allOf: - - &606 + - &607 title: Release description: A release. type: object @@ -12937,7 +12937,7 @@ paths: author: *4 assets: type: array - items: &607 + items: &608 title: Release Asset description: Data related to a release. type: object @@ -16920,7 +16920,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &582 + - &583 name: all description: If `true`, show notifications marked as read. in: query @@ -16928,7 +16928,7 @@ paths: schema: type: boolean default: false - - &583 + - &584 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16938,7 +16938,7 @@ paths: type: boolean default: false - *93 - - &584 + - &585 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -17468,7 +17468,7 @@ paths: - url - subscription_url examples: - default: &585 + default: &586 value: - id: '1' repository: @@ -20935,6 +20935,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -20945,6 +20954,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -38991,6 +39005,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39050,6 +39065,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -39087,7 +39111,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -39179,8 +39203,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -39188,6 +39212,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -39219,13 +39244,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -39264,6 +39301,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -39305,6 +39352,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39370,6 +39418,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -39493,7 +39550,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -39590,6 +39647,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -39621,13 +39679,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -40266,7 +40336,7 @@ paths: - review_comment - self author_association: *83 - auto_merge: &592 + auto_merge: &593 title: Auto merge description: The status of auto merging a pull request. type: object @@ -44424,7 +44494,7 @@ paths: - *76 - *17 - *19 - - &614 + - &615 name: targets description: | A comma-separated list of rule targets to filter by. @@ -44705,7 +44775,7 @@ paths: - repository_property rules: type: array - items: &615 + items: &616 title: Repository Rule type: object description: A repository rule. @@ -44767,7 +44837,7 @@ paths: type: string enum: - required_linear_history - - &613 + - &614 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -45669,7 +45739,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *76 - - &616 + - &617 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -45684,7 +45754,7 @@ paths: in: query schema: type: string - - &617 + - &618 name: time_period description: |- The time period to filter by. @@ -45700,14 +45770,14 @@ paths: - week - month default: day - - &618 + - &619 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &619 + - &620 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -45727,7 +45797,7 @@ paths: description: Response content: application/json: - schema: &620 + schema: &621 title: Rule Suites description: Response type: array @@ -45782,7 +45852,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &621 + default: &622 value: - id: 21 actor_id: 12 @@ -45826,7 +45896,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *76 - - &622 + - &623 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -45842,7 +45912,7 @@ paths: description: Response content: application/json: - schema: &623 + schema: &624 title: Rule Suite description: Response type: object @@ -45941,7 +46011,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &624 + default: &625 value: id: 21 actor_id: 12 @@ -46188,7 +46258,7 @@ paths: type: string format: date-time examples: - default: &626 + default: &627 value: - version_id: 3 actor: @@ -46241,7 +46311,7 @@ paths: description: Response content: application/json: - schema: &627 + schema: &628 allOf: - *327 - type: object @@ -46313,7 +46383,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *76 - - &628 + - &629 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -46324,7 +46394,7 @@ paths: enum: - open - resolved - - &629 + - &630 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -46334,7 +46404,7 @@ paths: required: false schema: type: string - - &630 + - &631 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -46345,7 +46415,7 @@ paths: required: false schema: type: string - - &631 + - &632 name: exclude_providers in: query description: |- @@ -46356,7 +46426,7 @@ paths: required: false schema: type: string - - &632 + - &633 name: providers in: query description: |- @@ -46367,7 +46437,7 @@ paths: required: false schema: type: string - - &633 + - &634 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -46376,7 +46446,7 @@ paths: required: false schema: type: string - - &634 + - &635 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -46395,7 +46465,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &635 + - &636 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -46410,7 +46480,7 @@ paths: - *62 - *19 - *17 - - &636 + - &637 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -46420,7 +46490,7 @@ paths: required: false schema: type: string - - &637 + - &638 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -46430,7 +46500,7 @@ paths: required: false schema: type: string - - &638 + - &639 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -46439,7 +46509,7 @@ paths: required: false schema: type: string - - &639 + - &640 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -46448,7 +46518,7 @@ paths: schema: type: boolean default: false - - &640 + - &641 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -46457,7 +46527,7 @@ paths: schema: type: boolean default: false - - &641 + - &642 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -46492,14 +46562,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &642 + state: &643 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &643 + resolution: &644 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -46616,8 +46686,8 @@ paths: pull request. ' - oneOf: &644 - - &646 + oneOf: &645 + - &647 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -46675,7 +46745,7 @@ paths: - blob_url - commit_sha - commit_url - - &647 + - &648 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -46730,7 +46800,7 @@ paths: - page_url - commit_sha - commit_url - - &648 + - &649 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -46750,7 +46820,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &649 + - &650 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -46770,7 +46840,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &650 + - &651 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -46790,7 +46860,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &651 + - &652 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -46804,7 +46874,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &652 + - &653 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -46818,7 +46888,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &653 + - &654 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -46832,7 +46902,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &654 + - &655 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -46852,7 +46922,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &655 + - &656 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -46872,7 +46942,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &656 + - &657 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -46892,7 +46962,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &657 + - &658 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -46912,7 +46982,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &658 + - &659 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -47431,7 +47501,7 @@ paths: application/json: schema: type: array - items: &662 + items: &663 description: A repository security advisory. type: object properties: @@ -47722,7 +47792,7 @@ paths: - private_fork additionalProperties: false examples: - default: &663 + default: &664 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -68275,7 +68345,7 @@ paths: type: array items: *476 examples: - default: &599 + default: &600 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -68566,7 +68636,7 @@ paths: type: array items: *480 examples: - default: &591 + default: &592 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -69124,7 +69194,7 @@ paths: application/json: schema: *476 examples: - default: &578 + default: &579 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69783,7 +69853,7 @@ paths: application/json: schema: type: array - items: &667 + items: &668 title: Status description: The status of a commit. type: object @@ -70752,7 +70822,7 @@ paths: - size - type - url - - &604 + - &605 title: Content File description: Content File type: object @@ -71366,7 +71436,7 @@ paths: items: type: object properties: - placeholder_id: &659 + placeholder_id: &660 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -81484,7 +81554,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &559 + - &560 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -81538,7 +81608,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &560 + - &561 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -81674,7 +81744,7 @@ paths: - performed_via_github_app - assignee - assigner - - &561 + - &562 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -81725,7 +81795,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &562 + - &563 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -81776,7 +81846,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &563 + - &564 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -81830,7 +81900,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &564 + - &565 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -81877,7 +81947,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &565 + - &566 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -81924,7 +81994,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &566 + - &567 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -81984,7 +82054,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &567 + - &568 title: Locked Issue Event description: Locked Issue Event type: object @@ -82032,7 +82102,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &568 + - &569 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -82098,7 +82168,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &569 + - &570 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -82164,7 +82234,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &570 + - &571 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -82230,7 +82300,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &571 + - &572 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -82352,7 +82422,7 @@ paths: type: array items: *557 examples: - default: &673 + default: &558 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -82384,6 +82454,250 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - *342 + - *343 + - *554 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: *557 + examples: + default: *558 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *120 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - *342 + - *343 + - *554 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: *557 + examples: + default: *558 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *120 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - *342 + - *343 + - *554 + - *241 + responses: + '204': + description: Issue field value deleted successfully + '403': *29 + '404': *6 + '422': *15 + '503': *120 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -82409,7 +82723,7 @@ paths: type: array items: *85 examples: - default: &558 + default: &559 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82492,7 +82806,7 @@ paths: type: array items: *85 examples: - default: *558 + default: *559 '301': *346 '404': *6 '410': *545 @@ -82576,7 +82890,7 @@ paths: type: array items: *85 examples: - default: *558 + default: *559 '301': *346 '404': *6 '410': *545 @@ -83167,7 +83481,6 @@ paths: description: Timeline Event type: object anyOf: - - *559 - *560 - *561 - *562 @@ -83180,6 +83493,7 @@ paths: - *569 - *570 - *571 + - *572 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -83240,8 +83554,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *572 - required: *573 + properties: *573 + required: *574 nullable: true required: - event @@ -83496,7 +83810,7 @@ paths: type: string comments: type: array - items: &593 + items: &594 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -84028,7 +84342,7 @@ paths: application/json: schema: type: array - items: &574 + items: &575 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -84131,9 +84445,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *575 examples: - default: &575 + default: &576 value: id: 1 key: ssh-rsa AAA... @@ -84169,7 +84483,7 @@ paths: parameters: - *342 - *343 - - &576 + - &577 name: key_id description: The unique identifier of the key. in: path @@ -84181,9 +84495,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *575 examples: - default: *575 + default: *576 '404': *6 x-github: githubCloudOnly: false @@ -84203,7 +84517,7 @@ paths: parameters: - *342 - *343 - - *576 + - *577 responses: '204': description: Response @@ -84236,7 +84550,7 @@ paths: type: array items: *85 examples: - default: *558 + default: *559 headers: Link: *68 '404': *6 @@ -84296,7 +84610,7 @@ paths: application/json: schema: *85 examples: - default: &577 + default: &578 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -84342,7 +84656,7 @@ paths: application/json: schema: *85 examples: - default: *577 + default: *578 '404': *6 x-github: githubCloudOnly: false @@ -84742,7 +85056,7 @@ paths: application/json: schema: *476 examples: - default: *578 + default: *579 '204': description: Response when already merged '404': @@ -84809,7 +85123,7 @@ paths: application/json: schema: type: array - items: &579 + items: &580 title: Milestone description: A collection of related issues and pull requests. type: object @@ -84911,9 +85225,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: &580 + default: &581 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -84974,7 +85288,7 @@ paths: parameters: - *342 - *343 - - &581 + - &582 name: milestone_number description: The number that identifies the milestone. in: path @@ -84986,9 +85300,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *580 + default: *581 '404': *6 x-github: githubCloudOnly: false @@ -85007,7 +85321,7 @@ paths: parameters: - *342 - *343 - - *581 + - *582 requestBody: required: false content: @@ -85045,9 +85359,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *580 + default: *581 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85065,7 +85379,7 @@ paths: parameters: - *342 - *343 - - *581 + - *582 responses: '204': description: Response @@ -85088,7 +85402,7 @@ paths: parameters: - *342 - *343 - - *581 + - *582 - *17 - *19 responses: @@ -85100,7 +85414,7 @@ paths: type: array items: *85 examples: - default: *558 + default: *559 headers: Link: *68 x-github: @@ -85121,10 +85435,10 @@ paths: parameters: - *342 - *343 - - *582 - *583 - - *93 - *584 + - *93 + - *585 - *17 - *19 responses: @@ -85136,7 +85450,7 @@ paths: type: array items: *113 examples: - default: *585 + default: *586 headers: Link: *68 x-github: @@ -85226,7 +85540,7 @@ paths: description: Response content: application/json: - schema: &586 + schema: &587 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -85351,7 +85665,7 @@ paths: - custom_404 - public examples: - default: &587 + default: &588 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -85447,9 +85761,9 @@ paths: description: Response content: application/json: - schema: *586 + schema: *587 examples: - default: *587 + default: *588 '422': *15 '409': *54 x-github: @@ -85610,7 +85924,7 @@ paths: application/json: schema: type: array - items: &588 + items: &589 title: Page Build description: Page Build type: object @@ -85757,9 +86071,9 @@ paths: description: Response content: application/json: - schema: *588 + schema: *589 examples: - default: &589 + default: &590 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -85819,9 +86133,9 @@ paths: description: Response content: application/json: - schema: *588 + schema: *589 examples: - default: *589 + default: *590 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85949,7 +86263,7 @@ paths: parameters: - *342 - *343 - - &590 + - &591 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -86009,7 +86323,7 @@ paths: parameters: - *342 - *343 - - *590 + - *591 responses: '204': *61 '404': *6 @@ -86544,7 +86858,7 @@ paths: type: array items: *480 examples: - default: *591 + default: *592 headers: Link: *68 '304': *37 @@ -86642,7 +86956,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &596 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -86853,7 +87167,7 @@ paths: - review_comment - self author_association: *83 - auto_merge: *592 + auto_merge: *593 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -86945,7 +87259,7 @@ paths: - merged_by - review_comments examples: - default: &596 + default: &597 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -87502,9 +87816,9 @@ paths: application/json: schema: type: array - items: *593 + items: *594 examples: - default: &598 + default: &599 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87589,9 +87903,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: - default: &594 + default: &595 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87690,9 +88004,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: - default: *594 + default: *595 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87895,7 +88209,7 @@ paths: parameters: - *342 - *343 - - &597 + - &598 name: pull_number description: The number that identifies the pull request. in: path @@ -87908,9 +88222,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *595 + schema: *596 examples: - default: *596 + default: *597 '304': *37 '404': *6 '406': @@ -87947,7 +88261,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: false content: @@ -87989,11 +88303,66 @@ paths: description: Response content: application/json: - schema: *595 + schema: *596 examples: - default: *596 + default: *597 + '422': *15 + '403': *29 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request + parameters: + - *342 + - *343 + - *598 + responses: + '204': + description: Response + '403': *29 + '404': *6 '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *342 + - *343 + - *598 + responses: + '204': + description: Response '403': *29 + '404': *6 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88015,7 +88384,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: true content: @@ -88117,7 +88486,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 - *110 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -88138,9 +88507,9 @@ paths: application/json: schema: type: array - items: *593 + items: *594 examples: - default: *598 + default: *599 headers: Link: *68 x-github: @@ -88175,7 +88544,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: true content: @@ -88280,7 +88649,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: example-for-a-multi-line-comment: value: @@ -88370,7 +88739,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 - *102 requestBody: required: true @@ -88393,7 +88762,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: default: value: @@ -88481,7 +88850,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 - *17 - *19 responses: @@ -88493,7 +88862,7 @@ paths: type: array items: *476 examples: - default: *599 + default: *600 headers: Link: *68 x-github: @@ -88525,7 +88894,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 - *17 - *19 responses: @@ -88575,7 +88944,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 responses: '204': description: Response if pull request has been merged @@ -88600,7 +88969,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: false content: @@ -88713,7 +89082,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 responses: '200': description: Response @@ -88790,7 +89159,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: false content: @@ -89365,7 +89734,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: true content: @@ -89906,7 +90275,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 - *17 - *19 responses: @@ -89916,7 +90285,7 @@ paths: application/json: schema: type: array - items: &600 + items: &601 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -90069,7 +90438,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: false content: @@ -90155,9 +90524,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: - default: &602 + default: &603 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -90222,8 +90591,8 @@ paths: parameters: - *342 - *343 - - *597 - - &601 + - *598 + - &602 name: review_id description: The unique identifier of the review. in: path @@ -90235,9 +90604,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: - default: &603 + default: &604 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -90298,8 +90667,8 @@ paths: parameters: - *342 - *343 - - *597 - - *601 + - *598 + - *602 requestBody: required: true content: @@ -90322,7 +90691,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -90386,16 +90755,16 @@ paths: parameters: - *342 - *343 - - *597 - - *601 + - *598 + - *602 responses: '200': description: Response content: application/json: - schema: *600 + schema: *601 examples: - default: *602 + default: *603 '422': *7 '404': *6 x-github: @@ -90424,8 +90793,8 @@ paths: parameters: - *342 - *343 - - *597 - - *601 + - *598 + - *602 - *17 - *19 responses: @@ -90662,8 +91031,8 @@ paths: parameters: - *342 - *343 - - *597 - - *601 + - *598 + - *602 requestBody: required: true content: @@ -90691,7 +91060,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -90756,8 +91125,8 @@ paths: parameters: - *342 - *343 - - *597 - - *601 + - *598 + - *602 requestBody: required: true content: @@ -90792,9 +91161,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: - default: *603 + default: *604 '404': *6 '422': *7 '403': *29 @@ -90818,7 +91187,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: false content: @@ -90895,9 +91264,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *605 examples: - default: &605 + default: &606 value: type: file encoding: base64 @@ -90960,9 +91329,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *605 examples: - default: *605 + default: *606 '404': *6 '422': *15 x-github: @@ -90995,7 +91364,7 @@ paths: application/json: schema: type: array - items: *606 + items: *607 examples: default: value: @@ -91166,9 +91535,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *607 examples: - default: &610 + default: &611 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -91275,7 +91644,7 @@ paths: parameters: - *342 - *343 - - &608 + - &609 name: asset_id description: The unique identifier of the asset. in: path @@ -91287,9 +91656,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: - default: &609 + default: &610 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -91342,7 +91711,7 @@ paths: parameters: - *342 - *343 - - *608 + - *609 requestBody: required: false content: @@ -91370,9 +91739,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: - default: *609 + default: *610 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91390,7 +91759,7 @@ paths: parameters: - *342 - *343 - - *608 + - *609 responses: '204': description: Response @@ -91508,9 +91877,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *607 examples: - default: *610 + default: *611 '404': *6 x-github: githubCloudOnly: false @@ -91542,9 +91911,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *607 examples: - default: *610 + default: *611 '404': *6 x-github: githubCloudOnly: false @@ -91568,7 +91937,7 @@ paths: parameters: - *342 - *343 - - &611 + - &612 name: release_id description: The unique identifier of the release. in: path @@ -91582,9 +91951,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *606 + schema: *607 examples: - default: *610 + default: *611 '401': description: Unauthorized x-github: @@ -91604,7 +91973,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 requestBody: required: false content: @@ -91668,9 +92037,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *607 examples: - default: *610 + default: *611 '404': description: Not Found if the discussion category name is invalid content: @@ -91693,7 +92062,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 responses: '204': description: Response @@ -91716,7 +92085,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 - *17 - *19 responses: @@ -91726,7 +92095,7 @@ paths: application/json: schema: type: array - items: *607 + items: *608 examples: default: value: @@ -91809,7 +92178,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 - name: name in: query required: true @@ -91835,7 +92204,7 @@ paths: description: Response for successful upload content: application/json: - schema: *607 + schema: *608 examples: response-for-successful-upload: value: @@ -91892,7 +92261,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -91941,7 +92310,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 requestBody: required: true content: @@ -92004,7 +92373,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 - *549 responses: '204': @@ -92048,7 +92417,7 @@ paths: oneOf: - allOf: - *303 - - &612 + - &613 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -92069,67 +92438,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *304 - - *612 + - *613 - allOf: - *305 - - *612 + - *613 - allOf: - *306 - - *612 + - *613 - allOf: + - *614 - *613 - - *612 - allOf: - *307 - - *612 + - *613 - allOf: - *308 - - *612 + - *613 - allOf: - *309 - - *612 + - *613 - allOf: - *310 - - *612 + - *613 - allOf: - *311 - - *612 + - *613 - allOf: - *312 - - *612 + - *613 - allOf: - *313 - - *612 + - *613 - allOf: - *314 - - *612 + - *613 - allOf: - *315 - - *612 + - *613 - allOf: - *316 - - *612 + - *613 - allOf: - *317 - - *612 + - *613 - allOf: - *318 - - *612 + - *613 - allOf: - *319 - - *612 + - *613 - allOf: - *320 - - *612 + - *613 - allOf: - *321 - - *612 + - *613 - allOf: - *322 - - *612 + - *613 - allOf: - *323 - - *612 + - *613 examples: default: value: @@ -92180,7 +92549,7 @@ paths: schema: type: boolean default: true - - *614 + - *615 responses: '200': description: Response @@ -92265,7 +92634,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *615 + items: *616 required: - name - enforcement @@ -92298,7 +92667,7 @@ paths: application/json: schema: *324 examples: - default: &625 + default: &626 value: id: 42 name: super cool ruleset @@ -92348,10 +92717,10 @@ paths: parameters: - *342 - *343 - - *616 - *617 - *618 - *619 + - *620 - *17 - *19 responses: @@ -92359,9 +92728,9 @@ paths: description: Response content: application/json: - schema: *620 + schema: *621 examples: - default: *621 + default: *622 '404': *6 '500': *55 x-github: @@ -92384,15 +92753,15 @@ paths: parameters: - *342 - *343 - - *622 + - *623 responses: '200': description: Response content: application/json: - schema: *623 + schema: *624 examples: - default: *624 + default: *625 '404': *6 '500': *55 x-github: @@ -92443,7 +92812,7 @@ paths: application/json: schema: *324 examples: - default: *625 + default: *626 '404': *6 '500': *55 put: @@ -92496,7 +92865,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *615 + items: *616 examples: default: value: @@ -92526,7 +92895,7 @@ paths: application/json: schema: *324 examples: - default: *625 + default: *626 '404': *6 '422': *15 '500': *55 @@ -92588,7 +92957,7 @@ paths: type: array items: *327 examples: - default: *626 + default: *627 '404': *6 '500': *55 x-github: @@ -92626,7 +92995,7 @@ paths: description: Response content: application/json: - schema: *627 + schema: *628 examples: default: value: @@ -92683,7 +93052,6 @@ paths: parameters: - *342 - *343 - - *628 - *629 - *630 - *631 @@ -92691,15 +93059,16 @@ paths: - *633 - *634 - *635 + - *636 - *62 - *19 - *17 - - *636 - *637 - *638 - *639 - *640 - *641 + - *642 responses: '200': description: Response @@ -92707,7 +93076,7 @@ paths: application/json: schema: type: array - items: &645 + items: &646 type: object properties: number: *177 @@ -92726,8 +93095,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *642 - resolution: *643 + state: *643 + resolution: *644 resolved_at: type: string format: date-time @@ -92833,7 +93202,7 @@ paths: pull request. ' - oneOf: *644 + oneOf: *645 nullable: true has_more_locations: type: boolean @@ -93000,13 +93369,13 @@ paths: - *342 - *343 - *440 - - *641 + - *642 responses: '200': description: Response content: application/json: - schema: *645 + schema: *646 examples: default: value: @@ -93070,8 +93439,8 @@ paths: schema: type: object properties: - state: *642 - resolution: *643 + state: *643 + resolution: *644 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -93107,7 +93476,7 @@ paths: description: Response content: application/json: - schema: *645 + schema: *646 examples: default: value: @@ -93241,7 +93610,6 @@ paths: example: commit details: oneOf: - - *646 - *647 - *648 - *649 @@ -93254,6 +93622,7 @@ paths: - *656 - *657 - *658 + - *659 examples: default: value: @@ -93348,14 +93717,14 @@ paths: schema: type: object properties: - reason: &660 + reason: &661 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *659 + placeholder_id: *660 required: - reason - placeholder_id @@ -93372,7 +93741,7 @@ paths: schema: type: object properties: - reason: *660 + reason: *661 expire_at: type: string format: date-time @@ -93434,7 +93803,7 @@ paths: properties: incremental_scans: type: array - items: &661 + items: &662 description: Information on a single scan performed by secret scanning on the repository type: object @@ -93460,15 +93829,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *661 + items: *662 backfill_scans: type: array - items: *661 + items: *662 custom_pattern_backfill_scans: type: array items: allOf: - - *661 + - *662 - type: object properties: pattern_name: @@ -93481,7 +93850,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *661 + items: *662 examples: default: value: @@ -93591,9 +93960,9 @@ paths: application/json: schema: type: array - items: *662 + items: *663 examples: - default: *663 + default: *664 '400': *14 '404': *6 x-github: @@ -93777,9 +94146,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: &665 + default: &666 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -94117,7 +94486,7 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: default: value: @@ -94266,15 +94635,15 @@ paths: parameters: - *342 - *343 - - *664 + - *665 responses: '200': description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: *665 + default: *666 '403': *29 '404': *6 x-github: @@ -94300,7 +94669,7 @@ paths: parameters: - *342 - *343 - - *664 + - *665 requestBody: required: true content: @@ -94459,10 +94828,10 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: *665 - add_credit: *665 + default: *666 + add_credit: *666 '403': *29 '404': *6 '422': @@ -94502,7 +94871,7 @@ paths: parameters: - *342 - *343 - - *664 + - *665 responses: '202': *39 '400': *14 @@ -94531,7 +94900,7 @@ paths: parameters: - *342 - *343 - - *664 + - *665 responses: '202': description: Response @@ -94675,7 +95044,7 @@ paths: application/json: schema: type: array - items: &666 + items: &667 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -95048,7 +95417,7 @@ paths: application/json: schema: type: array - items: *666 + items: *667 examples: default: value: @@ -95136,7 +95505,7 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: default: value: @@ -95230,7 +95599,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &668 + schema: &669 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -95325,7 +95694,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: default: value: @@ -95532,7 +95901,7 @@ paths: description: Response content: application/json: - schema: &669 + schema: &670 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -95544,7 +95913,7 @@ paths: required: - names examples: - default: &670 + default: &671 value: names: - octocat @@ -95599,9 +95968,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: *670 + default: *671 '404': *6 '422': *7 x-github: @@ -95624,7 +95993,7 @@ paths: parameters: - *342 - *343 - - &671 + - &672 name: per description: The time frame to display results for. in: query @@ -95653,7 +96022,7 @@ paths: example: 128 clones: type: array - items: &672 + items: &673 title: Traffic type: object properties: @@ -95894,7 +96263,7 @@ paths: parameters: - *342 - *343 - - *671 + - *672 responses: '200': description: Response @@ -95913,7 +96282,7 @@ paths: example: 3782 views: type: array - items: *672 + items: *673 required: - uniques - count @@ -96557,248 +96926,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - *148 - - *554 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: *557 - examples: - default: *673 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *120 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - *148 - - *554 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: *557 - examples: - default: *673 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *120 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - *148 - - *554 - - *241 - responses: - '204': - description: Issue field value deleted successfully - '403': *29 - '404': *6 - '422': *15 - '503': *120 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/search/code": get: summary: Search code @@ -103466,7 +103593,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *576 + - *577 responses: '200': description: Response @@ -103497,7 +103624,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *576 + - *577 responses: '204': description: Response @@ -120043,7 +120170,7 @@ x-webhooks: nullable: true pull_requests: type: array - items: *595 + items: *596 repository: *743 organization: *742 installation: *741 @@ -128124,8 +128251,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *572 - required: *573 + properties: *573 + required: *574 nullable: true user: title: User @@ -129588,8 +129715,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *572 - required: *573 + properties: *573 + required: *574 nullable: true required: - url @@ -166802,7 +166929,7 @@ x-webhooks: organization: *742 pull_request: &793 allOf: - - *595 + - *596 - type: object properties: allow_auto_merge: @@ -167031,7 +167158,7 @@ x-webhooks: enum: - demilestoned enterprise: *740 - milestone: *579 + milestone: *580 number: *792 organization: *742 pull_request: &794 @@ -179063,7 +179190,7 @@ x-webhooks: enum: - milestoned enterprise: *740 - milestone: *579 + milestone: *580 number: *792 organization: *742 pull_request: *794 @@ -221420,7 +221547,7 @@ x-webhooks: installation: *741 organization: *742 repository: *743 - repository_advisory: *662 + repository_advisory: *663 sender: *4 required: - action @@ -221500,7 +221627,7 @@ x-webhooks: installation: *741 organization: *742 repository: *743 - repository_advisory: *662 + repository_advisory: *663 sender: *4 required: - action @@ -222587,16 +222714,16 @@ x-webhooks: properties: added: type: array - items: *615 + items: *616 deleted: type: array - items: *615 + items: *616 updated: type: array items: type: object properties: - rule: *615 + rule: *616 changes: type: object properties: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 1c04ebcd57..0d05e5b8bd 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -73444,6 +73444,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -73452,6 +73461,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -157387,7 +157400,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -157456,6 +157470,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -157600,7 +157626,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -157689,14 +157715,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -157732,12 +157759,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -157784,6 +157823,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -157832,7 +157883,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -157907,6 +157959,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -158233,7 +158297,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -158302,6 +158367,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -158370,7 +158447,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -158475,7 +158552,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -158511,12 +158589,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -419656,259 +419746,17 @@ "category": "issues", "subcategory": "issue-field-values" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - "get": { - "summary": "List labels for an issue", - "description": "Lists all labels for an issue.", - "tags": [ - "issues" - ], - "operationId": "issues/list-labels-on-issue", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#list-labels-for-an-issue" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "example": 208045946 - }, - "node_id": { - "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" - }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", - "nullable": true - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "301": { - "description": "Moved permanently", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "labels" - } }, "post": { - "summary": "Add labels to an issue", - "description": "Adds labels to an issue.", + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/add-labels", + "operationId": "issues/add-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" }, "parameters": [ { @@ -419940,52 +419788,76 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\"", - "items": { - "type": "string" - } - } - } - }, - { - "type": "array", - "items": { - "type": "string" - } - }, - { + "type": "object", + "properties": { + "issue_field_values": { "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", "items": { "type": "object", "properties": { - "name": { - "type": "string" + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" } }, "required": [ - "name" - ] - } + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 } - ] + } }, "examples": { "default": { + "summary": "Add multiple field values", "value": { - "labels": [ - "bug", - "enhancement" + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } ] } } @@ -420000,57 +419872,85 @@ "application/json": { "schema": { "type": "array", + "description": "The current issue field values for this issue after adding the new values", "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "title": "Issue Field Value", + "description": "A value assigned to an issue field", "type": "object", "properties": { - "id": { - "description": "Unique identifier for the label.", + "issue_field_id": { + "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", - "example": 208045946 + "example": 1 }, "node_id": { "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + "example": "IFT_GDKND" }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", + "data_type": { + "description": "The data type of the issue field", "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], "nullable": true }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true } }, "required": [ - "id", + "issue_field_id", "node_id", - "url", - "name", - "description", - "color", - "default" + "data_type", + "value" ] } }, @@ -420058,22 +419958,33 @@ "default": { "value": [ { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" }, { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" } ] } @@ -420081,8 +419992,8 @@ } } }, - "301": { - "description": "Moved permanently", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -420104,11 +420015,45 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -420133,8 +420078,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -420227,25 +420172,47 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "labels" + "subcategory": "issue-field-values" } }, "put": { - "summary": "Set labels for an issue", - "description": "Removes any previous labels and sets the new labels for an issue.", + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/set-labels", + "operationId": "issues/set-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#set-labels-for-an-issue" + "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" }, "parameters": [ { @@ -420277,77 +420244,76 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue).\"", - "items": { - "type": "string" - } - } - } - }, - { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - { - "type": "object", - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - }, - "required": [ - "name" - ] - } - } - } - }, - { + "type": "object", + "properties": { + "issue_field_values": { "type": "array", - "minItems": 1, + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", "items": { "type": "object", "properties": { - "name": { - "type": "string" + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" } }, "required": [ - "name" - ] - } - }, - { - "type": "string" + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 } - ] + } }, "examples": { "default": { + "summary": "Set multiple field values", "value": { - "labels": [ - "bug", - "enhancement" + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } ] } } @@ -420362,57 +420328,85 @@ "application/json": { "schema": { "type": "array", + "description": "The current issue field values for this issue after setting the new values", "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "title": "Issue Field Value", + "description": "A value assigned to an issue field", "type": "object", "properties": { - "id": { - "description": "Unique identifier for the label.", + "issue_field_id": { + "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", - "example": 208045946 + "example": 1 }, "node_id": { "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + "example": "IFT_GDKND" }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", + "data_type": { + "description": "The data type of the issue field", "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], "nullable": true }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true } }, "required": [ - "id", + "issue_field_id", "node_id", - "url", - "name", - "description", - "color", - "default" + "data_type", + "value" ] } }, @@ -420420,22 +420414,33 @@ "default": { "value": [ { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" }, { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" } ] } @@ -420443,8 +420448,8 @@ } } }, - "301": { - "description": "Moved permanently", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -420466,11 +420471,45 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -420495,8 +420534,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -420589,25 +420628,49 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "labels" + "subcategory": "issue-field-values" } - }, + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { "delete": { - "summary": "Remove all labels from an issue", - "description": "Removes all labels from an issue.", + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/remove-all-labels", + "operationId": "issues/delete-issue-field-value", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue" + "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" }, "parameters": [ { @@ -420636,14 +420699,23 @@ "schema": { "type": "integer" } + }, + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { "204": { - "description": "Response" + "description": "Issue field value deleted successfully" }, - "301": { - "description": "Moved permanently", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -420694,14 +420766,18 @@ } } }, - "410": { - "description": "Gone", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -420709,10 +420785,70 @@ "documentation_url": { "type": "string" }, - "url": { + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { "type": "string" }, - "status": { + "message": { + "type": "string" + }, + "documentation_url": { "type": "string" } } @@ -420722,24 +420858,25 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "labels" + "subcategory": "issue-field-values" } } }, - "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { - "delete": { - "summary": "Remove a label from an issue", - "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + "get": { + "summary": "List labels for an issue", + "description": "Lists all labels for an issue.", "tags": [ "issues" ], - "operationId": "issues/remove-label", + "operationId": "issues/list-labels-on-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue" + "url": "https://docs.github.com/rest/issues/labels#list-labels-for-an-issue" }, "parameters": [ { @@ -420770,11 +420907,21 @@ } }, { - "name": "name", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } ], @@ -420850,11 +420997,28 @@ "description": "Something isn't working", "color": "f29513", "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false } ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, "301": { @@ -420942,19 +421106,17 @@ "category": "issues", "subcategory": "labels" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/lock": { - "put": { - "summary": "Lock an issue", - "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + }, + "post": { + "summary": "Add labels to an issue", + "description": "Adds labels to an issue.", "tags": [ "issues" ], - "operationId": "issues/lock", + "operationId": "issues/add-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#lock-an-issue" + "url": "https://docs.github.com/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -420990,26 +421152,49 @@ "content": { "application/json": { "schema": { - "type": "object", - "nullable": true, - "properties": { - "lock_reason": { - "type": "string", - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`", - "enum": [ - "off-topic", - "too heated", - "resolved", - "spam" - ] + "oneOf": [ + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\"", + "items": { + "type": "string" + } + } + } + }, + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } } - } + ] }, "examples": { "default": { - "summary": "Example of locking an issue as off-topic", "value": { - "lock_reason": "off-topic" + "labels": [ + "bug", + "enhancement" + ] } } } @@ -421017,11 +421202,95 @@ } }, "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + } + } + } + } }, - "403": { - "description": "Forbidden", + "301": { + "description": "Moved permanently", "content": { "application/json": { "schema": { @@ -421046,8 +421315,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -421072,8 +421341,8 @@ } } }, - "404": { - "description": "Resource not found", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -421172,19 +421441,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "labels" } }, - "delete": { - "summary": "Unlock an issue", - "description": "Users with push access can unlock an issue's conversation.", + "put": { + "summary": "Set labels for an issue", + "description": "Removes any previous labels and sets the new labels for an issue.", "tags": [ "issues" ], - "operationId": "issues/unlock", + "operationId": "issues/set-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#unlock-an-issue" + "url": "https://docs.github.com/rest/issues/labels#set-labels-for-an-issue" }, "parameters": [ { @@ -421215,65 +421484,1004 @@ } } ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue).\"", + "items": { + "type": "string" + } + } } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { + }, + { + "type": "array", + "minItems": 1, + "items": { "type": "string" } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, + }, + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + { + "type": "string" + } + ] + }, + "examples": { + "default": { + "value": { + "labels": [ + "bug", + "enhancement" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + } + } + } + } + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "delete": { + "summary": "Remove all labels from an issue", + "description": "Removes all labels from an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-all-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + "delete": { + "summary": "Remove a label from an issue", + "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ] + } + } + } + } + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + "put": { + "summary": "Lock an issue", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "issues" + ], + "operationId": "issues/lock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#lock-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "lock_reason": { + "type": "string", + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`", + "enum": [ + "off-topic", + "too heated", + "resolved", + "spam" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of locking an issue as off-topic", + "value": { + "lock_reason": "off-topic" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + } + }, + "delete": { + "summary": "Unlock an issue", + "description": "Users with push access can unlock an issue's conversation.", + "tags": [ + "issues" + ], + "operationId": "issues/unlock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#unlock-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", "subcategory": "issues" @@ -479353,6 +480561,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -545261,1099 +546817,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_field_id", - "description": "The unique identifier of the issue field.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/search/code": { "get": { "summary": "Search code", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index dbd202eb49..adeb1df704 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -994,7 +994,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &664 + - &665 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -11981,7 +11981,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &572 + properties: &573 pinned_at: type: string format: date-time @@ -11993,7 +11993,7 @@ paths: properties: *20 required: *21 nullable: true - required: &573 + required: &574 - pinned_at - pinned_by nullable: true @@ -12788,7 +12788,7 @@ paths: type: string release: allOf: - - &606 + - &607 title: Release description: A release. type: object @@ -12859,7 +12859,7 @@ paths: author: *4 assets: type: array - items: &607 + items: &608 title: Release Asset description: Data related to a release. type: object @@ -16616,7 +16616,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &582 + - &583 name: all description: If `true`, show notifications marked as read. in: query @@ -16624,7 +16624,7 @@ paths: schema: type: boolean default: false - - &583 + - &584 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16634,7 +16634,7 @@ paths: type: boolean default: false - *93 - - &584 + - &585 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -17162,7 +17162,7 @@ paths: - url - subscription_url examples: - default: &585 + default: &586 value: - id: '1' repository: @@ -20620,6 +20620,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -20630,6 +20639,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -38643,6 +38657,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -38702,6 +38717,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -38739,7 +38763,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -38831,8 +38855,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -38840,6 +38864,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -38871,13 +38896,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -38916,6 +38953,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -38957,6 +39004,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39022,6 +39070,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -39145,7 +39202,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -39242,6 +39299,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -39273,13 +39331,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -39907,7 +39977,7 @@ paths: - review_comment - self author_association: *83 - auto_merge: &592 + auto_merge: &593 title: Auto merge description: The status of auto merging a pull request. type: object @@ -44057,7 +44127,7 @@ paths: - *76 - *17 - *19 - - &614 + - &615 name: targets description: | A comma-separated list of rule targets to filter by. @@ -44338,7 +44408,7 @@ paths: - repository_property rules: type: array - items: &615 + items: &616 title: Repository Rule type: object description: A repository rule. @@ -44400,7 +44470,7 @@ paths: type: string enum: - required_linear_history - - &613 + - &614 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -45302,7 +45372,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *76 - - &616 + - &617 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -45317,7 +45387,7 @@ paths: in: query schema: type: string - - &617 + - &618 name: time_period description: |- The time period to filter by. @@ -45333,14 +45403,14 @@ paths: - week - month default: day - - &618 + - &619 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &619 + - &620 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -45360,7 +45430,7 @@ paths: description: Response content: application/json: - schema: &620 + schema: &621 title: Rule Suites description: Response type: array @@ -45415,7 +45485,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &621 + default: &622 value: - id: 21 actor_id: 12 @@ -45459,7 +45529,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *76 - - &622 + - &623 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -45475,7 +45545,7 @@ paths: description: Response content: application/json: - schema: &623 + schema: &624 title: Rule Suite description: Response type: object @@ -45574,7 +45644,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &624 + default: &625 value: id: 21 actor_id: 12 @@ -45821,7 +45891,7 @@ paths: type: string format: date-time examples: - default: &626 + default: &627 value: - version_id: 3 actor: @@ -45874,7 +45944,7 @@ paths: description: Response content: application/json: - schema: &627 + schema: &628 allOf: - *327 - type: object @@ -45946,7 +46016,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *76 - - &628 + - &629 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -45957,7 +46027,7 @@ paths: enum: - open - resolved - - &629 + - &630 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -45967,7 +46037,7 @@ paths: required: false schema: type: string - - &630 + - &631 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -45978,7 +46048,7 @@ paths: required: false schema: type: string - - &631 + - &632 name: exclude_providers in: query description: |- @@ -45989,7 +46059,7 @@ paths: required: false schema: type: string - - &632 + - &633 name: providers in: query description: |- @@ -46000,7 +46070,7 @@ paths: required: false schema: type: string - - &633 + - &634 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -46009,7 +46079,7 @@ paths: required: false schema: type: string - - &634 + - &635 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -46028,7 +46098,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &635 + - &636 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -46043,7 +46113,7 @@ paths: - *62 - *19 - *17 - - &636 + - &637 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -46053,7 +46123,7 @@ paths: required: false schema: type: string - - &637 + - &638 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -46063,7 +46133,7 @@ paths: required: false schema: type: string - - &638 + - &639 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -46072,7 +46142,7 @@ paths: required: false schema: type: string - - &639 + - &640 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -46081,7 +46151,7 @@ paths: schema: type: boolean default: false - - &640 + - &641 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -46090,7 +46160,7 @@ paths: schema: type: boolean default: false - - &641 + - &642 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -46125,14 +46195,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &642 + state: &643 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &643 + resolution: &644 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -46249,8 +46319,8 @@ paths: pull request. ' - oneOf: &644 - - &646 + oneOf: &645 + - &647 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -46308,7 +46378,7 @@ paths: - blob_url - commit_sha - commit_url - - &647 + - &648 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -46363,7 +46433,7 @@ paths: - page_url - commit_sha - commit_url - - &648 + - &649 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -46383,7 +46453,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &649 + - &650 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -46403,7 +46473,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &650 + - &651 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -46423,7 +46493,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &651 + - &652 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -46437,7 +46507,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &652 + - &653 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -46451,7 +46521,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &653 + - &654 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -46465,7 +46535,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &654 + - &655 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -46485,7 +46555,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &655 + - &656 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -46505,7 +46575,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &656 + - &657 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -46525,7 +46595,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &657 + - &658 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -46545,7 +46615,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &658 + - &659 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -47064,7 +47134,7 @@ paths: application/json: schema: type: array - items: &662 + items: &663 description: A repository security advisory. type: object properties: @@ -47336,7 +47406,7 @@ paths: - private_fork additionalProperties: false examples: - default: &663 + default: &664 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -67842,7 +67912,7 @@ paths: type: array items: *476 examples: - default: &599 + default: &600 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -68133,7 +68203,7 @@ paths: type: array items: *480 examples: - default: &591 + default: &592 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -68691,7 +68761,7 @@ paths: application/json: schema: *476 examples: - default: &578 + default: &579 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69350,7 +69420,7 @@ paths: application/json: schema: type: array - items: &667 + items: &668 title: Status description: The status of a commit. type: object @@ -70319,7 +70389,7 @@ paths: - size - type - url - - &604 + - &605 title: Content File description: Content File type: object @@ -70933,7 +71003,7 @@ paths: items: type: object properties: - placeholder_id: &659 + placeholder_id: &660 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -81001,7 +81071,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &559 + - &560 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -81055,7 +81125,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &560 + - &561 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -81191,7 +81261,7 @@ paths: - performed_via_github_app - assignee - assigner - - &561 + - &562 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -81242,7 +81312,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &562 + - &563 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -81293,7 +81363,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &563 + - &564 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -81347,7 +81417,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &564 + - &565 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -81394,7 +81464,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &565 + - &566 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -81441,7 +81511,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &566 + - &567 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -81501,7 +81571,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &567 + - &568 title: Locked Issue Event description: Locked Issue Event type: object @@ -81549,7 +81619,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &568 + - &569 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -81615,7 +81685,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &569 + - &570 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -81681,7 +81751,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &570 + - &571 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -81747,7 +81817,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &571 + - &572 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -81869,7 +81939,7 @@ paths: type: array items: *557 examples: - default: &673 + default: &558 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -81901,6 +81971,250 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - *342 + - *343 + - *554 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: *557 + examples: + default: *558 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *120 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - *342 + - *343 + - *554 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: *557 + examples: + default: *558 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *120 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - *342 + - *343 + - *554 + - *241 + responses: + '204': + description: Issue field value deleted successfully + '403': *29 + '404': *6 + '422': *15 + '503': *120 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -81926,7 +82240,7 @@ paths: type: array items: *85 examples: - default: &558 + default: &559 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82009,7 +82323,7 @@ paths: type: array items: *85 examples: - default: *558 + default: *559 '301': *346 '404': *6 '410': *545 @@ -82093,7 +82407,7 @@ paths: type: array items: *85 examples: - default: *558 + default: *559 '301': *346 '404': *6 '410': *545 @@ -82684,7 +82998,6 @@ paths: description: Timeline Event type: object anyOf: - - *559 - *560 - *561 - *562 @@ -82697,6 +83010,7 @@ paths: - *569 - *570 - *571 + - *572 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -82757,8 +83071,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *572 - required: *573 + properties: *573 + required: *574 nullable: true required: - event @@ -83013,7 +83327,7 @@ paths: type: string comments: type: array - items: &593 + items: &594 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -83545,7 +83859,7 @@ paths: application/json: schema: type: array - items: &574 + items: &575 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -83648,9 +83962,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *575 examples: - default: &575 + default: &576 value: id: 1 key: ssh-rsa AAA... @@ -83686,7 +84000,7 @@ paths: parameters: - *342 - *343 - - &576 + - &577 name: key_id description: The unique identifier of the key. in: path @@ -83698,9 +84012,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *575 examples: - default: *575 + default: *576 '404': *6 x-github: githubCloudOnly: false @@ -83720,7 +84034,7 @@ paths: parameters: - *342 - *343 - - *576 + - *577 responses: '204': description: Response @@ -83753,7 +84067,7 @@ paths: type: array items: *85 examples: - default: *558 + default: *559 headers: Link: *68 '404': *6 @@ -83813,7 +84127,7 @@ paths: application/json: schema: *85 examples: - default: &577 + default: &578 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -83859,7 +84173,7 @@ paths: application/json: schema: *85 examples: - default: *577 + default: *578 '404': *6 x-github: githubCloudOnly: false @@ -84259,7 +84573,7 @@ paths: application/json: schema: *476 examples: - default: *578 + default: *579 '204': description: Response when already merged '404': @@ -84326,7 +84640,7 @@ paths: application/json: schema: type: array - items: &579 + items: &580 title: Milestone description: A collection of related issues and pull requests. type: object @@ -84428,9 +84742,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: &580 + default: &581 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -84491,7 +84805,7 @@ paths: parameters: - *342 - *343 - - &581 + - &582 name: milestone_number description: The number that identifies the milestone. in: path @@ -84503,9 +84817,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *580 + default: *581 '404': *6 x-github: githubCloudOnly: false @@ -84524,7 +84838,7 @@ paths: parameters: - *342 - *343 - - *581 + - *582 requestBody: required: false content: @@ -84562,9 +84876,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *580 + default: *581 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84582,7 +84896,7 @@ paths: parameters: - *342 - *343 - - *581 + - *582 responses: '204': description: Response @@ -84605,7 +84919,7 @@ paths: parameters: - *342 - *343 - - *581 + - *582 - *17 - *19 responses: @@ -84617,7 +84931,7 @@ paths: type: array items: *85 examples: - default: *558 + default: *559 headers: Link: *68 x-github: @@ -84638,10 +84952,10 @@ paths: parameters: - *342 - *343 - - *582 - *583 - - *93 - *584 + - *93 + - *585 - *17 - *19 responses: @@ -84653,7 +84967,7 @@ paths: type: array items: *113 examples: - default: *585 + default: *586 headers: Link: *68 x-github: @@ -84743,7 +85057,7 @@ paths: description: Response content: application/json: - schema: &586 + schema: &587 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -84868,7 +85182,7 @@ paths: - custom_404 - public examples: - default: &587 + default: &588 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -84964,9 +85278,9 @@ paths: description: Response content: application/json: - schema: *586 + schema: *587 examples: - default: *587 + default: *588 '422': *15 '409': *54 x-github: @@ -85127,7 +85441,7 @@ paths: application/json: schema: type: array - items: &588 + items: &589 title: Page Build description: Page Build type: object @@ -85274,9 +85588,9 @@ paths: description: Response content: application/json: - schema: *588 + schema: *589 examples: - default: &589 + default: &590 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -85336,9 +85650,9 @@ paths: description: Response content: application/json: - schema: *588 + schema: *589 examples: - default: *589 + default: *590 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85466,7 +85780,7 @@ paths: parameters: - *342 - *343 - - &590 + - &591 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -85526,7 +85840,7 @@ paths: parameters: - *342 - *343 - - *590 + - *591 responses: '204': *61 '404': *6 @@ -86061,7 +86375,7 @@ paths: type: array items: *480 examples: - default: *591 + default: *592 headers: Link: *68 '304': *37 @@ -86159,7 +86473,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &596 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -86359,7 +86673,7 @@ paths: - review_comment - self author_association: *83 - auto_merge: *592 + auto_merge: *593 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -86449,7 +86763,7 @@ paths: - merged_by - review_comments examples: - default: &596 + default: &597 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -86986,9 +87300,9 @@ paths: application/json: schema: type: array - items: *593 + items: *594 examples: - default: &598 + default: &599 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87073,9 +87387,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: - default: &594 + default: &595 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87174,9 +87488,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: - default: *594 + default: *595 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87379,7 +87693,7 @@ paths: parameters: - *342 - *343 - - &597 + - &598 name: pull_number description: The number that identifies the pull request. in: path @@ -87392,9 +87706,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *595 + schema: *596 examples: - default: *596 + default: *597 '304': *37 '404': *6 '406': @@ -87431,7 +87745,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: false content: @@ -87473,11 +87787,66 @@ paths: description: Response content: application/json: - schema: *595 + schema: *596 examples: - default: *596 + default: *597 + '422': *15 + '403': *29 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request + parameters: + - *342 + - *343 + - *598 + responses: + '204': + description: Response + '403': *29 + '404': *6 '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *342 + - *343 + - *598 + responses: + '204': + description: Response '403': *29 + '404': *6 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87499,7 +87868,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: true content: @@ -87601,7 +87970,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 - *110 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -87622,9 +87991,9 @@ paths: application/json: schema: type: array - items: *593 + items: *594 examples: - default: *598 + default: *599 headers: Link: *68 x-github: @@ -87659,7 +88028,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: true content: @@ -87764,7 +88133,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: example-for-a-multi-line-comment: value: @@ -87854,7 +88223,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 - *102 requestBody: required: true @@ -87877,7 +88246,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: default: value: @@ -87965,7 +88334,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 - *17 - *19 responses: @@ -87977,7 +88346,7 @@ paths: type: array items: *476 examples: - default: *599 + default: *600 headers: Link: *68 x-github: @@ -88009,7 +88378,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 - *17 - *19 responses: @@ -88059,7 +88428,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 responses: '204': description: Response if pull request has been merged @@ -88084,7 +88453,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: false content: @@ -88197,7 +88566,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 responses: '200': description: Response @@ -88274,7 +88643,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: false content: @@ -88849,7 +89218,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: true content: @@ -89370,7 +89739,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 - *17 - *19 responses: @@ -89380,7 +89749,7 @@ paths: application/json: schema: type: array - items: &600 + items: &601 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -89533,7 +89902,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: false content: @@ -89619,9 +89988,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: - default: &602 + default: &603 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -89686,8 +90055,8 @@ paths: parameters: - *342 - *343 - - *597 - - &601 + - *598 + - &602 name: review_id description: The unique identifier of the review. in: path @@ -89699,9 +90068,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: - default: &603 + default: &604 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -89762,8 +90131,8 @@ paths: parameters: - *342 - *343 - - *597 - - *601 + - *598 + - *602 requestBody: required: true content: @@ -89786,7 +90155,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -89850,16 +90219,16 @@ paths: parameters: - *342 - *343 - - *597 - - *601 + - *598 + - *602 responses: '200': description: Response content: application/json: - schema: *600 + schema: *601 examples: - default: *602 + default: *603 '422': *7 '404': *6 x-github: @@ -89888,8 +90257,8 @@ paths: parameters: - *342 - *343 - - *597 - - *601 + - *598 + - *602 - *17 - *19 responses: @@ -90126,8 +90495,8 @@ paths: parameters: - *342 - *343 - - *597 - - *601 + - *598 + - *602 requestBody: required: true content: @@ -90155,7 +90524,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -90220,8 +90589,8 @@ paths: parameters: - *342 - *343 - - *597 - - *601 + - *598 + - *602 requestBody: required: true content: @@ -90256,9 +90625,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: - default: *603 + default: *604 '404': *6 '422': *7 '403': *29 @@ -90282,7 +90651,7 @@ paths: parameters: - *342 - *343 - - *597 + - *598 requestBody: required: false content: @@ -90359,9 +90728,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *605 examples: - default: &605 + default: &606 value: type: file encoding: base64 @@ -90424,9 +90793,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *605 examples: - default: *605 + default: *606 '404': *6 '422': *15 x-github: @@ -90459,7 +90828,7 @@ paths: application/json: schema: type: array - items: *606 + items: *607 examples: default: value: @@ -90630,9 +90999,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *607 examples: - default: &610 + default: &611 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -90739,7 +91108,7 @@ paths: parameters: - *342 - *343 - - &608 + - &609 name: asset_id description: The unique identifier of the asset. in: path @@ -90751,9 +91120,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: - default: &609 + default: &610 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -90806,7 +91175,7 @@ paths: parameters: - *342 - *343 - - *608 + - *609 requestBody: required: false content: @@ -90834,9 +91203,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: - default: *609 + default: *610 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90854,7 +91223,7 @@ paths: parameters: - *342 - *343 - - *608 + - *609 responses: '204': description: Response @@ -90972,9 +91341,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *607 examples: - default: *610 + default: *611 '404': *6 x-github: githubCloudOnly: false @@ -91006,9 +91375,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *607 examples: - default: *610 + default: *611 '404': *6 x-github: githubCloudOnly: false @@ -91032,7 +91401,7 @@ paths: parameters: - *342 - *343 - - &611 + - &612 name: release_id description: The unique identifier of the release. in: path @@ -91046,9 +91415,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *606 + schema: *607 examples: - default: *610 + default: *611 '401': description: Unauthorized x-github: @@ -91068,7 +91437,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 requestBody: required: false content: @@ -91132,9 +91501,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *607 examples: - default: *610 + default: *611 '404': description: Not Found if the discussion category name is invalid content: @@ -91157,7 +91526,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 responses: '204': description: Response @@ -91180,7 +91549,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 - *17 - *19 responses: @@ -91190,7 +91559,7 @@ paths: application/json: schema: type: array - items: *607 + items: *608 examples: default: value: @@ -91273,7 +91642,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 - name: name in: query required: true @@ -91299,7 +91668,7 @@ paths: description: Response for successful upload content: application/json: - schema: *607 + schema: *608 examples: response-for-successful-upload: value: @@ -91356,7 +91725,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -91405,7 +91774,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 requestBody: required: true content: @@ -91468,7 +91837,7 @@ paths: parameters: - *342 - *343 - - *611 + - *612 - *549 responses: '204': @@ -91512,7 +91881,7 @@ paths: oneOf: - allOf: - *303 - - &612 + - &613 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -91533,67 +91902,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *304 - - *612 + - *613 - allOf: - *305 - - *612 + - *613 - allOf: - *306 - - *612 + - *613 - allOf: + - *614 - *613 - - *612 - allOf: - *307 - - *612 + - *613 - allOf: - *308 - - *612 + - *613 - allOf: - *309 - - *612 + - *613 - allOf: - *310 - - *612 + - *613 - allOf: - *311 - - *612 + - *613 - allOf: - *312 - - *612 + - *613 - allOf: - *313 - - *612 + - *613 - allOf: - *314 - - *612 + - *613 - allOf: - *315 - - *612 + - *613 - allOf: - *316 - - *612 + - *613 - allOf: - *317 - - *612 + - *613 - allOf: - *318 - - *612 + - *613 - allOf: - *319 - - *612 + - *613 - allOf: - *320 - - *612 + - *613 - allOf: - *321 - - *612 + - *613 - allOf: - *322 - - *612 + - *613 - allOf: - *323 - - *612 + - *613 examples: default: value: @@ -91644,7 +92013,7 @@ paths: schema: type: boolean default: true - - *614 + - *615 responses: '200': description: Response @@ -91729,7 +92098,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *615 + items: *616 required: - name - enforcement @@ -91762,7 +92131,7 @@ paths: application/json: schema: *324 examples: - default: &625 + default: &626 value: id: 42 name: super cool ruleset @@ -91812,10 +92181,10 @@ paths: parameters: - *342 - *343 - - *616 - *617 - *618 - *619 + - *620 - *17 - *19 responses: @@ -91823,9 +92192,9 @@ paths: description: Response content: application/json: - schema: *620 + schema: *621 examples: - default: *621 + default: *622 '404': *6 '500': *55 x-github: @@ -91848,15 +92217,15 @@ paths: parameters: - *342 - *343 - - *622 + - *623 responses: '200': description: Response content: application/json: - schema: *623 + schema: *624 examples: - default: *624 + default: *625 '404': *6 '500': *55 x-github: @@ -91907,7 +92276,7 @@ paths: application/json: schema: *324 examples: - default: *625 + default: *626 '404': *6 '500': *55 put: @@ -91960,7 +92329,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *615 + items: *616 examples: default: value: @@ -91990,7 +92359,7 @@ paths: application/json: schema: *324 examples: - default: *625 + default: *626 '404': *6 '422': *15 '500': *55 @@ -92052,7 +92421,7 @@ paths: type: array items: *327 examples: - default: *626 + default: *627 '404': *6 '500': *55 x-github: @@ -92090,7 +92459,7 @@ paths: description: Response content: application/json: - schema: *627 + schema: *628 examples: default: value: @@ -92147,7 +92516,6 @@ paths: parameters: - *342 - *343 - - *628 - *629 - *630 - *631 @@ -92155,15 +92523,16 @@ paths: - *633 - *634 - *635 + - *636 - *62 - *19 - *17 - - *636 - *637 - *638 - *639 - *640 - *641 + - *642 responses: '200': description: Response @@ -92171,7 +92540,7 @@ paths: application/json: schema: type: array - items: &645 + items: &646 type: object properties: number: *177 @@ -92190,8 +92559,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *642 - resolution: *643 + state: *643 + resolution: *644 resolved_at: type: string format: date-time @@ -92297,7 +92666,7 @@ paths: pull request. ' - oneOf: *644 + oneOf: *645 nullable: true has_more_locations: type: boolean @@ -92464,13 +92833,13 @@ paths: - *342 - *343 - *440 - - *641 + - *642 responses: '200': description: Response content: application/json: - schema: *645 + schema: *646 examples: default: value: @@ -92534,8 +92903,8 @@ paths: schema: type: object properties: - state: *642 - resolution: *643 + state: *643 + resolution: *644 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -92571,7 +92940,7 @@ paths: description: Response content: application/json: - schema: *645 + schema: *646 examples: default: value: @@ -92705,7 +93074,6 @@ paths: example: commit details: oneOf: - - *646 - *647 - *648 - *649 @@ -92718,6 +93086,7 @@ paths: - *656 - *657 - *658 + - *659 examples: default: value: @@ -92812,14 +93181,14 @@ paths: schema: type: object properties: - reason: &660 + reason: &661 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *659 + placeholder_id: *660 required: - reason - placeholder_id @@ -92836,7 +93205,7 @@ paths: schema: type: object properties: - reason: *660 + reason: *661 expire_at: type: string format: date-time @@ -92898,7 +93267,7 @@ paths: properties: incremental_scans: type: array - items: &661 + items: &662 description: Information on a single scan performed by secret scanning on the repository type: object @@ -92924,15 +93293,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *661 + items: *662 backfill_scans: type: array - items: *661 + items: *662 custom_pattern_backfill_scans: type: array items: allOf: - - *661 + - *662 - type: object properties: pattern_name: @@ -92945,7 +93314,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *661 + items: *662 examples: default: value: @@ -93055,9 +93424,9 @@ paths: application/json: schema: type: array - items: *662 + items: *663 examples: - default: *663 + default: *664 '400': *14 '404': *6 x-github: @@ -93241,9 +93610,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: &665 + default: &666 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -93578,7 +93947,7 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: default: value: @@ -93726,15 +94095,15 @@ paths: parameters: - *342 - *343 - - *664 + - *665 responses: '200': description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: *665 + default: *666 '403': *29 '404': *6 x-github: @@ -93760,7 +94129,7 @@ paths: parameters: - *342 - *343 - - *664 + - *665 requestBody: required: true content: @@ -93919,10 +94288,10 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: *665 - add_credit: *665 + default: *666 + add_credit: *666 '403': *29 '404': *6 '422': @@ -93962,7 +94331,7 @@ paths: parameters: - *342 - *343 - - *664 + - *665 responses: '202': *39 '400': *14 @@ -93991,7 +94360,7 @@ paths: parameters: - *342 - *343 - - *664 + - *665 responses: '202': description: Response @@ -94135,7 +94504,7 @@ paths: application/json: schema: type: array - items: &666 + items: &667 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -94508,7 +94877,7 @@ paths: application/json: schema: type: array - items: *666 + items: *667 examples: default: value: @@ -94596,7 +94965,7 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: default: value: @@ -94690,7 +95059,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &668 + schema: &669 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -94785,7 +95154,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: default: value: @@ -94992,7 +95361,7 @@ paths: description: Response content: application/json: - schema: &669 + schema: &670 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -95004,7 +95373,7 @@ paths: required: - names examples: - default: &670 + default: &671 value: names: - octocat @@ -95059,9 +95428,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: *670 + default: *671 '404': *6 '422': *7 x-github: @@ -95084,7 +95453,7 @@ paths: parameters: - *342 - *343 - - &671 + - &672 name: per description: The time frame to display results for. in: query @@ -95113,7 +95482,7 @@ paths: example: 128 clones: type: array - items: &672 + items: &673 title: Traffic type: object properties: @@ -95354,7 +95723,7 @@ paths: parameters: - *342 - *343 - - *671 + - *672 responses: '200': description: Response @@ -95373,7 +95742,7 @@ paths: example: 3782 views: type: array - items: *672 + items: *673 required: - uniques - count @@ -96016,248 +96385,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - *148 - - *554 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: *557 - examples: - default: *673 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *120 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - *148 - - *554 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: *557 - examples: - default: *673 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *120 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - *148 - - *554 - - *241 - responses: - '204': - description: Issue field value deleted successfully - '403': *29 - '404': *6 - '422': *15 - '503': *120 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/search/code": get: summary: Search code @@ -103074,7 +103201,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *576 + - *577 responses: '200': description: Response @@ -103105,7 +103232,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *576 + - *577 responses: '204': description: Response @@ -119610,7 +119737,7 @@ x-webhooks: nullable: true pull_requests: type: array - items: *595 + items: *596 repository: *743 organization: *742 installation: *741 @@ -127691,8 +127818,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *572 - required: *573 + properties: *573 + required: *574 nullable: true user: title: User @@ -129155,8 +129282,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *572 - required: *573 + properties: *573 + required: *574 nullable: true required: - url @@ -166315,7 +166442,7 @@ x-webhooks: organization: *742 pull_request: &793 allOf: - - *595 + - *596 - type: object properties: allow_auto_merge: @@ -166544,7 +166671,7 @@ x-webhooks: enum: - demilestoned enterprise: *740 - milestone: *579 + milestone: *580 number: *792 organization: *742 pull_request: &794 @@ -178528,7 +178655,7 @@ x-webhooks: enum: - milestoned enterprise: *740 - milestone: *579 + milestone: *580 number: *792 organization: *742 pull_request: *794 @@ -220639,7 +220766,7 @@ x-webhooks: installation: *741 organization: *742 repository: *743 - repository_advisory: *662 + repository_advisory: *663 sender: *4 required: - action @@ -220719,7 +220846,7 @@ x-webhooks: installation: *741 organization: *742 repository: *743 - repository_advisory: *662 + repository_advisory: *663 sender: *4 required: - action @@ -221806,16 +221933,16 @@ x-webhooks: properties: added: type: array - items: *615 + items: *616 deleted: type: array - items: *615 + items: *616 updated: type: array items: type: object properties: - rule: *615 + rule: *616 changes: type: object properties: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 79f1f0c12c..738780d88f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -78364,6 +78364,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -78372,6 +78381,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -167604,7 +167617,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -167673,6 +167687,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -167817,7 +167843,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -167906,14 +167932,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -167949,12 +167976,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -168001,6 +168040,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -168049,7 +168100,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -168124,6 +168176,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -168450,7 +168514,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -168519,6 +168584,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -168587,7 +168664,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -168692,7 +168769,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -168728,12 +168806,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -439139,259 +439229,17 @@ "category": "issues", "subcategory": "issue-field-values" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - "get": { - "summary": "List labels for an issue", - "description": "Lists all labels for an issue.", - "tags": [ - "issues" - ], - "operationId": "issues/list-labels-on-issue", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#list-labels-for-an-issue" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "example": 208045946 - }, - "node_id": { - "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" - }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", - "nullable": true - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "301": { - "description": "Moved permanently", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "labels" - } }, "post": { - "summary": "Add labels to an issue", - "description": "Adds labels to an issue.", + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/add-labels", + "operationId": "issues/add-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" }, "parameters": [ { @@ -439423,52 +439271,76 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\"", - "items": { - "type": "string" - } - } - } - }, - { - "type": "array", - "items": { - "type": "string" - } - }, - { + "type": "object", + "properties": { + "issue_field_values": { "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", "items": { "type": "object", "properties": { - "name": { - "type": "string" + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" } }, "required": [ - "name" - ] - } + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 } - ] + } }, "examples": { "default": { + "summary": "Add multiple field values", "value": { - "labels": [ - "bug", - "enhancement" + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } ] } } @@ -439483,57 +439355,85 @@ "application/json": { "schema": { "type": "array", + "description": "The current issue field values for this issue after adding the new values", "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "title": "Issue Field Value", + "description": "A value assigned to an issue field", "type": "object", "properties": { - "id": { - "description": "Unique identifier for the label.", + "issue_field_id": { + "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", - "example": 208045946 + "example": 1 }, "node_id": { "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + "example": "IFT_GDKND" }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", + "data_type": { + "description": "The data type of the issue field", "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], "nullable": true }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true } }, "required": [ - "id", + "issue_field_id", "node_id", - "url", - "name", - "description", - "color", - "default" + "data_type", + "value" ] } }, @@ -439541,22 +439441,33 @@ "default": { "value": [ { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" }, { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" } ] } @@ -439564,8 +439475,8 @@ } } }, - "301": { - "description": "Moved permanently", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -439587,11 +439498,45 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -439616,8 +439561,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -439710,25 +439655,47 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "labels" + "subcategory": "issue-field-values" } }, "put": { - "summary": "Set labels for an issue", - "description": "Removes any previous labels and sets the new labels for an issue.", + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/set-labels", + "operationId": "issues/set-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#set-labels-for-an-issue" + "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" }, "parameters": [ { @@ -439760,77 +439727,76 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue).\"", - "items": { - "type": "string" - } - } - } - }, - { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - { - "type": "object", - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - }, - "required": [ - "name" - ] - } - } - } - }, - { + "type": "object", + "properties": { + "issue_field_values": { "type": "array", - "minItems": 1, + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", "items": { "type": "object", "properties": { - "name": { - "type": "string" + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" } }, "required": [ - "name" - ] - } - }, - { - "type": "string" + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 } - ] + } }, "examples": { "default": { + "summary": "Set multiple field values", "value": { - "labels": [ - "bug", - "enhancement" + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } ] } } @@ -439845,57 +439811,85 @@ "application/json": { "schema": { "type": "array", + "description": "The current issue field values for this issue after setting the new values", "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "title": "Issue Field Value", + "description": "A value assigned to an issue field", "type": "object", "properties": { - "id": { - "description": "Unique identifier for the label.", + "issue_field_id": { + "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", - "example": 208045946 + "example": 1 }, "node_id": { "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + "example": "IFT_GDKND" }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", + "data_type": { + "description": "The data type of the issue field", "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], "nullable": true }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true } }, "required": [ - "id", + "issue_field_id", "node_id", - "url", - "name", - "description", - "color", - "default" + "data_type", + "value" ] } }, @@ -439903,22 +439897,33 @@ "default": { "value": [ { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" }, { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" } ] } @@ -439926,8 +439931,8 @@ } } }, - "301": { - "description": "Moved permanently", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -439949,11 +439954,45 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -439978,8 +440017,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -440072,25 +440111,49 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "labels" + "subcategory": "issue-field-values" } - }, + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { "delete": { - "summary": "Remove all labels from an issue", - "description": "Removes all labels from an issue.", + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/remove-all-labels", + "operationId": "issues/delete-issue-field-value", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue" + "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" }, "parameters": [ { @@ -440119,14 +440182,23 @@ "schema": { "type": "integer" } + }, + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { "204": { - "description": "Response" + "description": "Issue field value deleted successfully" }, - "301": { - "description": "Moved permanently", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -440177,14 +440249,18 @@ } } }, - "410": { - "description": "Gone", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -440192,10 +440268,70 @@ "documentation_url": { "type": "string" }, - "url": { + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { "type": "string" }, - "status": { + "message": { + "type": "string" + }, + "documentation_url": { "type": "string" } } @@ -440205,24 +440341,25 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "labels" + "subcategory": "issue-field-values" } } }, - "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { - "delete": { - "summary": "Remove a label from an issue", - "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + "get": { + "summary": "List labels for an issue", + "description": "Lists all labels for an issue.", "tags": [ "issues" ], - "operationId": "issues/remove-label", + "operationId": "issues/list-labels-on-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue" + "url": "https://docs.github.com/rest/issues/labels#list-labels-for-an-issue" }, "parameters": [ { @@ -440253,11 +440390,21 @@ } }, { - "name": "name", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } ], @@ -440333,11 +440480,28 @@ "description": "Something isn't working", "color": "f29513", "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false } ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, "301": { @@ -440425,19 +440589,17 @@ "category": "issues", "subcategory": "labels" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/lock": { - "put": { - "summary": "Lock an issue", - "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + }, + "post": { + "summary": "Add labels to an issue", + "description": "Adds labels to an issue.", "tags": [ "issues" ], - "operationId": "issues/lock", + "operationId": "issues/add-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#lock-an-issue" + "url": "https://docs.github.com/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -440473,26 +440635,49 @@ "content": { "application/json": { "schema": { - "type": "object", - "nullable": true, - "properties": { - "lock_reason": { - "type": "string", - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`", - "enum": [ - "off-topic", - "too heated", - "resolved", - "spam" - ] + "oneOf": [ + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\"", + "items": { + "type": "string" + } + } + } + }, + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } } - } + ] }, "examples": { "default": { - "summary": "Example of locking an issue as off-topic", "value": { - "lock_reason": "off-topic" + "labels": [ + "bug", + "enhancement" + ] } } } @@ -440500,11 +440685,95 @@ } }, "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + } + } + } + } }, - "403": { - "description": "Forbidden", + "301": { + "description": "Moved permanently", "content": { "application/json": { "schema": { @@ -440529,8 +440798,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -440555,8 +440824,8 @@ } } }, - "404": { - "description": "Resource not found", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -440655,19 +440924,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "labels" } }, - "delete": { - "summary": "Unlock an issue", - "description": "Users with push access can unlock an issue's conversation.", + "put": { + "summary": "Set labels for an issue", + "description": "Removes any previous labels and sets the new labels for an issue.", "tags": [ "issues" ], - "operationId": "issues/unlock", + "operationId": "issues/set-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#unlock-an-issue" + "url": "https://docs.github.com/rest/issues/labels#set-labels-for-an-issue" }, "parameters": [ { @@ -440698,65 +440967,1004 @@ } } ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue).\"", + "items": { + "type": "string" + } + } } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { + }, + { + "type": "array", + "minItems": 1, + "items": { "type": "string" } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, + }, + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + { + "type": "string" + } + ] + }, + "examples": { + "default": { + "value": { + "labels": [ + "bug", + "enhancement" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + } + } + } + } + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "delete": { + "summary": "Remove all labels from an issue", + "description": "Removes all labels from an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-all-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + "delete": { + "summary": "Remove a label from an issue", + "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ] + } + } + } + } + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + "put": { + "summary": "Lock an issue", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "issues" + ], + "operationId": "issues/lock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#lock-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "lock_reason": { + "type": "string", + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`", + "enum": [ + "off-topic", + "too heated", + "resolved", + "spam" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of locking an issue as off-topic", + "value": { + "lock_reason": "off-topic" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + } + }, + "delete": { + "summary": "Unlock an issue", + "description": "Users with push access can unlock an issue's conversation.", + "tags": [ + "issues" + ], + "operationId": "issues/unlock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#unlock-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", "subcategory": "issues" @@ -502829,6 +504037,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -570948,1099 +572504,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_field_id", - "description": "The unique identifier of the issue field.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/search/code": { "get": { "summary": "Search code", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 5412b156b0..ecd1020040 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1074,7 +1074,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &667 + - &668 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -12231,7 +12231,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &575 + properties: &576 pinned_at: type: string format: date-time @@ -12243,7 +12243,7 @@ paths: properties: *20 required: *21 nullable: true - required: &576 + required: &577 - pinned_at - pinned_by nullable: true @@ -13082,7 +13082,7 @@ paths: type: string release: allOf: - - &609 + - &610 title: Release description: A release. type: object @@ -13153,7 +13153,7 @@ paths: author: *4 assets: type: array - items: &610 + items: &611 title: Release Asset description: Data related to a release. type: object @@ -17179,7 +17179,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &585 + - &586 name: all description: If `true`, show notifications marked as read. in: query @@ -17187,7 +17187,7 @@ paths: schema: type: boolean default: false - - &586 + - &587 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -17197,7 +17197,7 @@ paths: type: boolean default: false - *93 - - &587 + - &588 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -17733,7 +17733,7 @@ paths: - url - subscription_url examples: - default: &588 + default: &589 value: - id: '1' repository: @@ -21228,6 +21228,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -21238,6 +21247,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -39363,6 +39377,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39422,6 +39437,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -39459,7 +39483,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -39551,8 +39575,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -39560,6 +39584,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -39591,13 +39616,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -39636,6 +39673,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -39677,6 +39724,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39742,6 +39790,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -39865,7 +39922,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -39962,6 +40019,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -39993,13 +40051,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -40638,7 +40708,7 @@ paths: - review_comment - self author_association: *83 - auto_merge: &595 + auto_merge: &596 title: Auto merge description: The status of auto merging a pull request. type: object @@ -44892,7 +44962,7 @@ paths: - *76 - *17 - *19 - - &617 + - &618 name: targets description: | A comma-separated list of rule targets to filter by. @@ -45173,7 +45243,7 @@ paths: - repository_property rules: type: array - items: &618 + items: &619 title: Repository Rule type: object description: A repository rule. @@ -45235,7 +45305,7 @@ paths: type: string enum: - required_linear_history - - &616 + - &617 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -46137,7 +46207,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *76 - - &619 + - &620 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -46152,7 +46222,7 @@ paths: in: query schema: type: string - - &620 + - &621 name: time_period description: |- The time period to filter by. @@ -46168,14 +46238,14 @@ paths: - week - month default: day - - &621 + - &622 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &622 + - &623 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -46195,7 +46265,7 @@ paths: description: Response content: application/json: - schema: &623 + schema: &624 title: Rule Suites description: Response type: array @@ -46250,7 +46320,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &624 + default: &625 value: - id: 21 actor_id: 12 @@ -46294,7 +46364,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *76 - - &625 + - &626 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -46310,7 +46380,7 @@ paths: description: Response content: application/json: - schema: &626 + schema: &627 title: Rule Suite description: Response type: object @@ -46409,7 +46479,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &627 + default: &628 value: id: 21 actor_id: 12 @@ -46656,7 +46726,7 @@ paths: type: string format: date-time examples: - default: &629 + default: &630 value: - version_id: 3 actor: @@ -46709,7 +46779,7 @@ paths: description: Response content: application/json: - schema: &630 + schema: &631 allOf: - *329 - type: object @@ -46781,7 +46851,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *76 - - &631 + - &632 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -46792,7 +46862,7 @@ paths: enum: - open - resolved - - &632 + - &633 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -46802,7 +46872,7 @@ paths: required: false schema: type: string - - &633 + - &634 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -46813,7 +46883,7 @@ paths: required: false schema: type: string - - &634 + - &635 name: exclude_providers in: query description: |- @@ -46824,7 +46894,7 @@ paths: required: false schema: type: string - - &635 + - &636 name: providers in: query description: |- @@ -46835,7 +46905,7 @@ paths: required: false schema: type: string - - &636 + - &637 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -46844,7 +46914,7 @@ paths: required: false schema: type: string - - &637 + - &638 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -46863,7 +46933,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &638 + - &639 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -46878,7 +46948,7 @@ paths: - *62 - *19 - *17 - - &639 + - &640 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -46888,7 +46958,7 @@ paths: required: false schema: type: string - - &640 + - &641 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -46898,7 +46968,7 @@ paths: required: false schema: type: string - - &641 + - &642 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -46907,7 +46977,7 @@ paths: required: false schema: type: string - - &642 + - &643 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -46916,7 +46986,7 @@ paths: schema: type: boolean default: false - - &643 + - &644 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -46925,7 +46995,7 @@ paths: schema: type: boolean default: false - - &644 + - &645 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -46960,14 +47030,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &645 + state: &646 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &646 + resolution: &647 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -47084,8 +47154,8 @@ paths: pull request. ' - oneOf: &647 - - &649 + oneOf: &648 + - &650 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -47143,7 +47213,7 @@ paths: - blob_url - commit_sha - commit_url - - &650 + - &651 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -47198,7 +47268,7 @@ paths: - page_url - commit_sha - commit_url - - &651 + - &652 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -47218,7 +47288,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &652 + - &653 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -47238,7 +47308,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &653 + - &654 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -47258,7 +47328,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &654 + - &655 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -47272,7 +47342,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &655 + - &656 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -47286,7 +47356,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &656 + - &657 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -47300,7 +47370,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &657 + - &658 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -47320,7 +47390,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &658 + - &659 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -47340,7 +47410,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &659 + - &660 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -47360,7 +47430,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &660 + - &661 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -47380,7 +47450,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &661 + - &662 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -47899,7 +47969,7 @@ paths: application/json: schema: type: array - items: &665 + items: &666 description: A repository security advisory. type: object properties: @@ -48222,7 +48292,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &666 + default: &667 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -68930,7 +69000,7 @@ paths: type: array items: *478 examples: - default: &602 + default: &603 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69221,7 +69291,7 @@ paths: type: array items: *482 examples: - default: &594 + default: &595 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -69779,7 +69849,7 @@ paths: application/json: schema: *478 examples: - default: &581 + default: &582 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -70438,7 +70508,7 @@ paths: application/json: schema: type: array - items: &670 + items: &671 title: Status description: The status of a commit. type: object @@ -71407,7 +71477,7 @@ paths: - size - type - url - - &607 + - &608 title: Content File description: Content File type: object @@ -72051,7 +72121,7 @@ paths: items: type: object properties: - placeholder_id: &662 + placeholder_id: &663 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -82202,7 +82272,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &562 + - &563 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -82256,7 +82326,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &563 + - &564 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -82392,7 +82462,7 @@ paths: - performed_via_github_app - assignee - assigner - - &564 + - &565 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -82443,7 +82513,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &565 + - &566 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -82494,7 +82564,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &566 + - &567 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -82548,7 +82618,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &567 + - &568 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -82595,7 +82665,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &568 + - &569 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -82642,7 +82712,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &569 + - &570 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -82702,7 +82772,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &570 + - &571 title: Locked Issue Event description: Locked Issue Event type: object @@ -82750,7 +82820,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &571 + - &572 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -82816,7 +82886,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &572 + - &573 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -82882,7 +82952,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &573 + - &574 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -82948,7 +83018,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &574 + - &575 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -83070,7 +83140,7 @@ paths: type: array items: *560 examples: - default: &676 + default: &561 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -83102,6 +83172,250 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - *344 + - *345 + - *557 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: *560 + examples: + default: *561 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *120 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - *344 + - *345 + - *557 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: *560 + examples: + default: *561 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *120 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - *344 + - *345 + - *557 + - *242 + responses: + '204': + description: Issue field value deleted successfully + '403': *29 + '404': *6 + '422': *15 + '503': *120 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -83127,7 +83441,7 @@ paths: type: array items: *85 examples: - default: &561 + default: &562 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -83210,7 +83524,7 @@ paths: type: array items: *85 examples: - default: *561 + default: *562 '301': *348 '404': *6 '410': *547 @@ -83294,7 +83608,7 @@ paths: type: array items: *85 examples: - default: *561 + default: *562 '301': *348 '404': *6 '410': *547 @@ -83885,7 +84199,6 @@ paths: description: Timeline Event type: object anyOf: - - *562 - *563 - *564 - *565 @@ -83898,6 +84211,7 @@ paths: - *572 - *573 - *574 + - *575 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -83958,8 +84272,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *575 - required: *576 + properties: *576 + required: *577 nullable: true required: - event @@ -84214,7 +84528,7 @@ paths: type: string comments: type: array - items: &596 + items: &597 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -84746,7 +85060,7 @@ paths: application/json: schema: type: array - items: &577 + items: &578 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -84849,9 +85163,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: &578 + default: &579 value: id: 1 key: ssh-rsa AAA... @@ -84887,7 +85201,7 @@ paths: parameters: - *344 - *345 - - &579 + - &580 name: key_id description: The unique identifier of the key. in: path @@ -84899,9 +85213,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '404': *6 x-github: githubCloudOnly: false @@ -84921,7 +85235,7 @@ paths: parameters: - *344 - *345 - - *579 + - *580 responses: '204': description: Response @@ -84954,7 +85268,7 @@ paths: type: array items: *85 examples: - default: *561 + default: *562 headers: Link: *68 '404': *6 @@ -85014,7 +85328,7 @@ paths: application/json: schema: *85 examples: - default: &580 + default: &581 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -85060,7 +85374,7 @@ paths: application/json: schema: *85 examples: - default: *580 + default: *581 '404': *6 x-github: githubCloudOnly: false @@ -85460,7 +85774,7 @@ paths: application/json: schema: *478 examples: - default: *581 + default: *582 '204': description: Response when already merged '404': @@ -85527,7 +85841,7 @@ paths: application/json: schema: type: array - items: &582 + items: &583 title: Milestone description: A collection of related issues and pull requests. type: object @@ -85629,9 +85943,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *583 examples: - default: &583 + default: &584 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -85692,7 +86006,7 @@ paths: parameters: - *344 - *345 - - &584 + - &585 name: milestone_number description: The number that identifies the milestone. in: path @@ -85704,9 +86018,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *583 examples: - default: *583 + default: *584 '404': *6 x-github: githubCloudOnly: false @@ -85725,7 +86039,7 @@ paths: parameters: - *344 - *345 - - *584 + - *585 requestBody: required: false content: @@ -85763,9 +86077,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *583 examples: - default: *583 + default: *584 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85783,7 +86097,7 @@ paths: parameters: - *344 - *345 - - *584 + - *585 responses: '204': description: Response @@ -85806,7 +86120,7 @@ paths: parameters: - *344 - *345 - - *584 + - *585 - *17 - *19 responses: @@ -85818,7 +86132,7 @@ paths: type: array items: *85 examples: - default: *561 + default: *562 headers: Link: *68 x-github: @@ -85839,10 +86153,10 @@ paths: parameters: - *344 - *345 - - *585 - *586 - - *93 - *587 + - *93 + - *588 - *17 - *19 responses: @@ -85854,7 +86168,7 @@ paths: type: array items: *113 examples: - default: *588 + default: *589 headers: Link: *68 x-github: @@ -85944,7 +86258,7 @@ paths: description: Response content: application/json: - schema: &589 + schema: &590 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -86069,7 +86383,7 @@ paths: - custom_404 - public examples: - default: &590 + default: &591 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -86165,9 +86479,9 @@ paths: description: Response content: application/json: - schema: *589 + schema: *590 examples: - default: *590 + default: *591 '422': *15 '409': *54 x-github: @@ -86328,7 +86642,7 @@ paths: application/json: schema: type: array - items: &591 + items: &592 title: Page Build description: Page Build type: object @@ -86475,9 +86789,9 @@ paths: description: Response content: application/json: - schema: *591 + schema: *592 examples: - default: &592 + default: &593 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -86537,9 +86851,9 @@ paths: description: Response content: application/json: - schema: *591 + schema: *592 examples: - default: *592 + default: *593 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86667,7 +86981,7 @@ paths: parameters: - *344 - *345 - - &593 + - &594 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -86727,7 +87041,7 @@ paths: parameters: - *344 - *345 - - *593 + - *594 responses: '204': *61 '404': *6 @@ -87262,7 +87576,7 @@ paths: type: array items: *482 examples: - default: *594 + default: *595 headers: Link: *68 '304': *37 @@ -87360,7 +87674,7 @@ paths: description: Response content: application/json: - schema: &598 + schema: &599 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -87571,7 +87885,7 @@ paths: - review_comment - self author_association: *83 - auto_merge: *595 + auto_merge: *596 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -87757,7 +88071,7 @@ paths: - review_comments version: '2026-03-10' examples: - default: &599 + default: &600 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -88325,9 +88639,9 @@ paths: application/json: schema: type: array - items: *596 + items: *597 examples: - default: &601 + default: &602 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -88412,9 +88726,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *597 examples: - default: &597 + default: &598 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -88513,9 +88827,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *597 examples: - default: *597 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88718,7 +89032,7 @@ paths: parameters: - *344 - *345 - - &600 + - &601 name: pull_number description: The number that identifies the pull request. in: path @@ -88731,9 +89045,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *598 + schema: *599 examples: - default: *599 + default: *600 '304': *37 '404': *6 '406': @@ -88770,7 +89084,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 requestBody: required: false content: @@ -88812,11 +89126,66 @@ paths: description: Response content: application/json: - schema: *598 + schema: *599 examples: - default: *599 + default: *600 + '422': *15 + '403': *29 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request + parameters: + - *344 + - *345 + - *601 + responses: + '204': + description: Response + '403': *29 + '404': *6 '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *344 + - *345 + - *601 + responses: + '204': + description: Response '403': *29 + '404': *6 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88838,7 +89207,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 requestBody: required: true content: @@ -88940,7 +89309,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 - *110 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -88961,9 +89330,9 @@ paths: application/json: schema: type: array - items: *596 + items: *597 examples: - default: *601 + default: *602 headers: Link: *68 x-github: @@ -88998,7 +89367,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 requestBody: required: true content: @@ -89103,7 +89472,7 @@ paths: description: Response content: application/json: - schema: *596 + schema: *597 examples: example-for-a-multi-line-comment: value: @@ -89193,7 +89562,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 - *102 requestBody: required: true @@ -89216,7 +89585,7 @@ paths: description: Response content: application/json: - schema: *596 + schema: *597 examples: default: value: @@ -89304,7 +89673,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 - *17 - *19 responses: @@ -89316,7 +89685,7 @@ paths: type: array items: *478 examples: - default: *602 + default: *603 headers: Link: *68 x-github: @@ -89348,7 +89717,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 - *17 - *19 responses: @@ -89398,7 +89767,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 responses: '204': description: Response if pull request has been merged @@ -89423,7 +89792,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 requestBody: required: false content: @@ -89536,7 +89905,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 responses: '200': description: Response @@ -89613,7 +89982,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 requestBody: required: false content: @@ -90188,7 +90557,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 requestBody: required: true content: @@ -90740,7 +91109,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 - *17 - *19 responses: @@ -90750,7 +91119,7 @@ paths: application/json: schema: type: array - items: &603 + items: &604 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -90903,7 +91272,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 requestBody: required: false content: @@ -90989,9 +91358,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *604 examples: - default: &605 + default: &606 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91056,8 +91425,8 @@ paths: parameters: - *344 - *345 - - *600 - - &604 + - *601 + - &605 name: review_id description: The unique identifier of the review. in: path @@ -91069,9 +91438,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *604 examples: - default: &606 + default: &607 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91132,8 +91501,8 @@ paths: parameters: - *344 - *345 - - *600 - - *604 + - *601 + - *605 requestBody: required: true content: @@ -91156,7 +91525,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *604 examples: default: value: @@ -91220,16 +91589,16 @@ paths: parameters: - *344 - *345 - - *600 - - *604 + - *601 + - *605 responses: '200': description: Response content: application/json: - schema: *603 + schema: *604 examples: - default: *605 + default: *606 '422': *7 '404': *6 x-github: @@ -91258,8 +91627,8 @@ paths: parameters: - *344 - *345 - - *600 - - *604 + - *601 + - *605 - *17 - *19 responses: @@ -91496,8 +91865,8 @@ paths: parameters: - *344 - *345 - - *600 - - *604 + - *601 + - *605 requestBody: required: true content: @@ -91525,7 +91894,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *604 examples: default: value: @@ -91590,8 +91959,8 @@ paths: parameters: - *344 - *345 - - *600 - - *604 + - *601 + - *605 requestBody: required: true content: @@ -91626,9 +91995,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *604 examples: - default: *606 + default: *607 '404': *6 '422': *7 '403': *29 @@ -91652,7 +92021,7 @@ paths: parameters: - *344 - *345 - - *600 + - *601 requestBody: required: false content: @@ -91729,9 +92098,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: - default: &608 + default: &609 value: type: file encoding: base64 @@ -91794,9 +92163,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: - default: *608 + default: *609 '404': *6 '422': *15 x-github: @@ -91829,7 +92198,7 @@ paths: application/json: schema: type: array - items: *609 + items: *610 examples: default: value: @@ -92000,9 +92369,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *610 examples: - default: &613 + default: &614 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -92109,7 +92478,7 @@ paths: parameters: - *344 - *345 - - &611 + - &612 name: asset_id description: The unique identifier of the asset. in: path @@ -92121,9 +92490,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *611 examples: - default: &612 + default: &613 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -92176,7 +92545,7 @@ paths: parameters: - *344 - *345 - - *611 + - *612 requestBody: required: false content: @@ -92204,9 +92573,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *611 examples: - default: *612 + default: *613 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92224,7 +92593,7 @@ paths: parameters: - *344 - *345 - - *611 + - *612 responses: '204': description: Response @@ -92342,9 +92711,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *610 examples: - default: *613 + default: *614 '404': *6 x-github: githubCloudOnly: false @@ -92376,9 +92745,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *610 examples: - default: *613 + default: *614 '404': *6 x-github: githubCloudOnly: false @@ -92402,7 +92771,7 @@ paths: parameters: - *344 - *345 - - &614 + - &615 name: release_id description: The unique identifier of the release. in: path @@ -92416,9 +92785,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *609 + schema: *610 examples: - default: *613 + default: *614 '401': description: Unauthorized x-github: @@ -92438,7 +92807,7 @@ paths: parameters: - *344 - *345 - - *614 + - *615 requestBody: required: false content: @@ -92502,9 +92871,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *610 examples: - default: *613 + default: *614 '404': description: Not Found if the discussion category name is invalid content: @@ -92527,7 +92896,7 @@ paths: parameters: - *344 - *345 - - *614 + - *615 responses: '204': description: Response @@ -92550,7 +92919,7 @@ paths: parameters: - *344 - *345 - - *614 + - *615 - *17 - *19 responses: @@ -92560,7 +92929,7 @@ paths: application/json: schema: type: array - items: *610 + items: *611 examples: default: value: @@ -92643,7 +93012,7 @@ paths: parameters: - *344 - *345 - - *614 + - *615 - name: name in: query required: true @@ -92669,7 +93038,7 @@ paths: description: Response for successful upload content: application/json: - schema: *610 + schema: *611 examples: response-for-successful-upload: value: @@ -92726,7 +93095,7 @@ paths: parameters: - *344 - *345 - - *614 + - *615 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -92775,7 +93144,7 @@ paths: parameters: - *344 - *345 - - *614 + - *615 requestBody: required: true content: @@ -92838,7 +93207,7 @@ paths: parameters: - *344 - *345 - - *614 + - *615 - *551 responses: '204': @@ -92882,7 +93251,7 @@ paths: oneOf: - allOf: - *305 - - &615 + - &616 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -92903,67 +93272,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *306 - - *615 + - *616 - allOf: - *307 - - *615 + - *616 - allOf: - *308 - - *615 + - *616 - allOf: + - *617 - *616 - - *615 - allOf: - *309 - - *615 + - *616 - allOf: - *310 - - *615 + - *616 - allOf: - *311 - - *615 + - *616 - allOf: - *312 - - *615 + - *616 - allOf: - *313 - - *615 + - *616 - allOf: - *314 - - *615 + - *616 - allOf: - *315 - - *615 + - *616 - allOf: - *316 - - *615 + - *616 - allOf: - *317 - - *615 + - *616 - allOf: - *318 - - *615 + - *616 - allOf: - *319 - - *615 + - *616 - allOf: - *320 - - *615 + - *616 - allOf: - *321 - - *615 + - *616 - allOf: - *322 - - *615 + - *616 - allOf: - *323 - - *615 + - *616 - allOf: - *324 - - *615 + - *616 - allOf: - *325 - - *615 + - *616 examples: default: value: @@ -93014,7 +93383,7 @@ paths: schema: type: boolean default: true - - *617 + - *618 responses: '200': description: Response @@ -93099,7 +93468,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *618 + items: *619 required: - name - enforcement @@ -93132,7 +93501,7 @@ paths: application/json: schema: *326 examples: - default: &628 + default: &629 value: id: 42 name: super cool ruleset @@ -93182,10 +93551,10 @@ paths: parameters: - *344 - *345 - - *619 - *620 - *621 - *622 + - *623 - *17 - *19 responses: @@ -93193,9 +93562,9 @@ paths: description: Response content: application/json: - schema: *623 + schema: *624 examples: - default: *624 + default: *625 '404': *6 '500': *55 x-github: @@ -93218,15 +93587,15 @@ paths: parameters: - *344 - *345 - - *625 + - *626 responses: '200': description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 '404': *6 '500': *55 x-github: @@ -93277,7 +93646,7 @@ paths: application/json: schema: *326 examples: - default: *628 + default: *629 '404': *6 '500': *55 put: @@ -93330,7 +93699,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *618 + items: *619 examples: default: value: @@ -93360,7 +93729,7 @@ paths: application/json: schema: *326 examples: - default: *628 + default: *629 '404': *6 '422': *15 '500': *55 @@ -93422,7 +93791,7 @@ paths: type: array items: *329 examples: - default: *629 + default: *630 '404': *6 '500': *55 x-github: @@ -93460,7 +93829,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *631 examples: default: value: @@ -93517,7 +93886,6 @@ paths: parameters: - *344 - *345 - - *631 - *632 - *633 - *634 @@ -93525,15 +93893,16 @@ paths: - *636 - *637 - *638 + - *639 - *62 - *19 - *17 - - *639 - *640 - *641 - *642 - *643 - *644 + - *645 responses: '200': description: Response @@ -93541,7 +93910,7 @@ paths: application/json: schema: type: array - items: &648 + items: &649 type: object properties: number: *177 @@ -93560,8 +93929,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *645 - resolution: *646 + state: *646 + resolution: *647 resolved_at: type: string format: date-time @@ -93667,7 +94036,7 @@ paths: pull request. ' - oneOf: *647 + oneOf: *648 nullable: true has_more_locations: type: boolean @@ -93834,13 +94203,13 @@ paths: - *344 - *345 - *442 - - *644 + - *645 responses: '200': description: Response content: application/json: - schema: *648 + schema: *649 examples: default: value: @@ -93904,8 +94273,8 @@ paths: schema: type: object properties: - state: *645 - resolution: *646 + state: *646 + resolution: *647 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -93941,7 +94310,7 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: default: value: @@ -94075,7 +94444,6 @@ paths: example: commit details: oneOf: - - *649 - *650 - *651 - *652 @@ -94088,6 +94456,7 @@ paths: - *659 - *660 - *661 + - *662 examples: default: value: @@ -94182,14 +94551,14 @@ paths: schema: type: object properties: - reason: &663 + reason: &664 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *662 + placeholder_id: *663 required: - reason - placeholder_id @@ -94206,7 +94575,7 @@ paths: schema: type: object properties: - reason: *663 + reason: *664 expire_at: type: string format: date-time @@ -94268,7 +94637,7 @@ paths: properties: incremental_scans: type: array - items: &664 + items: &665 description: Information on a single scan performed by secret scanning on the repository type: object @@ -94294,15 +94663,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *664 + items: *665 backfill_scans: type: array - items: *664 + items: *665 custom_pattern_backfill_scans: type: array items: allOf: - - *664 + - *665 - type: object properties: pattern_name: @@ -94315,7 +94684,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *664 + items: *665 examples: default: value: @@ -94425,9 +94794,9 @@ paths: application/json: schema: type: array - items: *665 + items: *666 examples: - default: *666 + default: *667 '400': *14 '404': *6 x-github: @@ -94611,9 +94980,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: - default: &668 + default: &669 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -94957,7 +95326,7 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: default: value: @@ -95112,15 +95481,15 @@ paths: parameters: - *344 - *345 - - *667 + - *668 responses: '200': description: Response content: application/json: - schema: *665 + schema: *666 examples: - default: *668 + default: *669 '403': *29 '404': *6 x-github: @@ -95146,7 +95515,7 @@ paths: parameters: - *344 - *345 - - *667 + - *668 requestBody: required: true content: @@ -95305,10 +95674,10 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: - default: *668 - add_credit: *668 + default: *669 + add_credit: *669 '403': *29 '404': *6 '422': @@ -95348,7 +95717,7 @@ paths: parameters: - *344 - *345 - - *667 + - *668 responses: '202': *39 '400': *14 @@ -95377,7 +95746,7 @@ paths: parameters: - *344 - *345 - - *667 + - *668 responses: '202': description: Response @@ -95521,7 +95890,7 @@ paths: application/json: schema: type: array - items: &669 + items: &670 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -95894,7 +96263,7 @@ paths: application/json: schema: type: array - items: *669 + items: *670 examples: default: value: @@ -95982,7 +96351,7 @@ paths: description: Response content: application/json: - schema: *670 + schema: *671 examples: default: value: @@ -96076,7 +96445,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &671 + schema: &672 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -96171,7 +96540,7 @@ paths: description: Response content: application/json: - schema: *671 + schema: *672 examples: default: value: @@ -96378,7 +96747,7 @@ paths: description: Response content: application/json: - schema: &672 + schema: &673 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -96390,7 +96759,7 @@ paths: required: - names examples: - default: &673 + default: &674 value: names: - octocat @@ -96445,9 +96814,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *673 + default: *674 '404': *6 '422': *7 x-github: @@ -96470,7 +96839,7 @@ paths: parameters: - *344 - *345 - - &674 + - &675 name: per description: The time frame to display results for. in: query @@ -96499,7 +96868,7 @@ paths: example: 128 clones: type: array - items: &675 + items: &676 title: Traffic type: object properties: @@ -96740,7 +97109,7 @@ paths: parameters: - *344 - *345 - - *674 + - *675 responses: '200': description: Response @@ -96759,7 +97128,7 @@ paths: example: 3782 views: type: array - items: *675 + items: *676 required: - uniques - count @@ -97409,248 +97778,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - *148 - - *557 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: *560 - examples: - default: *676 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *120 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - *148 - - *557 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: *560 - examples: - default: *676 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *120 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - *148 - - *557 - - *242 - responses: - '204': - description: Issue field value deleted successfully - '403': *29 - '404': *6 - '422': *15 - '503': *120 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/search/code": get: summary: Search code @@ -104358,7 +104485,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *579 + - *580 responses: '200': description: Response @@ -104389,7 +104516,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *579 + - *580 responses: '204': description: Response @@ -121008,7 +121135,7 @@ x-webhooks: nullable: true pull_requests: type: array - items: *598 + items: *599 repository: *746 organization: *745 installation: *744 @@ -129089,8 +129216,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *575 - required: *576 + properties: *576 + required: *577 nullable: true user: title: User @@ -130553,8 +130680,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *575 - required: *576 + properties: *576 + required: *577 nullable: true required: - url @@ -167816,7 +167943,7 @@ x-webhooks: organization: *745 pull_request: &797 allOf: - - *598 + - *599 - type: object properties: allow_auto_merge: @@ -168045,7 +168172,7 @@ x-webhooks: enum: - demilestoned enterprise: *743 - milestone: *582 + milestone: *583 number: *796 organization: *745 pull_request: &798 @@ -180165,7 +180292,7 @@ x-webhooks: enum: - milestoned enterprise: *743 - milestone: *582 + milestone: *583 number: *796 organization: *745 pull_request: *798 @@ -222727,7 +222854,7 @@ x-webhooks: installation: *744 organization: *745 repository: *746 - repository_advisory: *665 + repository_advisory: *666 sender: *4 required: - action @@ -222807,7 +222934,7 @@ x-webhooks: installation: *744 organization: *745 repository: *746 - repository_advisory: *665 + repository_advisory: *666 sender: *4 required: - action @@ -223894,16 +224021,16 @@ x-webhooks: properties: added: type: array - items: *618 + items: *619 deleted: type: array - items: *618 + items: *619 updated: type: array items: type: object properties: - rule: *618 + rule: *619 changes: type: object properties: diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 2fdceb5aa2..2be9dc832c 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -20231,6 +20231,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20239,6 +20248,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -123479,6 +123492,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -123487,6 +123509,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -216827,7 +216853,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -216896,6 +216923,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -217040,7 +217079,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -217129,14 +217168,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -217172,12 +217212,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -217224,6 +217276,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -217272,7 +217336,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -217347,6 +217412,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -217673,7 +217750,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -217742,6 +217820,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -217810,7 +217900,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -217915,7 +218005,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -217951,12 +218042,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -489927,259 +490030,1377 @@ "category": "issues", "subcategory": "issue-field-values" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - "get": { - "summary": "List labels for an issue", - "description": "Lists all labels for an issue.", - "tags": [ - "issues" - ], - "operationId": "issues/list-labels-on-issue", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "example": 208045946 - }, - "node_id": { - "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" - }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", - "nullable": true - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "301": { - "description": "Moved permanently", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "labels" - } }, "post": { - "summary": "Add labels to an issue", - "description": "Adds labels to an issue.", + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/add-labels", + "operationId": "issues/add-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Add multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after adding the new values", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" + }, + { + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + }, + "put": { + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/set-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Set multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after setting the new values", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" + }, + { + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { + "delete": { + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/delete-issue-field-value", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Issue field value deleted successfully" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + "get": { + "summary": "List labels for an issue", + "description": "Lists all labels for an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/list-labels-on-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "post": { + "summary": "Add labels to an issue", + "description": "Adds labels to an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/add-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -551411,6 +552632,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -618020,1099 +619589,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_field_id", - "description": "The unique identifier of the issue field.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 39f68d681f..d0a74ad713 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -1031,7 +1031,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &777 + - &778 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -8706,6 +8706,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -8716,6 +8725,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -22141,7 +22155,7 @@ paths: - *167 rules: type: array - items: &743 + items: &744 title: Repository Rule type: object description: A repository rule. @@ -22150,7 +22164,7 @@ paths: - *173 - *174 - *175 - - &741 + - &742 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -22746,14 +22760,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &755 + state: &756 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &756 + resolution: &757 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -22870,8 +22884,8 @@ paths: pull request. ' - oneOf: &757 - - &759 + oneOf: &758 + - &760 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -22929,7 +22943,7 @@ paths: - blob_url - commit_sha - commit_url - - &760 + - &761 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -22984,7 +22998,7 @@ paths: - page_url - commit_sha - commit_url - - &761 + - &762 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -23004,7 +23018,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &762 + - &763 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -23024,7 +23038,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &763 + - &764 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -23044,7 +23058,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &764 + - &765 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -23058,7 +23072,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &765 + - &766 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -23072,7 +23086,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &766 + - &767 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -23086,7 +23100,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &767 + - &768 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -23106,7 +23120,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &768 + - &769 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -23126,7 +23140,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &769 + - &770 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -23146,7 +23160,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &770 + - &771 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -23166,7 +23180,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &771 + - &772 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -27659,7 +27673,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &698 + properties: &699 pinned_at: type: string format: date-time @@ -27671,7 +27685,7 @@ paths: properties: *20 required: *21 nullable: true - required: &699 + required: &700 - pinned_at - pinned_by nullable: true @@ -28467,7 +28481,7 @@ paths: type: string release: allOf: - - &734 + - &735 title: Release description: A release. type: object @@ -28538,7 +28552,7 @@ paths: author: *4 assets: type: array - items: &735 + items: &736 title: Release Asset description: Data related to a release. type: object @@ -32509,7 +32523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &708 + - &709 name: all description: If `true`, show notifications marked as read. in: query @@ -32517,7 +32531,7 @@ paths: schema: type: boolean default: false - - &709 + - &710 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -32527,7 +32541,7 @@ paths: type: boolean default: false - *234 - - &710 + - &711 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -33065,7 +33079,7 @@ paths: - url - subscription_url examples: - default: &711 + default: &712 value: - id: '1' repository: @@ -33917,7 +33931,7 @@ paths: type: array items: *158 examples: - default: &717 + default: &718 value: - property_name: environment value: production @@ -33967,7 +33981,7 @@ paths: required: - properties examples: - default: &718 + default: &719 value: properties: - property_name: environment @@ -35392,6 +35406,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -35402,6 +35425,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -53743,6 +53771,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -53802,6 +53831,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -53839,7 +53877,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -53931,8 +53969,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -53940,6 +53978,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -53971,13 +54010,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -54016,6 +54067,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -54057,6 +54118,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -54122,6 +54184,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -54245,7 +54316,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -54342,6 +54413,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -54373,13 +54445,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -55018,7 +55102,7 @@ paths: - review_comment - self author_association: *224 - auto_merge: &720 + auto_merge: &721 title: Auto merge description: The status of auto merging a pull request. type: object @@ -59037,7 +59121,7 @@ paths: - *89 - *17 - *19 - - &742 + - &743 name: targets description: | A comma-separated list of rule targets to filter by. @@ -59253,7 +59337,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *89 - - &744 + - &745 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -59265,14 +59349,14 @@ paths: x-multi-segment: true - *314 - *107 - - &745 + - &746 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &746 + - &747 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -59292,7 +59376,7 @@ paths: description: Response content: application/json: - schema: &747 + schema: &748 title: Rule Suites description: Response type: array @@ -59347,7 +59431,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &748 + default: &749 value: - id: 21 actor_id: 12 @@ -59391,7 +59475,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *89 - - &749 + - &750 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -59407,7 +59491,7 @@ paths: description: Response content: application/json: - schema: &750 + schema: &751 title: Rule Suite description: Response type: object @@ -59506,7 +59590,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &751 + default: &752 value: id: 21 actor_id: 12 @@ -59842,7 +59926,7 @@ paths: - *112 - *19 - *17 - - &753 + - &754 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -59852,7 +59936,7 @@ paths: required: false schema: type: string - - &754 + - &755 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -60065,7 +60149,7 @@ paths: application/json: schema: type: array - items: &775 + items: &776 description: A repository security advisory. type: object properties: @@ -60356,7 +60440,7 @@ paths: - private_fork additionalProperties: false examples: - default: &776 + default: &777 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -81480,7 +81564,7 @@ paths: type: array items: *595 examples: - default: &727 + default: &728 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -81771,7 +81855,7 @@ paths: type: array items: *599 examples: - default: &719 + default: &720 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -82329,7 +82413,7 @@ paths: application/json: schema: *595 examples: - default: &704 + default: &705 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -82988,7 +83072,7 @@ paths: application/json: schema: type: array - items: &780 + items: &781 title: Status description: The status of a commit. type: object @@ -83957,7 +84041,7 @@ paths: - size - type - url - - &732 + - &733 title: Content File description: Content File type: object @@ -84571,7 +84655,7 @@ paths: items: type: object properties: - placeholder_id: &772 + placeholder_id: &773 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -95345,7 +95429,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &685 + - &686 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -95399,7 +95483,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &686 + - &687 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -95535,7 +95619,7 @@ paths: - performed_via_github_app - assignee - assigner - - &687 + - &688 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -95586,7 +95670,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &688 + - &689 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -95637,7 +95721,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &689 + - &690 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -95691,7 +95775,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &690 + - &691 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -95738,7 +95822,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &691 + - &692 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -95785,7 +95869,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &692 + - &693 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -95845,7 +95929,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &693 + - &694 title: Locked Issue Event description: Locked Issue Event type: object @@ -95893,7 +95977,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &694 + - &695 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -95959,7 +96043,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &695 + - &696 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -96025,7 +96109,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &696 + - &697 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -96091,7 +96175,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &697 + - &698 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -96213,7 +96297,7 @@ paths: type: array items: *683 examples: - default: &786 + default: &684 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -96245,6 +96329,250 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - *478 + - *479 + - *680 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: *683 + examples: + default: *684 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *198 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - *478 + - *479 + - *680 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: *683 + examples: + default: *684 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *198 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - *478 + - *479 + - *680 + - *387 + responses: + '204': + description: Issue field value deleted successfully + '403': *29 + '404': *6 + '422': *15 + '503': *198 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -96270,7 +96598,7 @@ paths: type: array items: *226 examples: - default: &684 + default: &685 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -96353,7 +96681,7 @@ paths: type: array items: *226 examples: - default: *684 + default: *685 '301': *484 '404': *6 '410': *671 @@ -96437,7 +96765,7 @@ paths: type: array items: *226 examples: - default: *684 + default: *685 '301': *484 '404': *6 '410': *671 @@ -97028,7 +97356,6 @@ paths: description: Timeline Event type: object anyOf: - - *685 - *686 - *687 - *688 @@ -97041,6 +97368,7 @@ paths: - *695 - *696 - *697 + - *698 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -97101,8 +97429,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *698 - required: *699 + properties: *699 + required: *700 nullable: true required: - event @@ -97357,7 +97685,7 @@ paths: type: string comments: type: array - items: &721 + items: &722 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -97889,7 +98217,7 @@ paths: application/json: schema: type: array - items: &700 + items: &701 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -97992,9 +98320,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: &701 + default: &702 value: id: 1 key: ssh-rsa AAA... @@ -98030,7 +98358,7 @@ paths: parameters: - *478 - *479 - - &702 + - &703 name: key_id description: The unique identifier of the key. in: path @@ -98042,9 +98370,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: *701 + default: *702 '404': *6 x-github: githubCloudOnly: false @@ -98064,7 +98392,7 @@ paths: parameters: - *478 - *479 - - *702 + - *703 responses: '204': description: Response @@ -98097,7 +98425,7 @@ paths: type: array items: *226 examples: - default: *684 + default: *685 headers: Link: *47 '404': *6 @@ -98157,7 +98485,7 @@ paths: application/json: schema: *226 examples: - default: &703 + default: &704 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -98203,7 +98531,7 @@ paths: application/json: schema: *226 examples: - default: *703 + default: *704 '404': *6 x-github: githubCloudOnly: false @@ -98656,7 +98984,7 @@ paths: application/json: schema: *595 examples: - default: *704 + default: *705 '204': description: Response when already merged '404': @@ -98723,7 +99051,7 @@ paths: application/json: schema: type: array - items: &705 + items: &706 title: Milestone description: A collection of related issues and pull requests. type: object @@ -98825,9 +99153,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: &706 + default: &707 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -98888,7 +99216,7 @@ paths: parameters: - *478 - *479 - - &707 + - &708 name: milestone_number description: The number that identifies the milestone. in: path @@ -98900,9 +99228,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: *706 + default: *707 '404': *6 x-github: githubCloudOnly: false @@ -98921,7 +99249,7 @@ paths: parameters: - *478 - *479 - - *707 + - *708 requestBody: required: false content: @@ -98959,9 +99287,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: *706 + default: *707 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98979,7 +99307,7 @@ paths: parameters: - *478 - *479 - - *707 + - *708 responses: '204': description: Response @@ -99002,7 +99330,7 @@ paths: parameters: - *478 - *479 - - *707 + - *708 - *17 - *19 responses: @@ -99014,7 +99342,7 @@ paths: type: array items: *226 examples: - default: *684 + default: *685 headers: Link: *47 x-github: @@ -99035,10 +99363,10 @@ paths: parameters: - *478 - *479 - - *708 - *709 - - *234 - *710 + - *234 + - *711 - *17 - *19 responses: @@ -99050,7 +99378,7 @@ paths: type: array items: *254 examples: - default: *711 + default: *712 headers: Link: *47 x-github: @@ -99140,7 +99468,7 @@ paths: description: Response content: application/json: - schema: &712 + schema: &713 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -99265,7 +99593,7 @@ paths: - custom_404 - public examples: - default: &713 + default: &714 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -99361,9 +99689,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *713 + default: *714 '422': *15 '409': *121 x-github: @@ -99532,7 +99860,7 @@ paths: application/json: schema: type: array - items: &714 + items: &715 title: Page Build description: Page Build type: object @@ -99679,9 +100007,9 @@ paths: description: Response content: application/json: - schema: *714 + schema: *715 examples: - default: &715 + default: &716 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -99741,9 +100069,9 @@ paths: description: Response content: application/json: - schema: *714 + schema: *715 examples: - default: *715 + default: *716 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99871,7 +100199,7 @@ paths: parameters: - *478 - *479 - - &716 + - &717 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -99931,7 +100259,7 @@ paths: parameters: - *478 - *479 - - *716 + - *717 responses: '204': *130 '404': *6 @@ -100311,7 +100639,7 @@ paths: type: array items: *158 examples: - default: *717 + default: *718 '403': *29 '404': *6 x-github: @@ -100350,7 +100678,7 @@ paths: required: - properties examples: - default: *718 + default: *719 responses: '204': description: No Content when custom property values are successfully created @@ -100451,7 +100779,7 @@ paths: type: array items: *599 examples: - default: *719 + default: *720 headers: Link: *47 '304': *37 @@ -100549,7 +100877,7 @@ paths: description: Response content: application/json: - schema: &723 + schema: &724 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -100760,7 +101088,7 @@ paths: - review_comment - self author_association: *224 - auto_merge: *720 + auto_merge: *721 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -100852,7 +101180,7 @@ paths: - merged_by - review_comments examples: - default: &724 + default: &725 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -101409,9 +101737,9 @@ paths: application/json: schema: type: array - items: *721 + items: *722 examples: - default: &726 + default: &727 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -101496,9 +101824,9 @@ paths: description: Response content: application/json: - schema: *721 + schema: *722 examples: - default: &722 + default: &723 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -101597,9 +101925,9 @@ paths: description: Response content: application/json: - schema: *721 + schema: *722 examples: - default: *722 + default: *723 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101802,7 +102130,7 @@ paths: parameters: - *478 - *479 - - &725 + - &726 name: pull_number description: The number that identifies the pull request. in: path @@ -101815,9 +102143,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *723 + schema: *724 examples: - default: *724 + default: *725 '304': *37 '404': *6 '406': @@ -101854,7 +102182,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: false content: @@ -101896,11 +102224,66 @@ paths: description: Response content: application/json: - schema: *723 + schema: *724 examples: - default: *724 + default: *725 + '422': *15 + '403': *29 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - *478 + - *479 + - *726 + responses: + '204': + description: Response + '403': *29 + '404': *6 '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *478 + - *479 + - *726 + responses: + '204': + description: Response '403': *29 + '404': *6 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101922,7 +102305,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: true content: @@ -102024,7 +102407,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 - *251 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -102045,9 +102428,9 @@ paths: application/json: schema: type: array - items: *721 + items: *722 examples: - default: *726 + default: *727 headers: Link: *47 x-github: @@ -102082,7 +102465,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: true content: @@ -102187,7 +102570,7 @@ paths: description: Response content: application/json: - schema: *721 + schema: *722 examples: example-for-a-multi-line-comment: value: @@ -102277,7 +102660,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 - *243 requestBody: required: true @@ -102300,7 +102683,7 @@ paths: description: Response content: application/json: - schema: *721 + schema: *722 examples: default: value: @@ -102388,7 +102771,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 - *17 - *19 responses: @@ -102400,7 +102783,7 @@ paths: type: array items: *595 examples: - default: *727 + default: *728 headers: Link: *47 x-github: @@ -102432,7 +102815,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 - *17 - *19 responses: @@ -102482,7 +102865,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 responses: '204': description: Response if pull request has been merged @@ -102507,7 +102890,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: false content: @@ -102620,7 +103003,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 responses: '200': description: Response @@ -102697,7 +103080,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: false content: @@ -103272,7 +103655,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: true content: @@ -103813,7 +104196,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 - *17 - *19 responses: @@ -103823,7 +104206,7 @@ paths: application/json: schema: type: array - items: &728 + items: &729 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -103976,7 +104359,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: false content: @@ -104062,9 +104445,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: &730 + default: &731 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -104129,8 +104512,8 @@ paths: parameters: - *478 - *479 - - *725 - - &729 + - *726 + - &730 name: review_id description: The unique identifier of the review. in: path @@ -104142,9 +104525,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: &731 + default: &732 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -104205,8 +104588,8 @@ paths: parameters: - *478 - *479 - - *725 - - *729 + - *726 + - *730 requestBody: required: true content: @@ -104229,7 +104612,7 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: default: value: @@ -104293,16 +104676,16 @@ paths: parameters: - *478 - *479 - - *725 - - *729 + - *726 + - *730 responses: '200': description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: *730 + default: *731 '422': *7 '404': *6 x-github: @@ -104331,8 +104714,8 @@ paths: parameters: - *478 - *479 - - *725 - - *729 + - *726 + - *730 - *17 - *19 responses: @@ -104569,8 +104952,8 @@ paths: parameters: - *478 - *479 - - *725 - - *729 + - *726 + - *730 requestBody: required: true content: @@ -104598,7 +104981,7 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: default: value: @@ -104663,8 +105046,8 @@ paths: parameters: - *478 - *479 - - *725 - - *729 + - *726 + - *730 requestBody: required: true content: @@ -104699,9 +105082,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: *731 + default: *732 '404': *6 '422': *7 '403': *29 @@ -104725,7 +105108,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: false content: @@ -104802,9 +105185,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *733 examples: - default: &733 + default: &734 value: type: file encoding: base64 @@ -104867,9 +105250,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *733 examples: - default: *733 + default: *734 '404': *6 '422': *15 x-github: @@ -104902,7 +105285,7 @@ paths: application/json: schema: type: array - items: *734 + items: *735 examples: default: value: @@ -105073,9 +105456,9 @@ paths: description: Response content: application/json: - schema: *734 + schema: *735 examples: - default: &738 + default: &739 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -105182,7 +105565,7 @@ paths: parameters: - *478 - *479 - - &736 + - &737 name: asset_id description: The unique identifier of the asset. in: path @@ -105194,9 +105577,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: &737 + default: &738 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -105249,7 +105632,7 @@ paths: parameters: - *478 - *479 - - *736 + - *737 requestBody: required: false content: @@ -105277,9 +105660,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: *737 + default: *738 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105297,7 +105680,7 @@ paths: parameters: - *478 - *479 - - *736 + - *737 responses: '204': description: Response @@ -105415,9 +105798,9 @@ paths: description: Response content: application/json: - schema: *734 + schema: *735 examples: - default: *738 + default: *739 '404': *6 x-github: githubCloudOnly: false @@ -105449,9 +105832,9 @@ paths: description: Response content: application/json: - schema: *734 + schema: *735 examples: - default: *738 + default: *739 '404': *6 x-github: githubCloudOnly: false @@ -105475,7 +105858,7 @@ paths: parameters: - *478 - *479 - - &739 + - &740 name: release_id description: The unique identifier of the release. in: path @@ -105489,9 +105872,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *734 + schema: *735 examples: - default: *738 + default: *739 '401': description: Unauthorized x-github: @@ -105511,7 +105894,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 requestBody: required: false content: @@ -105575,9 +105958,9 @@ paths: description: Response content: application/json: - schema: *734 + schema: *735 examples: - default: *738 + default: *739 '404': description: Not Found if the discussion category name is invalid content: @@ -105600,7 +105983,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 responses: '204': description: Response @@ -105623,7 +106006,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 - *17 - *19 responses: @@ -105633,7 +106016,7 @@ paths: application/json: schema: type: array - items: *735 + items: *736 examples: default: value: @@ -105717,7 +106100,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 - name: name in: query required: true @@ -105743,7 +106126,7 @@ paths: description: Response for successful upload content: application/json: - schema: *735 + schema: *736 examples: response-for-successful-upload: value: @@ -105800,7 +106183,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -105849,7 +106232,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 requestBody: required: true content: @@ -105912,7 +106295,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 - *675 responses: '204': @@ -105956,7 +106339,7 @@ paths: oneOf: - allOf: - *172 - - &740 + - &741 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -105977,67 +106360,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *173 - - *740 + - *741 - allOf: - *174 - - *740 + - *741 - allOf: - *175 - - *740 + - *741 - allOf: + - *742 - *741 - - *740 - allOf: - *176 - - *740 + - *741 - allOf: - *177 - - *740 + - *741 - allOf: - *178 - - *740 + - *741 - allOf: - *179 - - *740 + - *741 - allOf: - *180 - - *740 + - *741 - allOf: - *181 - - *740 + - *741 - allOf: - *182 - - *740 + - *741 - allOf: - *183 - - *740 + - *741 - allOf: - *184 - - *740 + - *741 - allOf: - *185 - - *740 + - *741 - allOf: - *186 - - *740 + - *741 - allOf: - *187 - - *740 + - *741 - allOf: - *188 - - *740 + - *741 - allOf: - *189 - - *740 + - *741 - allOf: - *190 - - *740 + - *741 - allOf: - *191 - - *740 + - *741 - allOf: - *192 - - *740 + - *741 examples: default: value: @@ -106088,7 +106471,7 @@ paths: schema: type: boolean default: true - - *742 + - *743 responses: '200': description: Response @@ -106173,7 +106556,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *743 + items: *744 required: - name - enforcement @@ -106206,7 +106589,7 @@ paths: application/json: schema: *193 examples: - default: &752 + default: &753 value: id: 42 name: super cool ruleset @@ -106256,10 +106639,10 @@ paths: parameters: - *478 - *479 - - *744 - - *107 - *745 + - *107 - *746 + - *747 - *17 - *19 responses: @@ -106267,9 +106650,9 @@ paths: description: Response content: application/json: - schema: *747 + schema: *748 examples: - default: *748 + default: *749 '404': *6 '500': *40 x-github: @@ -106292,15 +106675,15 @@ paths: parameters: - *478 - *479 - - *749 + - *750 responses: '200': description: Response content: application/json: - schema: *750 + schema: *751 examples: - default: *751 + default: *752 '404': *6 '500': *40 x-github: @@ -106351,7 +106734,7 @@ paths: application/json: schema: *193 examples: - default: *752 + default: *753 '404': *6 '500': *40 put: @@ -106404,7 +106787,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *743 + items: *744 examples: default: value: @@ -106434,7 +106817,7 @@ paths: application/json: schema: *193 examples: - default: *752 + default: *753 '404': *6 '422': *15 '500': *40 @@ -106602,8 +106985,8 @@ paths: - *112 - *19 - *17 - - *753 - *754 + - *755 - *453 - *454 - *455 @@ -106615,7 +106998,7 @@ paths: application/json: schema: type: array - items: &758 + items: &759 type: object properties: number: *131 @@ -106634,8 +107017,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *755 - resolution: *756 + state: *756 + resolution: *757 resolved_at: type: string format: date-time @@ -106741,7 +107124,7 @@ paths: pull request. ' - oneOf: *757 + oneOf: *758 nullable: true has_more_locations: type: boolean @@ -106914,7 +107297,7 @@ paths: description: Response content: application/json: - schema: *758 + schema: *759 examples: default: value: @@ -106978,8 +107361,8 @@ paths: schema: type: object properties: - state: *755 - resolution: *756 + state: *756 + resolution: *757 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -107015,7 +107398,7 @@ paths: description: Response content: application/json: - schema: *758 + schema: *759 examples: default: value: @@ -107149,7 +107532,6 @@ paths: example: commit details: oneOf: - - *759 - *760 - *761 - *762 @@ -107162,6 +107544,7 @@ paths: - *769 - *770 - *771 + - *772 examples: default: value: @@ -107256,14 +107639,14 @@ paths: schema: type: object properties: - reason: &773 + reason: &774 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *772 + placeholder_id: *773 required: - reason - placeholder_id @@ -107280,7 +107663,7 @@ paths: schema: type: object properties: - reason: *773 + reason: *774 expire_at: type: string format: date-time @@ -107342,7 +107725,7 @@ paths: properties: incremental_scans: type: array - items: &774 + items: &775 description: Information on a single scan performed by secret scanning on the repository type: object @@ -107368,15 +107751,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *774 + items: *775 backfill_scans: type: array - items: *774 + items: *775 custom_pattern_backfill_scans: type: array items: allOf: - - *774 + - *775 - type: object properties: pattern_name: @@ -107389,7 +107772,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *774 + items: *775 examples: default: value: @@ -107499,9 +107882,9 @@ paths: application/json: schema: type: array - items: *775 + items: *776 examples: - default: *776 + default: *777 '400': *14 '404': *6 x-github: @@ -107685,9 +108068,9 @@ paths: description: Response content: application/json: - schema: *775 + schema: *776 examples: - default: &778 + default: &779 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -108025,7 +108408,7 @@ paths: description: Response content: application/json: - schema: *775 + schema: *776 examples: default: value: @@ -108174,15 +108557,15 @@ paths: parameters: - *478 - *479 - - *777 + - *778 responses: '200': description: Response content: application/json: - schema: *775 + schema: *776 examples: - default: *778 + default: *779 '403': *29 '404': *6 x-github: @@ -108208,7 +108591,7 @@ paths: parameters: - *478 - *479 - - *777 + - *778 requestBody: required: true content: @@ -108367,10 +108750,10 @@ paths: description: Response content: application/json: - schema: *775 + schema: *776 examples: - default: *778 - add_credit: *778 + default: *779 + add_credit: *779 '403': *29 '404': *6 '422': @@ -108410,7 +108793,7 @@ paths: parameters: - *478 - *479 - - *777 + - *778 responses: '202': *39 '400': *14 @@ -108439,7 +108822,7 @@ paths: parameters: - *478 - *479 - - *777 + - *778 responses: '202': description: Response @@ -108583,7 +108966,7 @@ paths: application/json: schema: type: array - items: &779 + items: &780 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -108956,7 +109339,7 @@ paths: application/json: schema: type: array - items: *779 + items: *780 examples: default: value: @@ -109044,7 +109427,7 @@ paths: description: Response content: application/json: - schema: *780 + schema: *781 examples: default: value: @@ -109138,7 +109521,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &781 + schema: &782 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -109233,7 +109616,7 @@ paths: description: Response content: application/json: - schema: *781 + schema: *782 examples: default: value: @@ -109440,7 +109823,7 @@ paths: description: Response content: application/json: - schema: &782 + schema: &783 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -109452,7 +109835,7 @@ paths: required: - names examples: - default: &783 + default: &784 value: names: - octocat @@ -109507,9 +109890,9 @@ paths: description: Response content: application/json: - schema: *782 + schema: *783 examples: - default: *783 + default: *784 '404': *6 '422': *7 x-github: @@ -109532,7 +109915,7 @@ paths: parameters: - *478 - *479 - - &784 + - &785 name: per description: The time frame to display results for. in: query @@ -109561,7 +109944,7 @@ paths: example: 128 clones: type: array - items: &785 + items: &786 title: Traffic type: object properties: @@ -109802,7 +110185,7 @@ paths: parameters: - *478 - *479 - - *784 + - *785 responses: '200': description: Response @@ -109821,7 +110204,7 @@ paths: example: 3782 views: type: array - items: *785 + items: *786 required: - uniques - count @@ -110465,248 +110848,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - *282 - - *680 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: *683 - examples: - default: *786 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *198 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - *282 - - *680 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: *683 - examples: - default: *786 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *198 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - *282 - - *680 - - *387 - responses: - '204': - description: Issue field value deleted successfully - '403': *29 - '404': *6 - '422': *15 - '503': *198 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/scim/v2/enterprises/{enterprise}/Groups": get: summary: List provisioned SCIM groups for an enterprise @@ -119532,7 +119673,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *702 + - *703 responses: '200': description: Response @@ -119563,7 +119704,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *702 + - *703 responses: '204': description: Response @@ -136514,7 +136655,7 @@ x-webhooks: nullable: true pull_requests: type: array - items: *723 + items: *724 repository: *878 organization: *877 installation: *876 @@ -145567,8 +145708,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *698 - required: *699 + properties: *699 + required: *700 nullable: true user: title: User @@ -147031,8 +147172,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *698 - required: *699 + properties: *699 + required: *700 nullable: true required: - url @@ -184561,7 +184702,7 @@ x-webhooks: organization: *877 pull_request: &935 allOf: - - *723 + - *724 - type: object properties: allow_auto_merge: @@ -184790,7 +184931,7 @@ x-webhooks: enum: - demilestoned enterprise: *875 - milestone: *705 + milestone: *706 number: *934 organization: *877 pull_request: &936 @@ -196822,7 +196963,7 @@ x-webhooks: enum: - milestoned enterprise: *875 - milestone: *705 + milestone: *706 number: *934 organization: *877 pull_request: *936 @@ -239179,7 +239320,7 @@ x-webhooks: installation: *876 organization: *877 repository: *878 - repository_advisory: *775 + repository_advisory: *776 sender: *4 required: - action @@ -239259,7 +239400,7 @@ x-webhooks: installation: *876 organization: *877 repository: *878 - repository_advisory: *775 + repository_advisory: *776 sender: *4 required: - action @@ -240346,16 +240487,16 @@ x-webhooks: properties: added: type: array - items: *743 + items: *744 deleted: type: array - items: *743 + items: *744 updated: type: array items: type: object properties: - rule: *743 + rule: *744 changes: type: object properties: diff --git a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json index 8ff4c39053..608a9b52bd 100644 --- a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -20150,6 +20150,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20158,6 +20167,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -119935,6 +119948,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -119943,6 +119965,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -211360,7 +211386,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -211429,6 +211456,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -211573,7 +211612,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -211662,14 +211701,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -211705,12 +211745,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -211757,6 +211809,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -211805,7 +211869,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -211880,6 +211945,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -212206,7 +212283,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -212275,6 +212353,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -212343,7 +212433,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -212448,7 +212538,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -212484,12 +212575,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -481049,259 +481152,1377 @@ "category": "issues", "subcategory": "issue-field-values" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - "get": { - "summary": "List labels for an issue", - "description": "Lists all labels for an issue.", - "tags": [ - "issues" - ], - "operationId": "issues/list-labels-on-issue", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "example": 208045946 - }, - "node_id": { - "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" - }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", - "nullable": true - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "301": { - "description": "Moved permanently", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "labels" - } }, "post": { - "summary": "Add labels to an issue", - "description": "Adds labels to an issue.", + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/add-labels", + "operationId": "issues/add-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Add multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after adding the new values", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" + }, + { + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + }, + "put": { + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/set-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Set multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after setting the new values", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" + }, + { + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { + "delete": { + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/delete-issue-field-value", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Issue field value deleted successfully" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + "get": { + "summary": "List labels for an issue", + "description": "Lists all labels for an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/list-labels-on-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "post": { + "summary": "Add labels to an issue", + "description": "Adds labels to an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/add-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -540865,6 +542086,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -606851,1099 +608420,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_field_id", - "description": "The unique identifier of the issue field.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", diff --git a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml index 9c09cfde50..cff5590ad4 100644 --- a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml @@ -1002,7 +1002,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &777 + - &778 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -8658,6 +8658,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -8668,6 +8677,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -22071,7 +22085,7 @@ paths: - *167 rules: type: array - items: &743 + items: &744 title: Repository Rule type: object description: A repository rule. @@ -22080,7 +22094,7 @@ paths: - *173 - *174 - *175 - - &741 + - &742 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -22676,14 +22690,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &755 + state: &756 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &756 + resolution: &757 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -22800,8 +22814,8 @@ paths: pull request. ' - oneOf: &757 - - &759 + oneOf: &758 + - &760 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -22859,7 +22873,7 @@ paths: - blob_url - commit_sha - commit_url - - &760 + - &761 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -22914,7 +22928,7 @@ paths: - page_url - commit_sha - commit_url - - &761 + - &762 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -22934,7 +22948,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &762 + - &763 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -22954,7 +22968,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &763 + - &764 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -22974,7 +22988,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &764 + - &765 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -22988,7 +23002,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &765 + - &766 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -23002,7 +23016,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &766 + - &767 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -23016,7 +23030,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &767 + - &768 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -23036,7 +23050,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &768 + - &769 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -23056,7 +23070,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &769 + - &770 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -23076,7 +23090,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &770 + - &771 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -23096,7 +23110,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &771 + - &772 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -27582,7 +27596,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &698 + properties: &699 pinned_at: type: string format: date-time @@ -27594,7 +27608,7 @@ paths: properties: *20 required: *21 nullable: true - required: &699 + required: &700 - pinned_at - pinned_by nullable: true @@ -28389,7 +28403,7 @@ paths: type: string release: allOf: - - &734 + - &735 title: Release description: A release. type: object @@ -28460,7 +28474,7 @@ paths: author: *4 assets: type: array - items: &735 + items: &736 title: Release Asset description: Data related to a release. type: object @@ -32205,7 +32219,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &708 + - &709 name: all description: If `true`, show notifications marked as read. in: query @@ -32213,7 +32227,7 @@ paths: schema: type: boolean default: false - - &709 + - &710 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -32223,7 +32237,7 @@ paths: type: boolean default: false - *234 - - &710 + - &711 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -32759,7 +32773,7 @@ paths: - url - subscription_url examples: - default: &711 + default: &712 value: - id: '1' repository: @@ -33531,7 +33545,7 @@ paths: type: array items: *158 examples: - default: &717 + default: &718 value: - property_name: environment value: production @@ -33581,7 +33595,7 @@ paths: required: - properties examples: - default: &718 + default: &719 value: properties: - property_name: environment @@ -34997,6 +35011,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -35007,6 +35030,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -53384,6 +53412,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -53443,6 +53472,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -53480,7 +53518,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -53572,8 +53610,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -53581,6 +53619,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -53612,13 +53651,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -53657,6 +53708,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -53698,6 +53759,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -53763,6 +53825,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -53886,7 +53957,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -53983,6 +54054,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -54014,13 +54086,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -54648,7 +54732,7 @@ paths: - review_comment - self author_association: *224 - auto_merge: &720 + auto_merge: &721 title: Auto merge description: The status of auto merging a pull request. type: object @@ -58659,7 +58743,7 @@ paths: - *89 - *17 - *19 - - &742 + - &743 name: targets description: | A comma-separated list of rule targets to filter by. @@ -58875,7 +58959,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *89 - - &744 + - &745 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -58887,14 +58971,14 @@ paths: x-multi-segment: true - *314 - *107 - - &745 + - &746 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &746 + - &747 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -58914,7 +58998,7 @@ paths: description: Response content: application/json: - schema: &747 + schema: &748 title: Rule Suites description: Response type: array @@ -58969,7 +59053,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &748 + default: &749 value: - id: 21 actor_id: 12 @@ -59013,7 +59097,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *89 - - &749 + - &750 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -59029,7 +59113,7 @@ paths: description: Response content: application/json: - schema: &750 + schema: &751 title: Rule Suite description: Response type: object @@ -59128,7 +59212,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &751 + default: &752 value: id: 21 actor_id: 12 @@ -59464,7 +59548,7 @@ paths: - *112 - *19 - *17 - - &753 + - &754 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -59474,7 +59558,7 @@ paths: required: false schema: type: string - - &754 + - &755 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -59687,7 +59771,7 @@ paths: application/json: schema: type: array - items: &775 + items: &776 description: A repository security advisory. type: object properties: @@ -59959,7 +60043,7 @@ paths: - private_fork additionalProperties: false examples: - default: &776 + default: &777 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -81036,7 +81120,7 @@ paths: type: array items: *595 examples: - default: &727 + default: &728 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -81327,7 +81411,7 @@ paths: type: array items: *599 examples: - default: &719 + default: &720 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -81885,7 +81969,7 @@ paths: application/json: schema: *595 examples: - default: &704 + default: &705 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -82544,7 +82628,7 @@ paths: application/json: schema: type: array - items: &780 + items: &781 title: Status description: The status of a commit. type: object @@ -83513,7 +83597,7 @@ paths: - size - type - url - - &732 + - &733 title: Content File description: Content File type: object @@ -84127,7 +84211,7 @@ paths: items: type: object properties: - placeholder_id: &772 + placeholder_id: &773 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -94851,7 +94935,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &685 + - &686 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -94905,7 +94989,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &686 + - &687 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -95041,7 +95125,7 @@ paths: - performed_via_github_app - assignee - assigner - - &687 + - &688 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -95092,7 +95176,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &688 + - &689 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -95143,7 +95227,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &689 + - &690 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -95197,7 +95281,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &690 + - &691 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -95244,7 +95328,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &691 + - &692 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -95291,7 +95375,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &692 + - &693 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -95351,7 +95435,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &693 + - &694 title: Locked Issue Event description: Locked Issue Event type: object @@ -95399,7 +95483,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &694 + - &695 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -95465,7 +95549,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &695 + - &696 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -95531,7 +95615,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &696 + - &697 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -95597,7 +95681,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &697 + - &698 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -95719,7 +95803,7 @@ paths: type: array items: *683 examples: - default: &786 + default: &684 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -95751,6 +95835,250 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - *478 + - *479 + - *680 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: *683 + examples: + default: *684 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *198 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - *478 + - *479 + - *680 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: *683 + examples: + default: *684 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *198 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - *478 + - *479 + - *680 + - *387 + responses: + '204': + description: Issue field value deleted successfully + '403': *29 + '404': *6 + '422': *15 + '503': *198 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -95776,7 +96104,7 @@ paths: type: array items: *226 examples: - default: &684 + default: &685 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -95859,7 +96187,7 @@ paths: type: array items: *226 examples: - default: *684 + default: *685 '301': *484 '404': *6 '410': *671 @@ -95943,7 +96271,7 @@ paths: type: array items: *226 examples: - default: *684 + default: *685 '301': *484 '404': *6 '410': *671 @@ -96534,7 +96862,6 @@ paths: description: Timeline Event type: object anyOf: - - *685 - *686 - *687 - *688 @@ -96547,6 +96874,7 @@ paths: - *695 - *696 - *697 + - *698 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -96607,8 +96935,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *698 - required: *699 + properties: *699 + required: *700 nullable: true required: - event @@ -96863,7 +97191,7 @@ paths: type: string comments: type: array - items: &721 + items: &722 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -97395,7 +97723,7 @@ paths: application/json: schema: type: array - items: &700 + items: &701 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -97498,9 +97826,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: &701 + default: &702 value: id: 1 key: ssh-rsa AAA... @@ -97536,7 +97864,7 @@ paths: parameters: - *478 - *479 - - &702 + - &703 name: key_id description: The unique identifier of the key. in: path @@ -97548,9 +97876,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: *701 + default: *702 '404': *6 x-github: githubCloudOnly: false @@ -97570,7 +97898,7 @@ paths: parameters: - *478 - *479 - - *702 + - *703 responses: '204': description: Response @@ -97603,7 +97931,7 @@ paths: type: array items: *226 examples: - default: *684 + default: *685 headers: Link: *47 '404': *6 @@ -97663,7 +97991,7 @@ paths: application/json: schema: *226 examples: - default: &703 + default: &704 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -97709,7 +98037,7 @@ paths: application/json: schema: *226 examples: - default: *703 + default: *704 '404': *6 x-github: githubCloudOnly: false @@ -98162,7 +98490,7 @@ paths: application/json: schema: *595 examples: - default: *704 + default: *705 '204': description: Response when already merged '404': @@ -98229,7 +98557,7 @@ paths: application/json: schema: type: array - items: &705 + items: &706 title: Milestone description: A collection of related issues and pull requests. type: object @@ -98331,9 +98659,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: &706 + default: &707 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -98394,7 +98722,7 @@ paths: parameters: - *478 - *479 - - &707 + - &708 name: milestone_number description: The number that identifies the milestone. in: path @@ -98406,9 +98734,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: *706 + default: *707 '404': *6 x-github: githubCloudOnly: false @@ -98427,7 +98755,7 @@ paths: parameters: - *478 - *479 - - *707 + - *708 requestBody: required: false content: @@ -98465,9 +98793,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: *706 + default: *707 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98485,7 +98813,7 @@ paths: parameters: - *478 - *479 - - *707 + - *708 responses: '204': description: Response @@ -98508,7 +98836,7 @@ paths: parameters: - *478 - *479 - - *707 + - *708 - *17 - *19 responses: @@ -98520,7 +98848,7 @@ paths: type: array items: *226 examples: - default: *684 + default: *685 headers: Link: *47 x-github: @@ -98541,10 +98869,10 @@ paths: parameters: - *478 - *479 - - *708 - *709 - - *234 - *710 + - *234 + - *711 - *17 - *19 responses: @@ -98556,7 +98884,7 @@ paths: type: array items: *254 examples: - default: *711 + default: *712 headers: Link: *47 x-github: @@ -98646,7 +98974,7 @@ paths: description: Response content: application/json: - schema: &712 + schema: &713 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -98771,7 +99099,7 @@ paths: - custom_404 - public examples: - default: &713 + default: &714 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -98867,9 +99195,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *713 + default: *714 '422': *15 '409': *121 x-github: @@ -99038,7 +99366,7 @@ paths: application/json: schema: type: array - items: &714 + items: &715 title: Page Build description: Page Build type: object @@ -99185,9 +99513,9 @@ paths: description: Response content: application/json: - schema: *714 + schema: *715 examples: - default: &715 + default: &716 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -99247,9 +99575,9 @@ paths: description: Response content: application/json: - schema: *714 + schema: *715 examples: - default: *715 + default: *716 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99377,7 +99705,7 @@ paths: parameters: - *478 - *479 - - &716 + - &717 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -99437,7 +99765,7 @@ paths: parameters: - *478 - *479 - - *716 + - *717 responses: '204': *130 '404': *6 @@ -99817,7 +100145,7 @@ paths: type: array items: *158 examples: - default: *717 + default: *718 '403': *29 '404': *6 x-github: @@ -99856,7 +100184,7 @@ paths: required: - properties examples: - default: *718 + default: *719 responses: '204': description: No Content when custom property values are successfully created @@ -99957,7 +100285,7 @@ paths: type: array items: *599 examples: - default: *719 + default: *720 headers: Link: *47 '304': *37 @@ -100055,7 +100383,7 @@ paths: description: Response content: application/json: - schema: &723 + schema: &724 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -100255,7 +100583,7 @@ paths: - review_comment - self author_association: *224 - auto_merge: *720 + auto_merge: *721 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -100345,7 +100673,7 @@ paths: - merged_by - review_comments examples: - default: &724 + default: &725 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -100882,9 +101210,9 @@ paths: application/json: schema: type: array - items: *721 + items: *722 examples: - default: &726 + default: &727 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -100969,9 +101297,9 @@ paths: description: Response content: application/json: - schema: *721 + schema: *722 examples: - default: &722 + default: &723 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -101070,9 +101398,9 @@ paths: description: Response content: application/json: - schema: *721 + schema: *722 examples: - default: *722 + default: *723 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101275,7 +101603,7 @@ paths: parameters: - *478 - *479 - - &725 + - &726 name: pull_number description: The number that identifies the pull request. in: path @@ -101288,9 +101616,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *723 + schema: *724 examples: - default: *724 + default: *725 '304': *37 '404': *6 '406': @@ -101327,7 +101655,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: false content: @@ -101369,11 +101697,66 @@ paths: description: Response content: application/json: - schema: *723 + schema: *724 examples: - default: *724 + default: *725 + '422': *15 + '403': *29 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - *478 + - *479 + - *726 + responses: + '204': + description: Response + '403': *29 + '404': *6 '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *478 + - *479 + - *726 + responses: + '204': + description: Response '403': *29 + '404': *6 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101395,7 +101778,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: true content: @@ -101497,7 +101880,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 - *251 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -101518,9 +101901,9 @@ paths: application/json: schema: type: array - items: *721 + items: *722 examples: - default: *726 + default: *727 headers: Link: *47 x-github: @@ -101555,7 +101938,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: true content: @@ -101660,7 +102043,7 @@ paths: description: Response content: application/json: - schema: *721 + schema: *722 examples: example-for-a-multi-line-comment: value: @@ -101750,7 +102133,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 - *243 requestBody: required: true @@ -101773,7 +102156,7 @@ paths: description: Response content: application/json: - schema: *721 + schema: *722 examples: default: value: @@ -101861,7 +102244,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 - *17 - *19 responses: @@ -101873,7 +102256,7 @@ paths: type: array items: *595 examples: - default: *727 + default: *728 headers: Link: *47 x-github: @@ -101905,7 +102288,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 - *17 - *19 responses: @@ -101955,7 +102338,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 responses: '204': description: Response if pull request has been merged @@ -101980,7 +102363,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: false content: @@ -102093,7 +102476,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 responses: '200': description: Response @@ -102170,7 +102553,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: false content: @@ -102745,7 +103128,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: true content: @@ -103266,7 +103649,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 - *17 - *19 responses: @@ -103276,7 +103659,7 @@ paths: application/json: schema: type: array - items: &728 + items: &729 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -103429,7 +103812,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: false content: @@ -103515,9 +103898,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: &730 + default: &731 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -103582,8 +103965,8 @@ paths: parameters: - *478 - *479 - - *725 - - &729 + - *726 + - &730 name: review_id description: The unique identifier of the review. in: path @@ -103595,9 +103978,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: &731 + default: &732 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -103658,8 +104041,8 @@ paths: parameters: - *478 - *479 - - *725 - - *729 + - *726 + - *730 requestBody: required: true content: @@ -103682,7 +104065,7 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: default: value: @@ -103746,16 +104129,16 @@ paths: parameters: - *478 - *479 - - *725 - - *729 + - *726 + - *730 responses: '200': description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: *730 + default: *731 '422': *7 '404': *6 x-github: @@ -103784,8 +104167,8 @@ paths: parameters: - *478 - *479 - - *725 - - *729 + - *726 + - *730 - *17 - *19 responses: @@ -104022,8 +104405,8 @@ paths: parameters: - *478 - *479 - - *725 - - *729 + - *726 + - *730 requestBody: required: true content: @@ -104051,7 +104434,7 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: default: value: @@ -104116,8 +104499,8 @@ paths: parameters: - *478 - *479 - - *725 - - *729 + - *726 + - *730 requestBody: required: true content: @@ -104152,9 +104535,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: *731 + default: *732 '404': *6 '422': *7 '403': *29 @@ -104178,7 +104561,7 @@ paths: parameters: - *478 - *479 - - *725 + - *726 requestBody: required: false content: @@ -104255,9 +104638,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *733 examples: - default: &733 + default: &734 value: type: file encoding: base64 @@ -104320,9 +104703,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *733 examples: - default: *733 + default: *734 '404': *6 '422': *15 x-github: @@ -104355,7 +104738,7 @@ paths: application/json: schema: type: array - items: *734 + items: *735 examples: default: value: @@ -104526,9 +104909,9 @@ paths: description: Response content: application/json: - schema: *734 + schema: *735 examples: - default: &738 + default: &739 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -104635,7 +105018,7 @@ paths: parameters: - *478 - *479 - - &736 + - &737 name: asset_id description: The unique identifier of the asset. in: path @@ -104647,9 +105030,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: &737 + default: &738 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -104702,7 +105085,7 @@ paths: parameters: - *478 - *479 - - *736 + - *737 requestBody: required: false content: @@ -104730,9 +105113,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: *737 + default: *738 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104750,7 +105133,7 @@ paths: parameters: - *478 - *479 - - *736 + - *737 responses: '204': description: Response @@ -104868,9 +105251,9 @@ paths: description: Response content: application/json: - schema: *734 + schema: *735 examples: - default: *738 + default: *739 '404': *6 x-github: githubCloudOnly: false @@ -104902,9 +105285,9 @@ paths: description: Response content: application/json: - schema: *734 + schema: *735 examples: - default: *738 + default: *739 '404': *6 x-github: githubCloudOnly: false @@ -104928,7 +105311,7 @@ paths: parameters: - *478 - *479 - - &739 + - &740 name: release_id description: The unique identifier of the release. in: path @@ -104942,9 +105325,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *734 + schema: *735 examples: - default: *738 + default: *739 '401': description: Unauthorized x-github: @@ -104964,7 +105347,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 requestBody: required: false content: @@ -105028,9 +105411,9 @@ paths: description: Response content: application/json: - schema: *734 + schema: *735 examples: - default: *738 + default: *739 '404': description: Not Found if the discussion category name is invalid content: @@ -105053,7 +105436,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 responses: '204': description: Response @@ -105076,7 +105459,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 - *17 - *19 responses: @@ -105086,7 +105469,7 @@ paths: application/json: schema: type: array - items: *735 + items: *736 examples: default: value: @@ -105170,7 +105553,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 - name: name in: query required: true @@ -105196,7 +105579,7 @@ paths: description: Response for successful upload content: application/json: - schema: *735 + schema: *736 examples: response-for-successful-upload: value: @@ -105253,7 +105636,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -105302,7 +105685,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 requestBody: required: true content: @@ -105365,7 +105748,7 @@ paths: parameters: - *478 - *479 - - *739 + - *740 - *675 responses: '204': @@ -105409,7 +105792,7 @@ paths: oneOf: - allOf: - *172 - - &740 + - &741 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -105430,67 +105813,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *173 - - *740 + - *741 - allOf: - *174 - - *740 + - *741 - allOf: - *175 - - *740 + - *741 - allOf: + - *742 - *741 - - *740 - allOf: - *176 - - *740 + - *741 - allOf: - *177 - - *740 + - *741 - allOf: - *178 - - *740 + - *741 - allOf: - *179 - - *740 + - *741 - allOf: - *180 - - *740 + - *741 - allOf: - *181 - - *740 + - *741 - allOf: - *182 - - *740 + - *741 - allOf: - *183 - - *740 + - *741 - allOf: - *184 - - *740 + - *741 - allOf: - *185 - - *740 + - *741 - allOf: - *186 - - *740 + - *741 - allOf: - *187 - - *740 + - *741 - allOf: - *188 - - *740 + - *741 - allOf: - *189 - - *740 + - *741 - allOf: - *190 - - *740 + - *741 - allOf: - *191 - - *740 + - *741 - allOf: - *192 - - *740 + - *741 examples: default: value: @@ -105541,7 +105924,7 @@ paths: schema: type: boolean default: true - - *742 + - *743 responses: '200': description: Response @@ -105626,7 +106009,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *743 + items: *744 required: - name - enforcement @@ -105659,7 +106042,7 @@ paths: application/json: schema: *193 examples: - default: &752 + default: &753 value: id: 42 name: super cool ruleset @@ -105709,10 +106092,10 @@ paths: parameters: - *478 - *479 - - *744 - - *107 - *745 + - *107 - *746 + - *747 - *17 - *19 responses: @@ -105720,9 +106103,9 @@ paths: description: Response content: application/json: - schema: *747 + schema: *748 examples: - default: *748 + default: *749 '404': *6 '500': *40 x-github: @@ -105745,15 +106128,15 @@ paths: parameters: - *478 - *479 - - *749 + - *750 responses: '200': description: Response content: application/json: - schema: *750 + schema: *751 examples: - default: *751 + default: *752 '404': *6 '500': *40 x-github: @@ -105804,7 +106187,7 @@ paths: application/json: schema: *193 examples: - default: *752 + default: *753 '404': *6 '500': *40 put: @@ -105857,7 +106240,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *743 + items: *744 examples: default: value: @@ -105887,7 +106270,7 @@ paths: application/json: schema: *193 examples: - default: *752 + default: *753 '404': *6 '422': *15 '500': *40 @@ -106055,8 +106438,8 @@ paths: - *112 - *19 - *17 - - *753 - *754 + - *755 - *453 - *454 - *455 @@ -106068,7 +106451,7 @@ paths: application/json: schema: type: array - items: &758 + items: &759 type: object properties: number: *131 @@ -106087,8 +106470,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *755 - resolution: *756 + state: *756 + resolution: *757 resolved_at: type: string format: date-time @@ -106194,7 +106577,7 @@ paths: pull request. ' - oneOf: *757 + oneOf: *758 nullable: true has_more_locations: type: boolean @@ -106367,7 +106750,7 @@ paths: description: Response content: application/json: - schema: *758 + schema: *759 examples: default: value: @@ -106431,8 +106814,8 @@ paths: schema: type: object properties: - state: *755 - resolution: *756 + state: *756 + resolution: *757 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -106468,7 +106851,7 @@ paths: description: Response content: application/json: - schema: *758 + schema: *759 examples: default: value: @@ -106602,7 +106985,6 @@ paths: example: commit details: oneOf: - - *759 - *760 - *761 - *762 @@ -106615,6 +106997,7 @@ paths: - *769 - *770 - *771 + - *772 examples: default: value: @@ -106709,14 +107092,14 @@ paths: schema: type: object properties: - reason: &773 + reason: &774 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *772 + placeholder_id: *773 required: - reason - placeholder_id @@ -106733,7 +107116,7 @@ paths: schema: type: object properties: - reason: *773 + reason: *774 expire_at: type: string format: date-time @@ -106795,7 +107178,7 @@ paths: properties: incremental_scans: type: array - items: &774 + items: &775 description: Information on a single scan performed by secret scanning on the repository type: object @@ -106821,15 +107204,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *774 + items: *775 backfill_scans: type: array - items: *774 + items: *775 custom_pattern_backfill_scans: type: array items: allOf: - - *774 + - *775 - type: object properties: pattern_name: @@ -106842,7 +107225,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *774 + items: *775 examples: default: value: @@ -106952,9 +107335,9 @@ paths: application/json: schema: type: array - items: *775 + items: *776 examples: - default: *776 + default: *777 '400': *14 '404': *6 x-github: @@ -107138,9 +107521,9 @@ paths: description: Response content: application/json: - schema: *775 + schema: *776 examples: - default: &778 + default: &779 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -107475,7 +107858,7 @@ paths: description: Response content: application/json: - schema: *775 + schema: *776 examples: default: value: @@ -107623,15 +108006,15 @@ paths: parameters: - *478 - *479 - - *777 + - *778 responses: '200': description: Response content: application/json: - schema: *775 + schema: *776 examples: - default: *778 + default: *779 '403': *29 '404': *6 x-github: @@ -107657,7 +108040,7 @@ paths: parameters: - *478 - *479 - - *777 + - *778 requestBody: required: true content: @@ -107816,10 +108199,10 @@ paths: description: Response content: application/json: - schema: *775 + schema: *776 examples: - default: *778 - add_credit: *778 + default: *779 + add_credit: *779 '403': *29 '404': *6 '422': @@ -107859,7 +108242,7 @@ paths: parameters: - *478 - *479 - - *777 + - *778 responses: '202': *39 '400': *14 @@ -107888,7 +108271,7 @@ paths: parameters: - *478 - *479 - - *777 + - *778 responses: '202': description: Response @@ -108032,7 +108415,7 @@ paths: application/json: schema: type: array - items: &779 + items: &780 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -108405,7 +108788,7 @@ paths: application/json: schema: type: array - items: *779 + items: *780 examples: default: value: @@ -108493,7 +108876,7 @@ paths: description: Response content: application/json: - schema: *780 + schema: *781 examples: default: value: @@ -108587,7 +108970,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &781 + schema: &782 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -108682,7 +109065,7 @@ paths: description: Response content: application/json: - schema: *781 + schema: *782 examples: default: value: @@ -108889,7 +109272,7 @@ paths: description: Response content: application/json: - schema: &782 + schema: &783 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -108901,7 +109284,7 @@ paths: required: - names examples: - default: &783 + default: &784 value: names: - octocat @@ -108956,9 +109339,9 @@ paths: description: Response content: application/json: - schema: *782 + schema: *783 examples: - default: *783 + default: *784 '404': *6 '422': *7 x-github: @@ -108981,7 +109364,7 @@ paths: parameters: - *478 - *479 - - &784 + - &785 name: per description: The time frame to display results for. in: query @@ -109010,7 +109393,7 @@ paths: example: 128 clones: type: array - items: &785 + items: &786 title: Traffic type: object properties: @@ -109251,7 +109634,7 @@ paths: parameters: - *478 - *479 - - *784 + - *785 responses: '200': description: Response @@ -109270,7 +109653,7 @@ paths: example: 3782 views: type: array - items: *785 + items: *786 required: - uniques - count @@ -109913,248 +110296,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - *282 - - *680 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: *683 - examples: - default: *786 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *198 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - *282 - - *680 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: *683 - examples: - default: *786 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *198 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - *282 - - *680 - - *387 - responses: - '204': - description: Issue field value deleted successfully - '403': *29 - '404': *6 - '422': *15 - '503': *198 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/scim/v2/enterprises/{enterprise}/Groups": get: summary: List provisioned SCIM groups for an enterprise @@ -119129,7 +119270,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *702 + - *703 responses: '200': description: Response @@ -119160,7 +119301,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *702 + - *703 responses: '204': description: Response @@ -136070,7 +136211,7 @@ x-webhooks: nullable: true pull_requests: type: array - items: *723 + items: *724 repository: *878 organization: *877 installation: *876 @@ -145123,8 +145264,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *698 - required: *699 + properties: *699 + required: *700 nullable: true user: title: User @@ -146587,8 +146728,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *698 - required: *699 + properties: *699 + required: *700 nullable: true required: - url @@ -184063,7 +184204,7 @@ x-webhooks: organization: *877 pull_request: &935 allOf: - - *723 + - *724 - type: object properties: allow_auto_merge: @@ -184292,7 +184433,7 @@ x-webhooks: enum: - demilestoned enterprise: *875 - milestone: *705 + milestone: *706 number: *934 organization: *877 pull_request: &936 @@ -196276,7 +196417,7 @@ x-webhooks: enum: - milestoned enterprise: *875 - milestone: *705 + milestone: *706 number: *934 organization: *877 pull_request: *936 @@ -238387,7 +238528,7 @@ x-webhooks: installation: *876 organization: *877 repository: *878 - repository_advisory: *775 + repository_advisory: *776 sender: *4 required: - action @@ -238467,7 +238608,7 @@ x-webhooks: installation: *876 organization: *877 repository: *878 - repository_advisory: *775 + repository_advisory: *776 sender: *4 required: - action @@ -239554,16 +239695,16 @@ x-webhooks: properties: added: type: array - items: *743 + items: *744 deleted: type: array - items: *743 + items: *744 updated: type: array items: type: object properties: - rule: *743 + rule: *744 changes: type: object properties: diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 29ebeaca83..27a09c383d 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -20472,6 +20472,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20480,6 +20489,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -125338,6 +125351,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -125346,6 +125368,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -222072,7 +222098,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -222141,6 +222168,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -222285,7 +222324,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -222374,14 +222413,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -222417,12 +222457,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -222469,6 +222521,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -222517,7 +222581,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -222592,6 +222657,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -222918,7 +222995,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -222987,6 +223065,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -223055,7 +223145,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -223160,7 +223250,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -223196,12 +223287,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -501027,259 +501130,1377 @@ "category": "issues", "subcategory": "issue-field-values" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - "get": { - "summary": "List labels for an issue", - "description": "Lists all labels for an issue.", - "tags": [ - "issues" - ], - "operationId": "issues/list-labels-on-issue", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the label.", - "type": "integer", - "format": "int64", - "example": 208045946 - }, - "node_id": { - "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" - }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": "string", - "example": "Something isn't working", - "nullable": true - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "example": true - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - }, - { - "id": 208045947, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", - "name": "enhancement", - "description": "New feature or request", - "color": "a2eeef", - "default": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "301": { - "description": "Moved permanently", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "labels" - } }, "post": { - "summary": "Add labels to an issue", - "description": "Adds labels to an issue.", + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "issues" ], - "operationId": "issues/add-labels", + "operationId": "issues/add-issue-field-values", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Add multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after adding the new values", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" + }, + { + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + }, + "put": { + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/set-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Set multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after setting the new values", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" + }, + { + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { + "delete": { + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/delete-issue-field-value", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Issue field value deleted successfully" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + "get": { + "summary": "List labels for an issue", + "description": "Lists all labels for an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/list-labels-on-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "post": { + "summary": "Add labels to an issue", + "description": "Adds labels to an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/add-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -564836,6 +566057,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -633033,1099 +634602,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "IFT_GDKND" - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "example": "text" - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "example": "Sample text" - }, - { - "type": "number", - "example": 42.5 - }, - { - "type": "integer", - "example": 1 - } - ], - "nullable": true - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "The name of the option", - "type": "string", - "example": "High" - }, - "color": { - "description": "The color of the option", - "type": "string", - "example": "red" - } - }, - "required": [ - "id", - "name", - "color" - ], - "nullable": true - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "issue_field_id": 1, - "node_id": "IFT_GDKND", - "data_type": "text", - "value": "DRI" - }, - { - "issue_field_id": 2, - "node_id": "IFSS_SADMS", - "data_type": "single_select", - "value": 1, - "single_select_option": { - "id": 1, - "name": "High", - "color": "red" - } - }, - { - "issue_field_id": 3, - "node_id": "IFN_POINTS", - "data_type": "number", - "value": 42 - }, - { - "issue_field_id": 4, - "node_id": "IFD_DUEDATE", - "data_type": "date", - "value": "2025-12-25" - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "issue_field_id", - "description": "The unique identifier of the issue field.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 5669a6a467..e961bc37a6 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -1082,7 +1082,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &780 + - &781 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -8860,6 +8860,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -8870,6 +8879,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -22314,7 +22328,7 @@ paths: - *167 rules: type: array - items: &746 + items: &747 title: Repository Rule type: object description: A repository rule. @@ -22323,7 +22337,7 @@ paths: - *173 - *174 - *175 - - &744 + - &745 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -22919,14 +22933,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &758 + state: &759 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &759 + resolution: &760 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -23043,8 +23057,8 @@ paths: pull request. ' - oneOf: &760 - - &762 + oneOf: &761 + - &763 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -23102,7 +23116,7 @@ paths: - blob_url - commit_sha - commit_url - - &763 + - &764 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -23157,7 +23171,7 @@ paths: - page_url - commit_sha - commit_url - - &764 + - &765 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -23177,7 +23191,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &765 + - &766 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -23197,7 +23211,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &766 + - &767 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -23217,7 +23231,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &767 + - &768 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -23231,7 +23245,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &768 + - &769 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -23245,7 +23259,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &769 + - &770 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -23259,7 +23273,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &770 + - &771 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -23279,7 +23293,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &771 + - &772 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -23299,7 +23313,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &772 + - &773 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -23319,7 +23333,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &773 + - &774 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -23339,7 +23353,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &774 + - &775 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -27832,7 +27846,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &701 + properties: &702 pinned_at: type: string format: date-time @@ -27844,7 +27858,7 @@ paths: properties: *20 required: *21 nullable: true - required: &702 + required: &703 - pinned_at - pinned_by nullable: true @@ -28683,7 +28697,7 @@ paths: type: string release: allOf: - - &737 + - &738 title: Release description: A release. type: object @@ -28754,7 +28768,7 @@ paths: author: *4 assets: type: array - items: &738 + items: &739 title: Release Asset description: Data related to a release. type: object @@ -32768,7 +32782,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &711 + - &712 name: all description: If `true`, show notifications marked as read. in: query @@ -32776,7 +32790,7 @@ paths: schema: type: boolean default: false - - &712 + - &713 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -32786,7 +32800,7 @@ paths: type: boolean default: false - *234 - - &713 + - &714 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -33330,7 +33344,7 @@ paths: - url - subscription_url examples: - default: &714 + default: &715 value: - id: '1' repository: @@ -34195,7 +34209,7 @@ paths: type: array items: *158 examples: - default: &720 + default: &721 value: - property_name: environment value: production @@ -34245,7 +34259,7 @@ paths: required: - properties examples: - default: &721 + default: &722 value: properties: - property_name: environment @@ -35698,6 +35712,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -35708,6 +35731,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -54128,6 +54156,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -54187,6 +54216,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -54224,7 +54262,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -54316,8 +54354,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -54325,6 +54363,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -54356,13 +54395,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -54401,6 +54452,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -54442,6 +54503,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -54507,6 +54569,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -54630,7 +54701,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -54727,6 +54798,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -54758,13 +54830,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -55403,7 +55487,7 @@ paths: - review_comment - self author_association: *224 - auto_merge: &723 + auto_merge: &724 title: Auto merge description: The status of auto merging a pull request. type: object @@ -59518,7 +59602,7 @@ paths: - *89 - *17 - *19 - - &745 + - &746 name: targets description: | A comma-separated list of rule targets to filter by. @@ -59734,7 +59818,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *89 - - &747 + - &748 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -59746,14 +59830,14 @@ paths: x-multi-segment: true - *314 - *107 - - &748 + - &749 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &749 + - &750 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -59773,7 +59857,7 @@ paths: description: Response content: application/json: - schema: &750 + schema: &751 title: Rule Suites description: Response type: array @@ -59828,7 +59912,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &751 + default: &752 value: - id: 21 actor_id: 12 @@ -59872,7 +59956,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *89 - - &752 + - &753 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -59888,7 +59972,7 @@ paths: description: Response content: application/json: - schema: &753 + schema: &754 title: Rule Suite description: Response type: object @@ -59987,7 +60071,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &754 + default: &755 value: id: 21 actor_id: 12 @@ -60323,7 +60407,7 @@ paths: - *112 - *19 - *17 - - &756 + - &757 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -60333,7 +60417,7 @@ paths: required: false schema: type: string - - &757 + - &758 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -60546,7 +60630,7 @@ paths: application/json: schema: type: array - items: &778 + items: &779 description: A repository security advisory. type: object properties: @@ -60869,7 +60953,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &779 + default: &780 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -82148,7 +82232,7 @@ paths: type: array items: *597 examples: - default: &730 + default: &731 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -82439,7 +82523,7 @@ paths: type: array items: *601 examples: - default: &722 + default: &723 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -82997,7 +83081,7 @@ paths: application/json: schema: *597 examples: - default: &707 + default: &708 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -83656,7 +83740,7 @@ paths: application/json: schema: type: array - items: &783 + items: &784 title: Status description: The status of a commit. type: object @@ -84625,7 +84709,7 @@ paths: - size - type - url - - &735 + - &736 title: Content File description: Content File type: object @@ -85269,7 +85353,7 @@ paths: items: type: object properties: - placeholder_id: &775 + placeholder_id: &776 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -96076,7 +96160,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &688 + - &689 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -96130,7 +96214,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &689 + - &690 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -96266,7 +96350,7 @@ paths: - performed_via_github_app - assignee - assigner - - &690 + - &691 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -96317,7 +96401,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &691 + - &692 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -96368,7 +96452,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &692 + - &693 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -96422,7 +96506,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &693 + - &694 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -96469,7 +96553,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &694 + - &695 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -96516,7 +96600,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &695 + - &696 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -96576,7 +96660,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &696 + - &697 title: Locked Issue Event description: Locked Issue Event type: object @@ -96624,7 +96708,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &697 + - &698 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -96690,7 +96774,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &698 + - &699 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -96756,7 +96840,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &699 + - &700 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -96822,7 +96906,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &700 + - &701 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -96944,7 +97028,7 @@ paths: type: array items: *686 examples: - default: &789 + default: &687 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -96976,6 +97060,250 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - *480 + - *481 + - *683 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: *686 + examples: + default: *687 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *198 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - *480 + - *481 + - *683 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: *686 + examples: + default: *687 + '400': *14 + '403': *29 + '404': *6 + '422': *15 + '503': *198 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - *480 + - *481 + - *683 + - *388 + responses: + '204': + description: Issue field value deleted successfully + '403': *29 + '404': *6 + '422': *15 + '503': *198 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -97001,7 +97329,7 @@ paths: type: array items: *226 examples: - default: &687 + default: &688 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -97084,7 +97412,7 @@ paths: type: array items: *226 examples: - default: *687 + default: *688 '301': *486 '404': *6 '410': *673 @@ -97168,7 +97496,7 @@ paths: type: array items: *226 examples: - default: *687 + default: *688 '301': *486 '404': *6 '410': *673 @@ -97759,7 +98087,6 @@ paths: description: Timeline Event type: object anyOf: - - *688 - *689 - *690 - *691 @@ -97772,6 +98099,7 @@ paths: - *698 - *699 - *700 + - *701 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -97832,8 +98160,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *701 - required: *702 + properties: *702 + required: *703 nullable: true required: - event @@ -98088,7 +98416,7 @@ paths: type: string comments: type: array - items: &724 + items: &725 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -98620,7 +98948,7 @@ paths: application/json: schema: type: array - items: &703 + items: &704 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -98723,9 +99051,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *704 examples: - default: &704 + default: &705 value: id: 1 key: ssh-rsa AAA... @@ -98761,7 +99089,7 @@ paths: parameters: - *480 - *481 - - &705 + - &706 name: key_id description: The unique identifier of the key. in: path @@ -98773,9 +99101,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *704 examples: - default: *704 + default: *705 '404': *6 x-github: githubCloudOnly: false @@ -98795,7 +99123,7 @@ paths: parameters: - *480 - *481 - - *705 + - *706 responses: '204': description: Response @@ -98828,7 +99156,7 @@ paths: type: array items: *226 examples: - default: *687 + default: *688 headers: Link: *47 '404': *6 @@ -98888,7 +99216,7 @@ paths: application/json: schema: *226 examples: - default: &706 + default: &707 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -98934,7 +99262,7 @@ paths: application/json: schema: *226 examples: - default: *706 + default: *707 '404': *6 x-github: githubCloudOnly: false @@ -99387,7 +99715,7 @@ paths: application/json: schema: *597 examples: - default: *707 + default: *708 '204': description: Response when already merged '404': @@ -99454,7 +99782,7 @@ paths: application/json: schema: type: array - items: &708 + items: &709 title: Milestone description: A collection of related issues and pull requests. type: object @@ -99556,9 +99884,9 @@ paths: description: Response content: application/json: - schema: *708 + schema: *709 examples: - default: &709 + default: &710 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -99619,7 +99947,7 @@ paths: parameters: - *480 - *481 - - &710 + - &711 name: milestone_number description: The number that identifies the milestone. in: path @@ -99631,9 +99959,9 @@ paths: description: Response content: application/json: - schema: *708 + schema: *709 examples: - default: *709 + default: *710 '404': *6 x-github: githubCloudOnly: false @@ -99652,7 +99980,7 @@ paths: parameters: - *480 - *481 - - *710 + - *711 requestBody: required: false content: @@ -99690,9 +100018,9 @@ paths: description: Response content: application/json: - schema: *708 + schema: *709 examples: - default: *709 + default: *710 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99710,7 +100038,7 @@ paths: parameters: - *480 - *481 - - *710 + - *711 responses: '204': description: Response @@ -99733,7 +100061,7 @@ paths: parameters: - *480 - *481 - - *710 + - *711 - *17 - *19 responses: @@ -99745,7 +100073,7 @@ paths: type: array items: *226 examples: - default: *687 + default: *688 headers: Link: *47 x-github: @@ -99766,10 +100094,10 @@ paths: parameters: - *480 - *481 - - *711 - *712 - - *234 - *713 + - *234 + - *714 - *17 - *19 responses: @@ -99781,7 +100109,7 @@ paths: type: array items: *254 examples: - default: *714 + default: *715 headers: Link: *47 x-github: @@ -99871,7 +100199,7 @@ paths: description: Response content: application/json: - schema: &715 + schema: &716 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -99996,7 +100324,7 @@ paths: - custom_404 - public examples: - default: &716 + default: &717 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -100092,9 +100420,9 @@ paths: description: Response content: application/json: - schema: *715 + schema: *716 examples: - default: *716 + default: *717 '422': *15 '409': *121 x-github: @@ -100263,7 +100591,7 @@ paths: application/json: schema: type: array - items: &717 + items: &718 title: Page Build description: Page Build type: object @@ -100410,9 +100738,9 @@ paths: description: Response content: application/json: - schema: *717 + schema: *718 examples: - default: &718 + default: &719 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -100472,9 +100800,9 @@ paths: description: Response content: application/json: - schema: *717 + schema: *718 examples: - default: *718 + default: *719 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100602,7 +100930,7 @@ paths: parameters: - *480 - *481 - - &719 + - &720 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -100662,7 +100990,7 @@ paths: parameters: - *480 - *481 - - *719 + - *720 responses: '204': *130 '404': *6 @@ -101042,7 +101370,7 @@ paths: type: array items: *158 examples: - default: *720 + default: *721 '403': *29 '404': *6 x-github: @@ -101081,7 +101409,7 @@ paths: required: - properties examples: - default: *721 + default: *722 responses: '204': description: No Content when custom property values are successfully created @@ -101182,7 +101510,7 @@ paths: type: array items: *601 examples: - default: *722 + default: *723 headers: Link: *47 '304': *37 @@ -101280,7 +101608,7 @@ paths: description: Response content: application/json: - schema: &726 + schema: &727 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -101491,7 +101819,7 @@ paths: - review_comment - self author_association: *224 - auto_merge: *723 + auto_merge: *724 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -101677,7 +102005,7 @@ paths: - review_comments version: '2026-03-10' examples: - default: &727 + default: &728 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -102245,9 +102573,9 @@ paths: application/json: schema: type: array - items: *724 + items: *725 examples: - default: &729 + default: &730 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -102332,9 +102660,9 @@ paths: description: Response content: application/json: - schema: *724 + schema: *725 examples: - default: &725 + default: &726 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -102433,9 +102761,9 @@ paths: description: Response content: application/json: - schema: *724 + schema: *725 examples: - default: *725 + default: *726 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102638,7 +102966,7 @@ paths: parameters: - *480 - *481 - - &728 + - &729 name: pull_number description: The number that identifies the pull request. in: path @@ -102651,9 +102979,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *726 + schema: *727 examples: - default: *727 + default: *728 '304': *37 '404': *6 '406': @@ -102690,7 +103018,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 requestBody: required: false content: @@ -102732,11 +103060,66 @@ paths: description: Response content: application/json: - schema: *726 + schema: *727 examples: - default: *727 + default: *728 + '422': *15 + '403': *29 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - *480 + - *481 + - *729 + responses: + '204': + description: Response + '403': *29 + '404': *6 '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *480 + - *481 + - *729 + responses: + '204': + description: Response '403': *29 + '404': *6 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102758,7 +103141,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 requestBody: required: true content: @@ -102860,7 +103243,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 - *251 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -102881,9 +103264,9 @@ paths: application/json: schema: type: array - items: *724 + items: *725 examples: - default: *729 + default: *730 headers: Link: *47 x-github: @@ -102918,7 +103301,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 requestBody: required: true content: @@ -103023,7 +103406,7 @@ paths: description: Response content: application/json: - schema: *724 + schema: *725 examples: example-for-a-multi-line-comment: value: @@ -103113,7 +103496,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 - *243 requestBody: required: true @@ -103136,7 +103519,7 @@ paths: description: Response content: application/json: - schema: *724 + schema: *725 examples: default: value: @@ -103224,7 +103607,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 - *17 - *19 responses: @@ -103236,7 +103619,7 @@ paths: type: array items: *597 examples: - default: *730 + default: *731 headers: Link: *47 x-github: @@ -103268,7 +103651,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 - *17 - *19 responses: @@ -103318,7 +103701,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 responses: '204': description: Response if pull request has been merged @@ -103343,7 +103726,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 requestBody: required: false content: @@ -103456,7 +103839,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 responses: '200': description: Response @@ -103533,7 +103916,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 requestBody: required: false content: @@ -104108,7 +104491,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 requestBody: required: true content: @@ -104660,7 +105043,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 - *17 - *19 responses: @@ -104670,7 +105053,7 @@ paths: application/json: schema: type: array - items: &731 + items: &732 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -104823,7 +105206,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 requestBody: required: false content: @@ -104909,9 +105292,9 @@ paths: description: Response content: application/json: - schema: *731 + schema: *732 examples: - default: &733 + default: &734 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -104976,8 +105359,8 @@ paths: parameters: - *480 - *481 - - *728 - - &732 + - *729 + - &733 name: review_id description: The unique identifier of the review. in: path @@ -104989,9 +105372,9 @@ paths: description: Response content: application/json: - schema: *731 + schema: *732 examples: - default: &734 + default: &735 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -105052,8 +105435,8 @@ paths: parameters: - *480 - *481 - - *728 - - *732 + - *729 + - *733 requestBody: required: true content: @@ -105076,7 +105459,7 @@ paths: description: Response content: application/json: - schema: *731 + schema: *732 examples: default: value: @@ -105140,16 +105523,16 @@ paths: parameters: - *480 - *481 - - *728 - - *732 + - *729 + - *733 responses: '200': description: Response content: application/json: - schema: *731 + schema: *732 examples: - default: *733 + default: *734 '422': *7 '404': *6 x-github: @@ -105178,8 +105561,8 @@ paths: parameters: - *480 - *481 - - *728 - - *732 + - *729 + - *733 - *17 - *19 responses: @@ -105416,8 +105799,8 @@ paths: parameters: - *480 - *481 - - *728 - - *732 + - *729 + - *733 requestBody: required: true content: @@ -105445,7 +105828,7 @@ paths: description: Response content: application/json: - schema: *731 + schema: *732 examples: default: value: @@ -105510,8 +105893,8 @@ paths: parameters: - *480 - *481 - - *728 - - *732 + - *729 + - *733 requestBody: required: true content: @@ -105546,9 +105929,9 @@ paths: description: Response content: application/json: - schema: *731 + schema: *732 examples: - default: *734 + default: *735 '404': *6 '422': *7 '403': *29 @@ -105572,7 +105955,7 @@ paths: parameters: - *480 - *481 - - *728 + - *729 requestBody: required: false content: @@ -105649,9 +106032,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: &736 + default: &737 value: type: file encoding: base64 @@ -105714,9 +106097,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: *736 + default: *737 '404': *6 '422': *15 x-github: @@ -105749,7 +106132,7 @@ paths: application/json: schema: type: array - items: *737 + items: *738 examples: default: value: @@ -105920,9 +106303,9 @@ paths: description: Response content: application/json: - schema: *737 + schema: *738 examples: - default: &741 + default: &742 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -106029,7 +106412,7 @@ paths: parameters: - *480 - *481 - - &739 + - &740 name: asset_id description: The unique identifier of the asset. in: path @@ -106041,9 +106424,9 @@ paths: description: Response content: application/json: - schema: *738 + schema: *739 examples: - default: &740 + default: &741 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -106096,7 +106479,7 @@ paths: parameters: - *480 - *481 - - *739 + - *740 requestBody: required: false content: @@ -106124,9 +106507,9 @@ paths: description: Response content: application/json: - schema: *738 + schema: *739 examples: - default: *740 + default: *741 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106144,7 +106527,7 @@ paths: parameters: - *480 - *481 - - *739 + - *740 responses: '204': description: Response @@ -106262,9 +106645,9 @@ paths: description: Response content: application/json: - schema: *737 + schema: *738 examples: - default: *741 + default: *742 '404': *6 x-github: githubCloudOnly: false @@ -106296,9 +106679,9 @@ paths: description: Response content: application/json: - schema: *737 + schema: *738 examples: - default: *741 + default: *742 '404': *6 x-github: githubCloudOnly: false @@ -106322,7 +106705,7 @@ paths: parameters: - *480 - *481 - - &742 + - &743 name: release_id description: The unique identifier of the release. in: path @@ -106336,9 +106719,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *737 + schema: *738 examples: - default: *741 + default: *742 '401': description: Unauthorized x-github: @@ -106358,7 +106741,7 @@ paths: parameters: - *480 - *481 - - *742 + - *743 requestBody: required: false content: @@ -106422,9 +106805,9 @@ paths: description: Response content: application/json: - schema: *737 + schema: *738 examples: - default: *741 + default: *742 '404': description: Not Found if the discussion category name is invalid content: @@ -106447,7 +106830,7 @@ paths: parameters: - *480 - *481 - - *742 + - *743 responses: '204': description: Response @@ -106470,7 +106853,7 @@ paths: parameters: - *480 - *481 - - *742 + - *743 - *17 - *19 responses: @@ -106480,7 +106863,7 @@ paths: application/json: schema: type: array - items: *738 + items: *739 examples: default: value: @@ -106564,7 +106947,7 @@ paths: parameters: - *480 - *481 - - *742 + - *743 - name: name in: query required: true @@ -106590,7 +106973,7 @@ paths: description: Response for successful upload content: application/json: - schema: *738 + schema: *739 examples: response-for-successful-upload: value: @@ -106647,7 +107030,7 @@ paths: parameters: - *480 - *481 - - *742 + - *743 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -106696,7 +107079,7 @@ paths: parameters: - *480 - *481 - - *742 + - *743 requestBody: required: true content: @@ -106759,7 +107142,7 @@ paths: parameters: - *480 - *481 - - *742 + - *743 - *677 responses: '204': @@ -106803,7 +107186,7 @@ paths: oneOf: - allOf: - *172 - - &743 + - &744 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -106824,67 +107207,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *173 - - *743 + - *744 - allOf: - *174 - - *743 + - *744 - allOf: - *175 - - *743 + - *744 - allOf: + - *745 - *744 - - *743 - allOf: - *176 - - *743 + - *744 - allOf: - *177 - - *743 + - *744 - allOf: - *178 - - *743 + - *744 - allOf: - *179 - - *743 + - *744 - allOf: - *180 - - *743 + - *744 - allOf: - *181 - - *743 + - *744 - allOf: - *182 - - *743 + - *744 - allOf: - *183 - - *743 + - *744 - allOf: - *184 - - *743 + - *744 - allOf: - *185 - - *743 + - *744 - allOf: - *186 - - *743 + - *744 - allOf: - *187 - - *743 + - *744 - allOf: - *188 - - *743 + - *744 - allOf: - *189 - - *743 + - *744 - allOf: - *190 - - *743 + - *744 - allOf: - *191 - - *743 + - *744 - allOf: - *192 - - *743 + - *744 examples: default: value: @@ -106935,7 +107318,7 @@ paths: schema: type: boolean default: true - - *745 + - *746 responses: '200': description: Response @@ -107020,7 +107403,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *746 + items: *747 required: - name - enforcement @@ -107053,7 +107436,7 @@ paths: application/json: schema: *193 examples: - default: &755 + default: &756 value: id: 42 name: super cool ruleset @@ -107103,10 +107486,10 @@ paths: parameters: - *480 - *481 - - *747 - - *107 - *748 + - *107 - *749 + - *750 - *17 - *19 responses: @@ -107114,9 +107497,9 @@ paths: description: Response content: application/json: - schema: *750 + schema: *751 examples: - default: *751 + default: *752 '404': *6 '500': *40 x-github: @@ -107139,15 +107522,15 @@ paths: parameters: - *480 - *481 - - *752 + - *753 responses: '200': description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: *754 + default: *755 '404': *6 '500': *40 x-github: @@ -107198,7 +107581,7 @@ paths: application/json: schema: *193 examples: - default: *755 + default: *756 '404': *6 '500': *40 put: @@ -107251,7 +107634,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *746 + items: *747 examples: default: value: @@ -107281,7 +107664,7 @@ paths: application/json: schema: *193 examples: - default: *755 + default: *756 '404': *6 '422': *15 '500': *40 @@ -107449,8 +107832,8 @@ paths: - *112 - *19 - *17 - - *756 - *757 + - *758 - *455 - *456 - *457 @@ -107462,7 +107845,7 @@ paths: application/json: schema: type: array - items: &761 + items: &762 type: object properties: number: *131 @@ -107481,8 +107864,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *758 - resolution: *759 + state: *759 + resolution: *760 resolved_at: type: string format: date-time @@ -107588,7 +107971,7 @@ paths: pull request. ' - oneOf: *760 + oneOf: *761 nullable: true has_more_locations: type: boolean @@ -107761,7 +108144,7 @@ paths: description: Response content: application/json: - schema: *761 + schema: *762 examples: default: value: @@ -107825,8 +108208,8 @@ paths: schema: type: object properties: - state: *758 - resolution: *759 + state: *759 + resolution: *760 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -107862,7 +108245,7 @@ paths: description: Response content: application/json: - schema: *761 + schema: *762 examples: default: value: @@ -107996,7 +108379,6 @@ paths: example: commit details: oneOf: - - *762 - *763 - *764 - *765 @@ -108009,6 +108391,7 @@ paths: - *772 - *773 - *774 + - *775 examples: default: value: @@ -108103,14 +108486,14 @@ paths: schema: type: object properties: - reason: &776 + reason: &777 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *775 + placeholder_id: *776 required: - reason - placeholder_id @@ -108127,7 +108510,7 @@ paths: schema: type: object properties: - reason: *776 + reason: *777 expire_at: type: string format: date-time @@ -108189,7 +108572,7 @@ paths: properties: incremental_scans: type: array - items: &777 + items: &778 description: Information on a single scan performed by secret scanning on the repository type: object @@ -108215,15 +108598,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *777 + items: *778 backfill_scans: type: array - items: *777 + items: *778 custom_pattern_backfill_scans: type: array items: allOf: - - *777 + - *778 - type: object properties: pattern_name: @@ -108236,7 +108619,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *777 + items: *778 examples: default: value: @@ -108346,9 +108729,9 @@ paths: application/json: schema: type: array - items: *778 + items: *779 examples: - default: *779 + default: *780 '400': *14 '404': *6 x-github: @@ -108532,9 +108915,9 @@ paths: description: Response content: application/json: - schema: *778 + schema: *779 examples: - default: &781 + default: &782 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -108878,7 +109261,7 @@ paths: description: Response content: application/json: - schema: *778 + schema: *779 examples: default: value: @@ -109033,15 +109416,15 @@ paths: parameters: - *480 - *481 - - *780 + - *781 responses: '200': description: Response content: application/json: - schema: *778 + schema: *779 examples: - default: *781 + default: *782 '403': *29 '404': *6 x-github: @@ -109067,7 +109450,7 @@ paths: parameters: - *480 - *481 - - *780 + - *781 requestBody: required: true content: @@ -109226,10 +109609,10 @@ paths: description: Response content: application/json: - schema: *778 + schema: *779 examples: - default: *781 - add_credit: *781 + default: *782 + add_credit: *782 '403': *29 '404': *6 '422': @@ -109269,7 +109652,7 @@ paths: parameters: - *480 - *481 - - *780 + - *781 responses: '202': *39 '400': *14 @@ -109298,7 +109681,7 @@ paths: parameters: - *480 - *481 - - *780 + - *781 responses: '202': description: Response @@ -109442,7 +109825,7 @@ paths: application/json: schema: type: array - items: &782 + items: &783 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -109815,7 +110198,7 @@ paths: application/json: schema: type: array - items: *782 + items: *783 examples: default: value: @@ -109903,7 +110286,7 @@ paths: description: Response content: application/json: - schema: *783 + schema: *784 examples: default: value: @@ -109997,7 +110380,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &784 + schema: &785 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -110092,7 +110475,7 @@ paths: description: Response content: application/json: - schema: *784 + schema: *785 examples: default: value: @@ -110299,7 +110682,7 @@ paths: description: Response content: application/json: - schema: &785 + schema: &786 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -110311,7 +110694,7 @@ paths: required: - names examples: - default: &786 + default: &787 value: names: - octocat @@ -110366,9 +110749,9 @@ paths: description: Response content: application/json: - schema: *785 + schema: *786 examples: - default: *786 + default: *787 '404': *6 '422': *7 x-github: @@ -110391,7 +110774,7 @@ paths: parameters: - *480 - *481 - - &787 + - &788 name: per description: The time frame to display results for. in: query @@ -110420,7 +110803,7 @@ paths: example: 128 clones: type: array - items: &788 + items: &789 title: Traffic type: object properties: @@ -110661,7 +111044,7 @@ paths: parameters: - *480 - *481 - - *787 + - *788 responses: '200': description: Response @@ -110680,7 +111063,7 @@ paths: example: 3782 views: type: array - items: *788 + items: *789 required: - uniques - count @@ -111330,248 +111713,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - *282 - - *683 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: *686 - examples: - default: *789 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *198 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - *282 - - *683 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: *686 - examples: - default: *789 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *198 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - *282 - - *683 - - *388 - responses: - '204': - description: Issue field value deleted successfully - '403': *29 - '404': *6 - '422': *15 - '503': *198 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/scim/v2/enterprises/{enterprise}/Groups": get: summary: List provisioned SCIM groups for an enterprise @@ -120437,7 +120578,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *705 + - *706 responses: '200': description: Response @@ -120468,7 +120609,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *705 + - *706 responses: '204': description: Response @@ -137492,7 +137633,7 @@ x-webhooks: nullable: true pull_requests: type: array - items: *726 + items: *727 repository: *881 organization: *880 installation: *879 @@ -146545,8 +146686,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *701 - required: *702 + properties: *702 + required: *703 nullable: true user: title: User @@ -148009,8 +148150,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *701 - required: *702 + properties: *702 + required: *703 nullable: true required: - url @@ -185588,7 +185729,7 @@ x-webhooks: organization: *880 pull_request: &939 allOf: - - *726 + - *727 - type: object properties: allow_auto_merge: @@ -185817,7 +185958,7 @@ x-webhooks: enum: - demilestoned enterprise: *878 - milestone: *708 + milestone: *709 number: *938 organization: *880 pull_request: &940 @@ -197937,7 +198078,7 @@ x-webhooks: enum: - milestoned enterprise: *878 - milestone: *708 + milestone: *709 number: *938 organization: *880 pull_request: *940 @@ -240499,7 +240640,7 @@ x-webhooks: installation: *879 organization: *880 repository: *881 - repository_advisory: *778 + repository_advisory: *779 sender: *4 required: - action @@ -240579,7 +240720,7 @@ x-webhooks: installation: *879 organization: *880 repository: *881 - repository_advisory: *778 + repository_advisory: *779 sender: *4 required: - action @@ -241666,16 +241807,16 @@ x-webhooks: properties: added: type: array - items: *746 + items: *747 deleted: type: array - items: *746 + items: *747 updated: type: array items: type: object properties: - rule: *746 + rule: *747 changes: type: object properties: diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index c62fa2897f..8c73fa68cb 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -3434,6 +3434,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -3442,6 +3451,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -20765,6 +20778,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20773,6 +20795,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -38329,7 +38355,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38412,14 +38438,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38455,12 +38482,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -38507,6 +38546,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -38661,7 +38712,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38754,7 +38805,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38790,12 +38842,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -69313,6 +69377,346 @@ "category": "issues", "subcategory": "issue-field-values" } + }, + "post": { + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/add-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Add multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after adding the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + }, + "put": { + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/set-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Set multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after setting the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { + "delete": { + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/delete-issue-field-value", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/issue-field-id" + } + ], + "responses": { + "204": { + "description": "Issue field value deleted successfully" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } } }, "/repos/{owner}/{repo}/issues/{issue_number}/labels": { @@ -74014,6 +74418,94 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -80560,339 +81052,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - }, - { - "$ref": "#/components/parameters/issue-field-id" - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", @@ -142213,7 +142372,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -142282,6 +142442,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -142337,7 +142509,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -142412,6 +142585,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index f1b3075481..68c11a429c 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -2416,6 +2416,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -2426,6 +2435,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -14902,6 +14916,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -14912,6 +14935,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -27787,7 +27815,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -27879,8 +27907,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -27888,6 +27916,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -27919,13 +27948,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -27964,6 +28005,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -28072,7 +28123,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -28169,6 +28220,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -28200,13 +28252,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -50439,6 +50503,268 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/issue-field-id" + responses: + '204': + description: Issue field value deleted successfully + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -53713,6 +54039,67 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -58334,266 +58721,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - - "$ref": "#/components/parameters/issue-field-id" - responses: - '204': - description: Issue field value deleted successfully - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/scim/v2/enterprises/{enterprise}/Groups": get: summary: List provisioned SCIM groups for an enterprise @@ -104038,6 +104165,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -104094,6 +104222,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -104142,6 +104279,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -104204,6 +104342,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time diff --git a/descriptions/ghec/ghec.2026-03-10.json b/descriptions/ghec/ghec.2026-03-10.json index bf078783cb..f0c3739edd 100644 --- a/descriptions/ghec/ghec.2026-03-10.json +++ b/descriptions/ghec/ghec.2026-03-10.json @@ -3434,6 +3434,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -3442,6 +3451,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -20746,6 +20759,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20754,6 +20776,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -38270,7 +38296,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38353,14 +38379,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38396,12 +38423,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -38448,6 +38487,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -38602,7 +38653,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38695,7 +38746,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38731,12 +38783,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -69212,6 +69276,346 @@ "category": "issues", "subcategory": "issue-field-values" } + }, + "post": { + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/add-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Add multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after adding the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + }, + "put": { + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/set-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Set multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after setting the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { + "delete": { + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/delete-issue-field-value", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/issue-field-id" + } + ], + "responses": { + "204": { + "description": "Issue field value deleted successfully" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } } }, "/repos/{owner}/{repo}/issues/{issue_number}/labels": { @@ -73913,6 +74317,94 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -80459,339 +80951,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - }, - { - "$ref": "#/components/parameters/issue-field-id" - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", @@ -141696,7 +141855,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -141765,6 +141925,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -141820,7 +141992,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -141895,6 +142068,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/ghec/ghec.2026-03-10.yaml b/descriptions/ghec/ghec.2026-03-10.yaml index ae492d5fbd..5c3f1b0d75 100644 --- a/descriptions/ghec/ghec.2026-03-10.yaml +++ b/descriptions/ghec/ghec.2026-03-10.yaml @@ -2416,6 +2416,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -2426,6 +2435,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -14888,6 +14902,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -14898,6 +14921,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -27744,7 +27772,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -27836,8 +27864,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -27845,6 +27873,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -27876,13 +27905,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -27921,6 +27962,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -28029,7 +28080,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -28126,6 +28177,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -28157,13 +28209,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -50356,6 +50420,268 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/issue-field-id" + responses: + '204': + description: Issue field value deleted successfully + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -53630,6 +53956,67 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -58251,266 +58638,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - - "$ref": "#/components/parameters/issue-field-id" - responses: - '204': - description: Issue field value deleted successfully - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/scim/v2/enterprises/{enterprise}/Groups": get: summary: List provisioned SCIM groups for an enterprise @@ -103633,6 +103760,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -103689,6 +103817,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -103737,6 +103874,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -103799,6 +103937,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 76f141fb59..8bec945c6f 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -3448,6 +3448,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -3456,6 +3465,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -20837,6 +20850,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20845,6 +20867,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -38534,7 +38560,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38617,14 +38643,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38660,12 +38687,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -38712,6 +38751,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -38866,7 +38917,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. 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).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38959,7 +39010,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38995,12 +39047,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -69641,6 +69705,346 @@ "category": "issues", "subcategory": "issue-field-values" } + }, + "post": { + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/add-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Add multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after adding the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + }, + "put": { + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/set-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Set multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after setting the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": { + "delete": { + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/delete-issue-field-value", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/issue-field-id" + } + ], + "responses": { + "204": { + "description": "Issue field value deleted successfully" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } } }, "/repos/{owner}/{repo}/issues/{issue_number}/labels": { @@ -74342,6 +74746,94 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -80888,339 +81380,6 @@ } } }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { - "post": { - "summary": "Add issue field values to an issue", - "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/add-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Add multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Add a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after adding the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - }, - "put": { - "summary": "Set issue field values for an issue", - "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/set-issue-field-values", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "issue_field_values": { - "type": "array", - "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", - "items": { - "type": "object", - "properties": { - "field_id": { - "type": "integer", - "description": "The ID of the issue field to set", - "example": 123 - }, - "value": { - "oneOf": [ - { - "type": "string", - "description": "The value to set for text, single_select, or date fields" - }, - { - "type": "number", - "description": "The value to set for number fields" - } - ], - "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", - "example": "Critical" - } - }, - "required": [ - "field_id", - "value" - ], - "additionalProperties": false - }, - "maxItems": 25 - } - } - }, - "examples": { - "default": { - "summary": "Set multiple field values", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "Critical" - }, - { - "field_id": 456, - "value": 5 - }, - { - "field_id": 789, - "value": "2024-12-31" - } - ] - } - }, - "single-field": { - "summary": "Set a single field value", - "value": { - "issue_field_values": [ - { - "field_id": 123, - "value": "High Priority" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "The current issue field values for this issue after setting the new values", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/issue-field-value-items" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/bad_request" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { - "delete": { - "summary": "Delete an issue field value from an issue", - "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", - "tags": [ - "issues" - ], - "operationId": "issues/delete-issue-field-value", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" - }, - "parameters": [ - { - "$ref": "#/components/parameters/repository-id" - }, - { - "$ref": "#/components/parameters/issue-number" - }, - { - "$ref": "#/components/parameters/issue-field-id" - } - ], - "responses": { - "204": { - "description": "Issue field value deleted successfully" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issue-field-values" - } - } - }, "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", @@ -143016,7 +143175,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -143085,6 +143245,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -143140,7 +143312,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -143215,6 +143388,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 3672c0926b..9cd19e44b6 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -2424,6 +2424,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -2434,6 +2443,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -14941,6 +14955,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -14951,6 +14974,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -27896,7 +27924,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -27988,8 +28016,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -27997,6 +28025,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -28028,13 +28057,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -28073,6 +28114,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -28181,7 +28232,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. 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)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -28278,6 +28329,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -28309,13 +28361,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -50638,6 +50702,268 @@ paths: enabledForGitHubApps: true category: issues subcategory: issue-field-values + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. + Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. + Each field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or + date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting + the new values + items: + "$ref": "#/components/schemas/issue-field-value" + examples: + default: + "$ref": "#/components/examples/issue-field-value-items" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}": + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/issue-field-id" + responses: + '204': + description: Issue field value deleted successfully + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue @@ -53912,6 +54238,67 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -58533,266 +58920,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: - "$ref": "#/components/schemas/issue-field-value" - examples: - default: - "$ref": "#/components/examples/issue-field-value-items" - '400': - "$ref": "#/components/responses/bad_request" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '503': - "$ref": "#/components/responses/service_unavailable" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/issue-number" - - "$ref": "#/components/parameters/issue-field-id" - responses: - '204': - description: Issue field value deleted successfully - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/v{"code":"deadline_exceeded","msg":"operation timed out"}