diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 62de96b2ca..e1221499d3 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -10272,6 +10272,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" @@ -10282,6 +10291,10 @@ "string", "null" ] + }, + "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" } } }, @@ -26299,7 +26312,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" ], @@ -26384,14 +26397,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": { @@ -26427,12 +26441,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": [ @@ -26479,6 +26505,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" + } } } } @@ -26637,7 +26675,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" ], @@ -26732,7 +26770,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26768,12 +26807,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" } } }, @@ -55614,6 +55665,354 @@ "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 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", + "examples": [ + "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": { @@ -60254,6 +60653,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", @@ -66824,347 +67311,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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 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", - "examples": [ - "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", @@ -119431,7 +119577,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -119504,6 +119651,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" @@ -119561,7 +119720,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -119638,6 +119798,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-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index c7900c0cd0..b8dd5aafbf 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.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`, @@ -7368,6 +7377,11 @@ paths: type: - string - 'null' + 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: @@ -19110,7 +19124,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: @@ -19203,8 +19217,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 @@ -19212,6 +19226,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`. @@ -19243,13 +19258,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 @@ -19288,6 +19315,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 @@ -19398,7 +19435,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: @@ -19496,6 +19533,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`. @@ -19527,13 +19565,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 @@ -40580,6 +40630,272 @@ 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 @@ -43797,6 +44113,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 @@ -48429,270 +48806,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 - examples: - - 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 - examples: - - 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 - examples: - - 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 - examples: - - 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 @@ -86664,6 +86777,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86722,6 +86836,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 @@ -86771,6 +86894,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86834,6 +86958,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-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index c0e3412860..d12b4dabe4 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -10271,6 +10271,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" @@ -10281,6 +10290,10 @@ "string", "null" ] + }, + "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" } } }, @@ -26256,7 +26269,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" ], @@ -26341,14 +26354,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": { @@ -26384,12 +26398,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": [ @@ -26436,6 +26462,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" + } } } } @@ -26594,7 +26632,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" ], @@ -26689,7 +26727,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26725,12 +26764,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" } } }, @@ -55525,6 +55576,354 @@ "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 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", + "examples": [ + "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": { @@ -60165,6 +60564,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", @@ -66735,347 +67222,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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 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", - "examples": [ - "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", @@ -118867,7 +119013,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -118940,6 +119087,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" @@ -118997,7 +119156,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -119074,6 +119234,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-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index d9b4b39691..01fbc278df 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -7355,6 +7355,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`, @@ -7366,6 +7375,11 @@ paths: type: - string - 'null' + 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: @@ -19078,7 +19092,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: @@ -19171,8 +19185,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 @@ -19180,6 +19194,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`. @@ -19211,13 +19226,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 @@ -19256,6 +19283,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 @@ -19366,7 +19403,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: @@ -19464,6 +19501,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`. @@ -19495,13 +19533,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 @@ -40506,6 +40556,272 @@ 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 @@ -43723,6 +44039,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 @@ -48355,270 +48732,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 - examples: - - 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 - examples: - - 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 - examples: - - 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 - examples: - - 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 @@ -86246,6 +86359,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86304,6 +86418,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 @@ -86353,6 +86476,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86416,6 +86540,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-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 386019d0f2..68a2e18bf8 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -10318,6 +10318,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" @@ -10328,6 +10337,10 @@ "string", "null" ] + }, + "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" } } }, @@ -26478,7 +26491,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" ], @@ -26563,14 +26576,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": { @@ -26606,12 +26620,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": [ @@ -26658,6 +26684,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" + } } } } @@ -26816,7 +26854,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" ], @@ -26911,7 +26949,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26947,12 +26986,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" } } }, @@ -55916,6 +55967,354 @@ "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 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", + "examples": [ + "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": { @@ -60556,6 +60955,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", @@ -67126,347 +67613,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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 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", - "examples": [ - "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", @@ -120197,7 +120343,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -120270,6 +120417,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" @@ -120327,7 +120486,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -120404,6 +120564,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-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 121dbdf0ab..83012c4d63 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -7382,6 +7382,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`, @@ -7393,6 +7402,11 @@ paths: type: - string - 'null' + 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: @@ -19205,7 +19219,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: @@ -19298,8 +19312,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 @@ -19307,6 +19321,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`. @@ -19338,13 +19353,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 @@ -19383,6 +19410,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 @@ -19493,7 +19530,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: @@ -19591,6 +19628,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`. @@ -19622,13 +19660,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 @@ -40765,6 +40815,272 @@ 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 @@ -43982,6 +44298,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 @@ -48614,270 +48991,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 - examples: - - 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 - examples: - - 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 - examples: - - 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 - examples: - - 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 @@ -87163,6 +87276,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -87221,6 +87335,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 @@ -87270,6 +87393,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -87333,6 +87457,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index c76df20b15..dca9d8bce0 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -89495,6 +89495,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" @@ -89505,6 +89514,10 @@ "string", "null" ] + }, + "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" } } }, @@ -187899,7 +187912,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -187972,6 +187986,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" @@ -188124,7 +188150,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" ], @@ -188215,14 +188241,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": { @@ -188258,12 +188285,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": [ @@ -188310,6 +188349,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" + } } } } @@ -188360,7 +188411,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -188437,6 +188489,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" @@ -188775,7 +188839,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -188848,6 +188913,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" @@ -188916,7 +188993,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" ], @@ -189023,7 +189100,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -189059,12 +189137,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" } } }, @@ -504302,275 +504392,1485 @@ "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", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - 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": [ + { + "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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": "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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/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": "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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/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", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + 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/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -580467,6 +581767,366 @@ } } }, + "/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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", @@ -658187,1191 +659847,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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 777ca02896..ba324f834b 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1073,7 +1073,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &637 + - &638 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -12514,7 +12514,7 @@ paths: pin: anyOf: - type: 'null' - - &547 + - &548 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -13341,7 +13341,7 @@ paths: type: string release: allOf: - - &579 + - &580 title: Release description: A release. type: object @@ -13423,7 +13423,7 @@ paths: author: *4 assets: type: array - items: &580 + items: &581 title: Release Asset description: Data related to a release. type: object @@ -17470,7 +17470,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &555 + - &556 name: all description: If `true`, show notifications marked as read. in: query @@ -17478,7 +17478,7 @@ paths: schema: type: boolean default: false - - &556 + - &557 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -17488,7 +17488,7 @@ paths: type: boolean default: false - *87 - - &557 + - &558 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: @@ -18081,7 +18081,7 @@ paths: - url - subscription_url examples: - default: &558 + default: &559 value: - id: '1' repository: @@ -21692,6 +21692,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`, @@ -21703,6 +21712,11 @@ paths: type: - string - 'null' + 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: @@ -40006,6 +40020,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -40067,6 +40082,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 @@ -40104,7 +40128,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: @@ -40197,8 +40221,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 @@ -40206,6 +40230,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`. @@ -40237,13 +40262,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 @@ -40282,6 +40319,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 @@ -40324,6 +40371,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -40390,6 +40438,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 @@ -40515,7 +40572,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: @@ -40613,6 +40670,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`. @@ -40644,13 +40702,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 @@ -41318,7 +41388,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: &565 + auto_merge: &566 title: Auto merge description: The status of auto merging a pull request. type: @@ -45612,7 +45682,7 @@ paths: - *74 - *17 - *19 - - &587 + - &588 name: targets description: | A comma-separated list of rule targets to filter by. @@ -45898,7 +45968,7 @@ paths: - object rules: type: array - items: &588 + items: &589 title: Repository Rule type: object description: A repository rule. @@ -45960,7 +46030,7 @@ paths: type: string enum: - required_linear_history - - &586 + - &587 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -46862,7 +46932,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *74 - - &589 + - &590 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 @@ -46877,7 +46947,7 @@ paths: in: query schema: type: string - - &590 + - &591 name: time_period description: |- The time period to filter by. @@ -46893,14 +46963,14 @@ paths: - week - month default: day - - &591 + - &592 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 - - &592 + - &593 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -46920,7 +46990,7 @@ paths: description: Response content: application/json: - schema: &593 + schema: &594 title: Rule Suites description: Response type: array @@ -46976,7 +47046,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &594 + default: &595 value: - id: 21 actor_id: 12 @@ -47020,7 +47090,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *74 - - &595 + - &596 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -47036,7 +47106,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &597 title: Rule Suite description: Response type: object @@ -47143,7 +47213,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &597 + default: &598 value: id: 21 actor_id: 12 @@ -47390,7 +47460,7 @@ paths: type: string format: date-time examples: - default: &599 + default: &600 value: - version_id: 3 actor: @@ -47443,7 +47513,7 @@ paths: description: Response content: application/json: - schema: &600 + schema: &601 allOf: - *311 - type: object @@ -47515,7 +47585,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *74 - - &601 + - &602 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -47526,7 +47596,7 @@ paths: enum: - open - resolved - - &602 + - &603 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -47536,7 +47606,7 @@ paths: required: false schema: type: string - - &603 + - &604 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -47547,7 +47617,7 @@ paths: required: false schema: type: string - - &604 + - &605 name: exclude_providers in: query description: |- @@ -47558,7 +47628,7 @@ paths: required: false schema: type: string - - &605 + - &606 name: providers in: query description: |- @@ -47569,7 +47639,7 @@ paths: required: false schema: type: string - - &606 + - &607 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -47578,7 +47648,7 @@ paths: required: false schema: type: string - - &607 + - &608 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -47597,7 +47667,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &608 + - &609 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. @@ -47612,7 +47682,7 @@ paths: - *60 - *19 - *17 - - &609 + - &610 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 @@ -47622,7 +47692,7 @@ paths: required: false schema: type: string - - &610 + - &611 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 @@ -47632,7 +47702,7 @@ paths: required: false schema: type: string - - &611 + - &612 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -47641,7 +47711,7 @@ paths: required: false schema: type: string - - &612 + - &613 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -47650,7 +47720,7 @@ paths: schema: type: boolean default: false - - &613 + - &614 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -47659,7 +47729,7 @@ paths: schema: type: boolean default: false - - &614 + - &615 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -47691,14 +47761,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &615 + state: &616 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: &616 + resolution: &617 type: - string - 'null' @@ -47817,14 +47887,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &617 + - &618 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &619 + - &620 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -47888,7 +47958,7 @@ paths: - blob_url - commit_sha - commit_url - - &620 + - &621 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. @@ -47949,7 +48019,7 @@ paths: - page_url - commit_sha - commit_url - - &621 + - &622 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -47971,7 +48041,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &622 + - &623 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -47993,7 +48063,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &623 + - &624 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -48015,7 +48085,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &624 + - &625 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -48030,7 +48100,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &625 + - &626 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -48045,7 +48115,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &626 + - &627 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -48060,7 +48130,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &627 + - &628 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. @@ -48082,7 +48152,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &628 + - &629 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. @@ -48104,7 +48174,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &629 + - &630 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. @@ -48126,7 +48196,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &630 + - &631 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. @@ -48148,7 +48218,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &631 + - &632 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 @@ -48669,7 +48739,7 @@ paths: application/json: schema: type: array - items: &635 + items: &636 description: A repository security advisory. type: object properties: @@ -48988,7 +49058,7 @@ paths: - private_fork additionalProperties: false examples: - default: &636 + default: &637 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -70059,7 +70129,7 @@ paths: type: array items: *456 examples: - default: &572 + default: &573 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -70350,7 +70420,7 @@ paths: type: array items: *460 examples: - default: &564 + default: &565 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -70908,7 +70978,7 @@ paths: application/json: schema: *456 examples: - default: &552 + default: &553 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -71571,7 +71641,7 @@ paths: application/json: schema: type: array - items: &640 + items: &641 title: Status description: The status of a commit. type: object @@ -72560,7 +72630,7 @@ paths: - size - type - url - - &577 + - &578 title: Content File description: Content File type: object @@ -73197,7 +73267,7 @@ paths: items: type: object properties: - placeholder_id: &632 + placeholder_id: &633 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -83486,7 +83556,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &534 + - &535 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -83535,7 +83605,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &535 + - &536 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -83663,7 +83733,7 @@ paths: - performed_via_github_app - assignee - assigner - - &536 + - &537 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -83709,7 +83779,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &537 + - &538 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -83755,7 +83825,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &539 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -83804,7 +83874,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &540 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -83846,7 +83916,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &541 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -83888,7 +83958,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &542 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -83944,7 +84014,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &543 title: Locked Issue Event description: Locked Issue Event type: object @@ -83989,7 +84059,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &544 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -84050,7 +84120,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &545 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -84111,7 +84181,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &546 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -84172,7 +84242,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &547 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -84296,7 +84366,7 @@ paths: type: array items: *532 examples: - default: &646 + default: &533 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -84328,6 +84398,254 @@ 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: + - *325 + - *326 + - *529 + 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 + examples: + - 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 + examples: + - 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: *532 + examples: + default: *533 + '400': *14 + '403': *27 + '404': *6 + '422': *15 + '503': *114 + 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: + - *325 + - *326 + - *529 + 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 + examples: + - 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 + examples: + - 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: *532 + examples: + default: *533 + '400': *14 + '403': *27 + '404': *6 + '422': *15 + '503': *114 + 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: + - *325 + - *326 + - *529 + - *229 + responses: + '204': + description: Issue field value deleted successfully + '403': *27 + '404': *6 + '422': *15 + '503': *114 + 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 @@ -84353,7 +84671,7 @@ paths: type: array items: *81 examples: - default: &533 + default: &534 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -84436,7 +84754,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 '301': *329 '404': *6 '410': *523 @@ -84520,7 +84838,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 '301': *329 '404': *6 '410': *523 @@ -85112,7 +85430,6 @@ paths: description: Timeline Event type: object anyOf: - - *534 - *535 - *536 - *537 @@ -85125,6 +85442,7 @@ paths: - *544 - *545 - *546 + - *547 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -85181,7 +85499,7 @@ paths: pin: anyOf: - type: 'null' - - *547 + - *548 required: - event - actor @@ -85457,7 +85775,7 @@ paths: type: string comments: type: array - items: &566 + items: &567 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -86001,7 +86319,7 @@ paths: application/json: schema: type: array - items: &548 + items: &549 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -86106,9 +86424,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: &549 + default: &550 value: id: 1 key: ssh-rsa AAA... @@ -86144,7 +86462,7 @@ paths: parameters: - *325 - *326 - - &550 + - &551 name: key_id description: The unique identifier of the key. in: path @@ -86156,9 +86474,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: *549 + default: *550 '404': *6 x-github: githubCloudOnly: false @@ -86178,7 +86496,7 @@ paths: parameters: - *325 - *326 - - *550 + - *551 responses: '204': description: Response @@ -86211,7 +86529,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 headers: Link: *66 '404': *6 @@ -86271,7 +86589,7 @@ paths: application/json: schema: *81 examples: - default: &551 + default: &552 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -86317,7 +86635,7 @@ paths: application/json: schema: *81 examples: - default: *551 + default: *552 '404': *6 x-github: githubCloudOnly: false @@ -86719,7 +87037,7 @@ paths: application/json: schema: *456 examples: - default: *552 + default: *553 '204': description: Response when already merged '404': @@ -86885,7 +87203,7 @@ paths: application/json: schema: *266 examples: - default: &553 + default: &554 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -86946,7 +87264,7 @@ paths: parameters: - *325 - *326 - - &554 + - &555 name: milestone_number description: The number that identifies the milestone. in: path @@ -86960,7 +87278,7 @@ paths: application/json: schema: *266 examples: - default: *553 + default: *554 '404': *6 x-github: githubCloudOnly: false @@ -86979,7 +87297,7 @@ paths: parameters: - *325 - *326 - - *554 + - *555 requestBody: required: false content: @@ -87019,7 +87337,7 @@ paths: application/json: schema: *266 examples: - default: *553 + default: *554 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87037,7 +87355,7 @@ paths: parameters: - *325 - *326 - - *554 + - *555 responses: '204': description: Response @@ -87060,7 +87378,7 @@ paths: parameters: - *325 - *326 - - *554 + - *555 - *17 - *19 responses: @@ -87072,7 +87390,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 headers: Link: *66 x-github: @@ -87093,10 +87411,10 @@ paths: parameters: - *325 - *326 - - *555 - *556 - - *87 - *557 + - *87 + - *558 - *17 - *19 responses: @@ -87108,7 +87426,7 @@ paths: type: array items: *107 examples: - default: *558 + default: *559 headers: Link: *66 x-github: @@ -87198,7 +87516,7 @@ paths: description: Response content: application/json: - schema: &559 + schema: &560 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -87342,7 +87660,7 @@ paths: - custom_404 - public examples: - default: &560 + default: &561 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -87439,9 +87757,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *560 examples: - default: *560 + default: *561 '422': *15 '409': *52 x-github: @@ -87603,7 +87921,7 @@ paths: application/json: schema: type: array - items: &561 + items: &562 title: Page Build description: Page Build type: object @@ -87750,9 +88068,9 @@ paths: description: Response content: application/json: - schema: *561 + schema: *562 examples: - default: &562 + default: &563 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -87812,9 +88130,9 @@ paths: description: Response content: application/json: - schema: *561 + schema: *562 examples: - default: *562 + default: *563 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87945,7 +88263,7 @@ paths: parameters: - *325 - *326 - - &563 + - &564 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -88005,7 +88323,7 @@ paths: parameters: - *325 - *326 - - *563 + - *564 responses: '204': *59 '404': *6 @@ -88577,7 +88895,7 @@ paths: type: array items: *460 examples: - default: *564 + default: *565 headers: Link: *66 '304': *35 @@ -88677,7 +88995,7 @@ paths: description: Response content: application/json: - schema: &568 + schema: &569 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -88911,7 +89229,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: *565 + auto_merge: *566 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -89013,7 +89331,7 @@ paths: - merged_by - review_comments examples: - default: &569 + default: &570 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -89570,9 +89888,9 @@ paths: application/json: schema: type: array - items: *566 + items: *567 examples: - default: &571 + default: &572 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89657,9 +89975,9 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: - default: &567 + default: &568 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89758,9 +90076,9 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: - default: *567 + default: *568 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89963,7 +90281,7 @@ paths: parameters: - *325 - *326 - - &570 + - &571 name: pull_number description: The number that identifies the pull request. in: path @@ -89976,9 +90294,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *568 + schema: *569 examples: - default: *569 + default: *570 '304': *35 '404': *6 '406': @@ -90015,7 +90333,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -90057,9 +90375,9 @@ paths: description: Response content: application/json: - schema: *568 + schema: *569 examples: - default: *569 + default: *570 '422': *15 '403': *27 x-github: @@ -90067,6 +90385,61 @@ 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: + - *325 + - *326 + - *571 + responses: + '204': + description: Response + '403': *27 + '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: + - *325 + - *326 + - *571 + responses: + '204': + description: Response + '403': *27 + '404': *6 + '422': *15 + 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 @@ -90083,7 +90456,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: true content: @@ -90186,7 +90559,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *104 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -90207,9 +90580,9 @@ paths: application/json: schema: type: array - items: *566 + items: *567 examples: - default: *571 + default: *572 headers: Link: *66 x-github: @@ -90244,7 +90617,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: true content: @@ -90350,7 +90723,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: example-for-a-multi-line-comment: value: @@ -90440,7 +90813,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *96 requestBody: required: true @@ -90463,7 +90836,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: default: value: @@ -90551,7 +90924,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *17 - *19 responses: @@ -90563,7 +90936,7 @@ paths: type: array items: *456 examples: - default: *572 + default: *573 headers: Link: *66 x-github: @@ -90595,7 +90968,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *17 - *19 responses: @@ -90645,7 +91018,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 responses: '204': description: Response if pull request has been merged @@ -90670,7 +91043,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -90784,7 +91157,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 responses: '200': description: Response @@ -90861,7 +91234,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -91436,7 +91809,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: true content: @@ -91977,7 +92350,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *17 - *19 responses: @@ -91987,7 +92360,7 @@ paths: application/json: schema: type: array - items: &573 + items: &574 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -92145,7 +92518,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -92235,9 +92608,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: &575 + default: &576 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -92302,8 +92675,8 @@ paths: parameters: - *325 - *326 - - *570 - - &574 + - *571 + - &575 name: review_id description: The unique identifier of the review. in: path @@ -92315,9 +92688,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: &576 + default: &577 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -92378,8 +92751,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 requestBody: required: true content: @@ -92402,7 +92775,7 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: default: value: @@ -92466,16 +92839,16 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 responses: '200': description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: *575 + default: *576 '422': *7 '404': *6 x-github: @@ -92504,8 +92877,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 - *17 - *19 responses: @@ -92765,8 +93138,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 requestBody: required: true content: @@ -92795,7 +93168,7 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: default: value: @@ -92860,8 +93233,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 requestBody: required: true content: @@ -92896,9 +93269,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: *576 + default: *577 '404': *6 '422': *7 '403': *27 @@ -92922,7 +93295,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -93000,9 +93373,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: &578 + default: &579 value: type: file encoding: base64 @@ -93065,9 +93438,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '404': *6 '422': *15 x-github: @@ -93100,7 +93473,7 @@ paths: application/json: schema: type: array - items: *579 + items: *580 examples: default: value: @@ -93271,9 +93644,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: &583 + default: &584 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -93380,7 +93753,7 @@ paths: parameters: - *325 - *326 - - &581 + - &582 name: asset_id description: The unique identifier of the asset. in: path @@ -93392,9 +93765,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: - default: &582 + default: &583 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 @@ -93447,7 +93820,7 @@ paths: parameters: - *325 - *326 - - *581 + - *582 requestBody: required: false content: @@ -93476,9 +93849,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: - default: *582 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93496,7 +93869,7 @@ paths: parameters: - *325 - *326 - - *581 + - *582 responses: '204': description: Response @@ -93615,9 +93988,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *583 + default: *584 '404': *6 x-github: githubCloudOnly: false @@ -93649,9 +94022,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *583 + default: *584 '404': *6 x-github: githubCloudOnly: false @@ -93675,7 +94048,7 @@ paths: parameters: - *325 - *326 - - &584 + - &585 name: release_id description: The unique identifier of the release. in: path @@ -93689,9 +94062,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: *579 + schema: *580 examples: - default: *583 + default: *584 '401': description: Unauthorized x-github: @@ -93711,7 +94084,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 requestBody: required: false content: @@ -93775,9 +94148,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *583 + default: *584 '404': description: Not Found if the discussion category name is invalid content: @@ -93800,7 +94173,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 responses: '204': description: Response @@ -93823,7 +94196,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - *17 - *19 responses: @@ -93833,7 +94206,7 @@ paths: application/json: schema: type: array - items: *580 + items: *581 examples: default: value: @@ -93916,7 +94289,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - name: name in: query required: true @@ -93942,7 +94315,7 @@ paths: description: Response for successful upload content: application/json: - schema: *580 + schema: *581 examples: response-for-successful-upload: value: @@ -93999,7 +94372,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - 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. @@ -94048,7 +94421,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 requestBody: required: true content: @@ -94111,7 +94484,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - *526 responses: '204': @@ -94155,7 +94528,7 @@ paths: oneOf: - allOf: - *287 - - &585 + - &586 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -94176,67 +94549,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *288 - - *585 + - *586 - allOf: - *289 - - *585 + - *586 - allOf: - *290 - - *585 + - *586 - allOf: + - *587 - *586 - - *585 - allOf: - *291 - - *585 + - *586 - allOf: - *292 - - *585 + - *586 - allOf: - *293 - - *585 + - *586 - allOf: - *294 - - *585 + - *586 - allOf: - *295 - - *585 + - *586 - allOf: - *296 - - *585 + - *586 - allOf: - *297 - - *585 + - *586 - allOf: - *298 - - *585 + - *586 - allOf: - *299 - - *585 + - *586 - allOf: - *300 - - *585 + - *586 - allOf: - *301 - - *585 + - *586 - allOf: - *302 - - *585 + - *586 - allOf: - *303 - - *585 + - *586 - allOf: - *304 - - *585 + - *586 - allOf: - *305 - - *585 + - *586 - allOf: - *306 - - *585 + - *586 - allOf: - *307 - - *585 + - *586 examples: default: value: @@ -94287,7 +94660,7 @@ paths: schema: type: boolean default: true - - *587 + - *588 responses: '200': description: Response @@ -94372,7 +94745,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *588 + items: *589 required: - name - enforcement @@ -94405,7 +94778,7 @@ paths: application/json: schema: *308 examples: - default: &598 + default: &599 value: id: 42 name: super cool ruleset @@ -94455,10 +94828,10 @@ paths: parameters: - *325 - *326 - - *589 - *590 - *591 - *592 + - *593 - *17 - *19 responses: @@ -94466,9 +94839,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: - default: *594 + default: *595 '404': *6 '500': *53 x-github: @@ -94491,15 +94864,15 @@ paths: parameters: - *325 - *326 - - *595 + - *596 responses: '200': description: Response content: application/json: - schema: *596 + schema: *597 examples: - default: *597 + default: *598 '404': *6 '500': *53 x-github: @@ -94550,7 +94923,7 @@ paths: application/json: schema: *308 examples: - default: *598 + default: *599 '404': *6 '500': *53 put: @@ -94603,7 +94976,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *588 + items: *589 examples: default: value: @@ -94633,7 +95006,7 @@ paths: application/json: schema: *308 examples: - default: *598 + default: *599 '404': *6 '422': *15 '500': *53 @@ -94695,7 +95068,7 @@ paths: type: array items: *311 examples: - default: *599 + default: *600 '404': *6 '500': *53 x-github: @@ -94733,7 +95106,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -94790,7 +95163,6 @@ paths: parameters: - *325 - *326 - - *601 - *602 - *603 - *604 @@ -94798,15 +95170,16 @@ paths: - *606 - *607 - *608 + - *609 - *60 - *19 - *17 - - *609 - *610 - *611 - *612 - *613 - *614 + - *615 responses: '200': description: Response @@ -94814,7 +95187,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 type: object properties: number: *171 @@ -94830,8 +95203,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *615 - resolution: *616 + state: *616 + resolution: *617 resolved_at: type: - string @@ -94937,7 +95310,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *617 + - *618 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -95099,13 +95472,13 @@ paths: - *325 - *326 - *422 - - *614 + - *615 responses: '200': description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -95169,8 +95542,8 @@ paths: schema: type: object properties: - state: *615 - resolution: *616 + state: *616 + resolution: *617 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -95208,7 +95581,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -95343,7 +95716,6 @@ paths: - commit details: oneOf: - - *619 - *620 - *621 - *622 @@ -95356,6 +95728,7 @@ paths: - *629 - *630 - *631 + - *632 examples: default: value: @@ -95450,14 +95823,14 @@ paths: schema: type: object properties: - reason: &633 + reason: &634 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *632 + placeholder_id: *633 required: - reason - placeholder_id @@ -95474,7 +95847,7 @@ paths: schema: type: object properties: - reason: *633 + reason: *634 expire_at: type: - string @@ -95537,7 +95910,7 @@ paths: properties: incremental_scans: type: array - items: &634 + items: &635 description: Information on a single scan performed by secret scanning on the repository type: object @@ -95565,15 +95938,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *634 + items: *635 backfill_scans: type: array - items: *634 + items: *635 custom_pattern_backfill_scans: type: array items: allOf: - - *634 + - *635 - type: object properties: pattern_name: @@ -95586,7 +95959,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *634 + items: *635 examples: default: value: @@ -95696,9 +96069,9 @@ paths: application/json: schema: type: array - items: *635 + items: *636 examples: - default: *636 + default: *637 '400': *14 '404': *6 x-github: @@ -95892,9 +96265,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: &638 + default: &639 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -96241,7 +96614,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: default: value: @@ -96390,15 +96763,15 @@ paths: parameters: - *325 - *326 - - *637 + - *638 responses: '200': description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: *638 + default: *639 '403': *27 '404': *6 x-github: @@ -96424,7 +96797,7 @@ paths: parameters: - *325 - *326 - - *637 + - *638 requestBody: required: true content: @@ -96595,10 +96968,10 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: *638 - add_credit: *638 + default: *639 + add_credit: *639 '403': *27 '404': *6 '422': @@ -96638,7 +97011,7 @@ paths: parameters: - *325 - *326 - - *637 + - *638 responses: '202': *37 '400': *14 @@ -96667,7 +97040,7 @@ paths: parameters: - *325 - *326 - - *637 + - *638 responses: '202': description: Response @@ -96808,7 +97181,7 @@ paths: application/json: schema: type: array - items: &639 + items: &640 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -97181,7 +97554,7 @@ paths: application/json: schema: type: array - items: *639 + items: *640 examples: default: value: @@ -97271,7 +97644,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: default: value: @@ -97365,7 +97738,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &641 + schema: &642 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -97465,7 +97838,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -97675,7 +98048,7 @@ paths: description: Response content: application/json: - schema: &642 + schema: &643 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -97687,7 +98060,7 @@ paths: required: - names examples: - default: &643 + default: &644 value: names: - octocat @@ -97742,9 +98115,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *643 + default: *644 '404': *6 '422': *7 x-github: @@ -97767,7 +98140,7 @@ paths: parameters: - *325 - *326 - - &644 + - &645 name: per description: The time frame to display results for. in: query @@ -97798,7 +98171,7 @@ paths: - 128 clones: type: array - items: &645 + items: &646 title: Traffic type: object properties: @@ -98046,7 +98419,7 @@ paths: parameters: - *325 - *326 - - *644 + - *645 responses: '200': description: Response @@ -98067,7 +98440,7 @@ paths: - 3782 views: type: array - items: *645 + items: *646 required: - uniques - count @@ -98711,252 +99084,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: - - *142 - - *529 - 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 - examples: - - 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 - examples: - - 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: *532 - examples: - default: *646 - '400': *14 - '403': *27 - '404': *6 - '422': *15 - '503': *114 - 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: - - *142 - - *529 - 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 - examples: - - 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 - examples: - - 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: *532 - examples: - default: *646 - '400': *14 - '403': *27 - '404': *6 - '422': *15 - '503': *114 - 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: - - *142 - - *529 - - *229 - responses: - '204': - description: Issue field value deleted successfully - '403': *27 - '404': *6 - '422': *15 - '503': *114 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/search/code": get: summary: Search code @@ -105749,7 +105876,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *551 responses: '200': description: Response @@ -105780,7 +105907,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *551 responses: '204': description: Response @@ -122673,7 +122800,7 @@ webhooks: - *484 pull_requests: type: array - items: *568 + items: *569 repository: *715 organization: *714 installation: *713 @@ -130863,7 +130990,7 @@ webhooks: pin: anyOf: - type: 'null' - - *547 + - *548 user: title: User type: @@ -132362,7 +132489,7 @@ webhooks: pin: anyOf: - type: 'null' - - *547 + - *548 required: - url - html_url @@ -170387,7 +170514,7 @@ webhooks: organization: *714 pull_request: &758 allOf: - - *568 + - *569 - type: object properties: allow_auto_merge: @@ -226479,7 +226606,7 @@ webhooks: installation: *713 organization: *714 repository: *715 - repository_advisory: *635 + repository_advisory: *636 sender: *4 required: - action @@ -226559,7 +226686,7 @@ webhooks: installation: *713 organization: *714 repository: *715 - repository_advisory: *635 + repository_advisory: *636 sender: *4 required: - action @@ -227650,16 +227777,16 @@ webhooks: properties: added: type: array - items: *588 + items: *589 deleted: type: array - items: *588 + items: *589 updated: type: array items: type: object properties: - rule: *588 + rule: *589 changes: type: object properties: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 01affc89b4..9c274969c9 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -85315,6 +85315,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" @@ -85325,6 +85334,10 @@ "string", "null" ] + }, + "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" } } }, @@ -181347,7 +181360,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -181420,6 +181434,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" @@ -181572,7 +181598,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" ], @@ -181663,14 +181689,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": { @@ -181706,12 +181733,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": [ @@ -181758,6 +181797,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" + } } } } @@ -181808,7 +181859,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -181885,6 +181937,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" @@ -182223,7 +182287,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -182296,6 +182361,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" @@ -182364,7 +182441,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" ], @@ -182471,7 +182548,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -182507,12 +182585,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" } } }, @@ -493357,275 +493447,1485 @@ "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", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - 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": [ + { + "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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": "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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/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": "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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/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", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + 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/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -567340,6 +568640,366 @@ } } }, + "/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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", @@ -644271,1191 +645931,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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index e0e050c934..b0c526dbdf 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -1041,7 +1041,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &637 + - &638 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -12440,7 +12440,7 @@ paths: pin: anyOf: - type: 'null' - - &547 + - &548 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -13266,7 +13266,7 @@ paths: type: string release: allOf: - - &579 + - &580 title: Release description: A release. type: object @@ -13348,7 +13348,7 @@ paths: author: *4 assets: type: array - items: &580 + items: &581 title: Release Asset description: Data related to a release. type: object @@ -17158,7 +17158,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &555 + - &556 name: all description: If `true`, show notifications marked as read. in: query @@ -17166,7 +17166,7 @@ paths: schema: type: boolean default: false - - &556 + - &557 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -17176,7 +17176,7 @@ paths: type: boolean default: false - *87 - - &557 + - &558 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: @@ -17767,7 +17767,7 @@ paths: - url - subscription_url examples: - default: &558 + default: &559 value: - id: '1' repository: @@ -21368,6 +21368,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`, @@ -21379,6 +21388,11 @@ paths: type: - string - 'null' + 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: @@ -39648,6 +39662,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39709,6 +39724,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 @@ -39746,7 +39770,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: @@ -39839,8 +39863,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 @@ -39848,6 +39872,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`. @@ -39879,13 +39904,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 @@ -39924,6 +39961,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 @@ -39966,6 +40013,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -40032,6 +40080,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 @@ -40157,7 +40214,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: @@ -40255,6 +40312,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`. @@ -40286,13 +40344,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 @@ -40950,7 +41020,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: &565 + auto_merge: &566 title: Auto merge description: The status of auto merging a pull request. type: @@ -45234,7 +45304,7 @@ paths: - *74 - *17 - *19 - - &587 + - &588 name: targets description: | A comma-separated list of rule targets to filter by. @@ -45520,7 +45590,7 @@ paths: - object rules: type: array - items: &588 + items: &589 title: Repository Rule type: object description: A repository rule. @@ -45582,7 +45652,7 @@ paths: type: string enum: - required_linear_history - - &586 + - &587 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -46484,7 +46554,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *74 - - &589 + - &590 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 @@ -46499,7 +46569,7 @@ paths: in: query schema: type: string - - &590 + - &591 name: time_period description: |- The time period to filter by. @@ -46515,14 +46585,14 @@ paths: - week - month default: day - - &591 + - &592 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 - - &592 + - &593 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -46542,7 +46612,7 @@ paths: description: Response content: application/json: - schema: &593 + schema: &594 title: Rule Suites description: Response type: array @@ -46598,7 +46668,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &594 + default: &595 value: - id: 21 actor_id: 12 @@ -46642,7 +46712,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *74 - - &595 + - &596 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -46658,7 +46728,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &597 title: Rule Suite description: Response type: object @@ -46765,7 +46835,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &597 + default: &598 value: id: 21 actor_id: 12 @@ -47012,7 +47082,7 @@ paths: type: string format: date-time examples: - default: &599 + default: &600 value: - version_id: 3 actor: @@ -47065,7 +47135,7 @@ paths: description: Response content: application/json: - schema: &600 + schema: &601 allOf: - *311 - type: object @@ -47137,7 +47207,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *74 - - &601 + - &602 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -47148,7 +47218,7 @@ paths: enum: - open - resolved - - &602 + - &603 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -47158,7 +47228,7 @@ paths: required: false schema: type: string - - &603 + - &604 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -47169,7 +47239,7 @@ paths: required: false schema: type: string - - &604 + - &605 name: exclude_providers in: query description: |- @@ -47180,7 +47250,7 @@ paths: required: false schema: type: string - - &605 + - &606 name: providers in: query description: |- @@ -47191,7 +47261,7 @@ paths: required: false schema: type: string - - &606 + - &607 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -47200,7 +47270,7 @@ paths: required: false schema: type: string - - &607 + - &608 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -47219,7 +47289,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &608 + - &609 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. @@ -47234,7 +47304,7 @@ paths: - *60 - *19 - *17 - - &609 + - &610 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 @@ -47244,7 +47314,7 @@ paths: required: false schema: type: string - - &610 + - &611 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 @@ -47254,7 +47324,7 @@ paths: required: false schema: type: string - - &611 + - &612 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -47263,7 +47333,7 @@ paths: required: false schema: type: string - - &612 + - &613 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -47272,7 +47342,7 @@ paths: schema: type: boolean default: false - - &613 + - &614 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -47281,7 +47351,7 @@ paths: schema: type: boolean default: false - - &614 + - &615 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -47313,14 +47383,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &615 + state: &616 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: &616 + resolution: &617 type: - string - 'null' @@ -47439,14 +47509,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &617 + - &618 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &619 + - &620 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -47510,7 +47580,7 @@ paths: - blob_url - commit_sha - commit_url - - &620 + - &621 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. @@ -47571,7 +47641,7 @@ paths: - page_url - commit_sha - commit_url - - &621 + - &622 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -47593,7 +47663,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &622 + - &623 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -47615,7 +47685,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &623 + - &624 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -47637,7 +47707,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &624 + - &625 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -47652,7 +47722,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &625 + - &626 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -47667,7 +47737,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &626 + - &627 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -47682,7 +47752,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &627 + - &628 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. @@ -47704,7 +47774,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &628 + - &629 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. @@ -47726,7 +47796,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &629 + - &630 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. @@ -47748,7 +47818,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &630 + - &631 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. @@ -47770,7 +47840,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &631 + - &632 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 @@ -48291,7 +48361,7 @@ paths: application/json: schema: type: array - items: &635 + items: &636 description: A repository security advisory. type: object properties: @@ -48588,7 +48658,7 @@ paths: - private_fork additionalProperties: false examples: - default: &636 + default: &637 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -69611,7 +69681,7 @@ paths: type: array items: *456 examples: - default: &572 + default: &573 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69902,7 +69972,7 @@ paths: type: array items: *460 examples: - default: &564 + default: &565 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -70460,7 +70530,7 @@ paths: application/json: schema: *456 examples: - default: &552 + default: &553 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -71123,7 +71193,7 @@ paths: application/json: schema: type: array - items: &640 + items: &641 title: Status description: The status of a commit. type: object @@ -72112,7 +72182,7 @@ paths: - size - type - url - - &577 + - &578 title: Content File description: Content File type: object @@ -72749,7 +72819,7 @@ paths: items: type: object properties: - placeholder_id: &632 + placeholder_id: &633 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -82986,7 +83056,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &534 + - &535 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -83035,7 +83105,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &535 + - &536 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -83163,7 +83233,7 @@ paths: - performed_via_github_app - assignee - assigner - - &536 + - &537 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -83209,7 +83279,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &537 + - &538 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -83255,7 +83325,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &539 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -83304,7 +83374,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &540 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -83346,7 +83416,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &541 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -83388,7 +83458,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &542 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -83444,7 +83514,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &543 title: Locked Issue Event description: Locked Issue Event type: object @@ -83489,7 +83559,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &544 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -83550,7 +83620,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &545 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -83611,7 +83681,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &546 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -83672,7 +83742,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &547 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -83796,7 +83866,7 @@ paths: type: array items: *532 examples: - default: &646 + default: &533 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -83828,6 +83898,254 @@ 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: + - *325 + - *326 + - *529 + 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 + examples: + - 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 + examples: + - 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: *532 + examples: + default: *533 + '400': *14 + '403': *27 + '404': *6 + '422': *15 + '503': *114 + 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: + - *325 + - *326 + - *529 + 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 + examples: + - 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 + examples: + - 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: *532 + examples: + default: *533 + '400': *14 + '403': *27 + '404': *6 + '422': *15 + '503': *114 + 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: + - *325 + - *326 + - *529 + - *229 + responses: + '204': + description: Issue field value deleted successfully + '403': *27 + '404': *6 + '422': *15 + '503': *114 + 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 @@ -83853,7 +84171,7 @@ paths: type: array items: *81 examples: - default: &533 + default: &534 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -83936,7 +84254,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 '301': *329 '404': *6 '410': *523 @@ -84020,7 +84338,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 '301': *329 '404': *6 '410': *523 @@ -84612,7 +84930,6 @@ paths: description: Timeline Event type: object anyOf: - - *534 - *535 - *536 - *537 @@ -84625,6 +84942,7 @@ paths: - *544 - *545 - *546 + - *547 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -84681,7 +84999,7 @@ paths: pin: anyOf: - type: 'null' - - *547 + - *548 required: - event - actor @@ -84957,7 +85275,7 @@ paths: type: string comments: type: array - items: &566 + items: &567 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -85501,7 +85819,7 @@ paths: application/json: schema: type: array - items: &548 + items: &549 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -85606,9 +85924,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: &549 + default: &550 value: id: 1 key: ssh-rsa AAA... @@ -85644,7 +85962,7 @@ paths: parameters: - *325 - *326 - - &550 + - &551 name: key_id description: The unique identifier of the key. in: path @@ -85656,9 +85974,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: *549 + default: *550 '404': *6 x-github: githubCloudOnly: false @@ -85678,7 +85996,7 @@ paths: parameters: - *325 - *326 - - *550 + - *551 responses: '204': description: Response @@ -85711,7 +86029,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 headers: Link: *66 '404': *6 @@ -85771,7 +86089,7 @@ paths: application/json: schema: *81 examples: - default: &551 + default: &552 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -85817,7 +86135,7 @@ paths: application/json: schema: *81 examples: - default: *551 + default: *552 '404': *6 x-github: githubCloudOnly: false @@ -86219,7 +86537,7 @@ paths: application/json: schema: *456 examples: - default: *552 + default: *553 '204': description: Response when already merged '404': @@ -86385,7 +86703,7 @@ paths: application/json: schema: *266 examples: - default: &553 + default: &554 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -86446,7 +86764,7 @@ paths: parameters: - *325 - *326 - - &554 + - &555 name: milestone_number description: The number that identifies the milestone. in: path @@ -86460,7 +86778,7 @@ paths: application/json: schema: *266 examples: - default: *553 + default: *554 '404': *6 x-github: githubCloudOnly: false @@ -86479,7 +86797,7 @@ paths: parameters: - *325 - *326 - - *554 + - *555 requestBody: required: false content: @@ -86519,7 +86837,7 @@ paths: application/json: schema: *266 examples: - default: *553 + default: *554 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86537,7 +86855,7 @@ paths: parameters: - *325 - *326 - - *554 + - *555 responses: '204': description: Response @@ -86560,7 +86878,7 @@ paths: parameters: - *325 - *326 - - *554 + - *555 - *17 - *19 responses: @@ -86572,7 +86890,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 headers: Link: *66 x-github: @@ -86593,10 +86911,10 @@ paths: parameters: - *325 - *326 - - *555 - *556 - - *87 - *557 + - *87 + - *558 - *17 - *19 responses: @@ -86608,7 +86926,7 @@ paths: type: array items: *107 examples: - default: *558 + default: *559 headers: Link: *66 x-github: @@ -86698,7 +87016,7 @@ paths: description: Response content: application/json: - schema: &559 + schema: &560 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -86842,7 +87160,7 @@ paths: - custom_404 - public examples: - default: &560 + default: &561 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -86939,9 +87257,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *560 examples: - default: *560 + default: *561 '422': *15 '409': *52 x-github: @@ -87103,7 +87421,7 @@ paths: application/json: schema: type: array - items: &561 + items: &562 title: Page Build description: Page Build type: object @@ -87250,9 +87568,9 @@ paths: description: Response content: application/json: - schema: *561 + schema: *562 examples: - default: &562 + default: &563 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -87312,9 +87630,9 @@ paths: description: Response content: application/json: - schema: *561 + schema: *562 examples: - default: *562 + default: *563 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87445,7 +87763,7 @@ paths: parameters: - *325 - *326 - - &563 + - &564 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -87505,7 +87823,7 @@ paths: parameters: - *325 - *326 - - *563 + - *564 responses: '204': *59 '404': *6 @@ -88077,7 +88395,7 @@ paths: type: array items: *460 examples: - default: *564 + default: *565 headers: Link: *66 '304': *35 @@ -88177,7 +88495,7 @@ paths: description: Response content: application/json: - schema: &568 + schema: &569 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -88401,7 +88719,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: *565 + auto_merge: *566 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -88501,7 +88819,7 @@ paths: - merged_by - review_comments examples: - default: &569 + default: &570 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -89038,9 +89356,9 @@ paths: application/json: schema: type: array - items: *566 + items: *567 examples: - default: &571 + default: &572 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89125,9 +89443,9 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: - default: &567 + default: &568 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89226,9 +89544,9 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: - default: *567 + default: *568 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89431,7 +89749,7 @@ paths: parameters: - *325 - *326 - - &570 + - &571 name: pull_number description: The number that identifies the pull request. in: path @@ -89444,9 +89762,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *568 + schema: *569 examples: - default: *569 + default: *570 '304': *35 '404': *6 '406': @@ -89483,7 +89801,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -89525,9 +89843,9 @@ paths: description: Response content: application/json: - schema: *568 + schema: *569 examples: - default: *569 + default: *570 '422': *15 '403': *27 x-github: @@ -89535,6 +89853,61 @@ 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: + - *325 + - *326 + - *571 + responses: + '204': + description: Response + '403': *27 + '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: + - *325 + - *326 + - *571 + responses: + '204': + description: Response + '403': *27 + '404': *6 + '422': *15 + 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 @@ -89551,7 +89924,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: true content: @@ -89654,7 +90027,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *104 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -89675,9 +90048,9 @@ paths: application/json: schema: type: array - items: *566 + items: *567 examples: - default: *571 + default: *572 headers: Link: *66 x-github: @@ -89712,7 +90085,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: true content: @@ -89818,7 +90191,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: example-for-a-multi-line-comment: value: @@ -89908,7 +90281,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *96 requestBody: required: true @@ -89931,7 +90304,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: default: value: @@ -90019,7 +90392,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *17 - *19 responses: @@ -90031,7 +90404,7 @@ paths: type: array items: *456 examples: - default: *572 + default: *573 headers: Link: *66 x-github: @@ -90063,7 +90436,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *17 - *19 responses: @@ -90113,7 +90486,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 responses: '204': description: Response if pull request has been merged @@ -90138,7 +90511,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -90252,7 +90625,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 responses: '200': description: Response @@ -90329,7 +90702,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -90904,7 +91277,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: true content: @@ -91425,7 +91798,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *17 - *19 responses: @@ -91435,7 +91808,7 @@ paths: application/json: schema: type: array - items: &573 + items: &574 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -91593,7 +91966,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -91683,9 +92056,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: &575 + default: &576 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91750,8 +92123,8 @@ paths: parameters: - *325 - *326 - - *570 - - &574 + - *571 + - &575 name: review_id description: The unique identifier of the review. in: path @@ -91763,9 +92136,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: &576 + default: &577 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91826,8 +92199,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 requestBody: required: true content: @@ -91850,7 +92223,7 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: default: value: @@ -91914,16 +92287,16 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 responses: '200': description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: *575 + default: *576 '422': *7 '404': *6 x-github: @@ -91952,8 +92325,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 - *17 - *19 responses: @@ -92213,8 +92586,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 requestBody: required: true content: @@ -92243,7 +92616,7 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: default: value: @@ -92308,8 +92681,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 requestBody: required: true content: @@ -92344,9 +92717,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: *576 + default: *577 '404': *6 '422': *7 '403': *27 @@ -92370,7 +92743,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -92448,9 +92821,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: &578 + default: &579 value: type: file encoding: base64 @@ -92513,9 +92886,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '404': *6 '422': *15 x-github: @@ -92548,7 +92921,7 @@ paths: application/json: schema: type: array - items: *579 + items: *580 examples: default: value: @@ -92719,9 +93092,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: &583 + default: &584 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -92828,7 +93201,7 @@ paths: parameters: - *325 - *326 - - &581 + - &582 name: asset_id description: The unique identifier of the asset. in: path @@ -92840,9 +93213,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: - default: &582 + default: &583 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 @@ -92895,7 +93268,7 @@ paths: parameters: - *325 - *326 - - *581 + - *582 requestBody: required: false content: @@ -92924,9 +93297,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: - default: *582 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92944,7 +93317,7 @@ paths: parameters: - *325 - *326 - - *581 + - *582 responses: '204': description: Response @@ -93063,9 +93436,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *583 + default: *584 '404': *6 x-github: githubCloudOnly: false @@ -93097,9 +93470,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *583 + default: *584 '404': *6 x-github: githubCloudOnly: false @@ -93123,7 +93496,7 @@ paths: parameters: - *325 - *326 - - &584 + - &585 name: release_id description: The unique identifier of the release. in: path @@ -93137,9 +93510,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: *579 + schema: *580 examples: - default: *583 + default: *584 '401': description: Unauthorized x-github: @@ -93159,7 +93532,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 requestBody: required: false content: @@ -93223,9 +93596,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *583 + default: *584 '404': description: Not Found if the discussion category name is invalid content: @@ -93248,7 +93621,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 responses: '204': description: Response @@ -93271,7 +93644,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - *17 - *19 responses: @@ -93281,7 +93654,7 @@ paths: application/json: schema: type: array - items: *580 + items: *581 examples: default: value: @@ -93364,7 +93737,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - name: name in: query required: true @@ -93390,7 +93763,7 @@ paths: description: Response for successful upload content: application/json: - schema: *580 + schema: *581 examples: response-for-successful-upload: value: @@ -93447,7 +93820,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - 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. @@ -93496,7 +93869,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 requestBody: required: true content: @@ -93559,7 +93932,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - *526 responses: '204': @@ -93603,7 +93976,7 @@ paths: oneOf: - allOf: - *287 - - &585 + - &586 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -93624,67 +93997,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *288 - - *585 + - *586 - allOf: - *289 - - *585 + - *586 - allOf: - *290 - - *585 + - *586 - allOf: + - *587 - *586 - - *585 - allOf: - *291 - - *585 + - *586 - allOf: - *292 - - *585 + - *586 - allOf: - *293 - - *585 + - *586 - allOf: - *294 - - *585 + - *586 - allOf: - *295 - - *585 + - *586 - allOf: - *296 - - *585 + - *586 - allOf: - *297 - - *585 + - *586 - allOf: - *298 - - *585 + - *586 - allOf: - *299 - - *585 + - *586 - allOf: - *300 - - *585 + - *586 - allOf: - *301 - - *585 + - *586 - allOf: - *302 - - *585 + - *586 - allOf: - *303 - - *585 + - *586 - allOf: - *304 - - *585 + - *586 - allOf: - *305 - - *585 + - *586 - allOf: - *306 - - *585 + - *586 - allOf: - *307 - - *585 + - *586 examples: default: value: @@ -93735,7 +94108,7 @@ paths: schema: type: boolean default: true - - *587 + - *588 responses: '200': description: Response @@ -93820,7 +94193,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *588 + items: *589 required: - name - enforcement @@ -93853,7 +94226,7 @@ paths: application/json: schema: *308 examples: - default: &598 + default: &599 value: id: 42 name: super cool ruleset @@ -93903,10 +94276,10 @@ paths: parameters: - *325 - *326 - - *589 - *590 - *591 - *592 + - *593 - *17 - *19 responses: @@ -93914,9 +94287,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: - default: *594 + default: *595 '404': *6 '500': *53 x-github: @@ -93939,15 +94312,15 @@ paths: parameters: - *325 - *326 - - *595 + - *596 responses: '200': description: Response content: application/json: - schema: *596 + schema: *597 examples: - default: *597 + default: *598 '404': *6 '500': *53 x-github: @@ -93998,7 +94371,7 @@ paths: application/json: schema: *308 examples: - default: *598 + default: *599 '404': *6 '500': *53 put: @@ -94051,7 +94424,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *588 + items: *589 examples: default: value: @@ -94081,7 +94454,7 @@ paths: application/json: schema: *308 examples: - default: *598 + default: *599 '404': *6 '422': *15 '500': *53 @@ -94143,7 +94516,7 @@ paths: type: array items: *311 examples: - default: *599 + default: *600 '404': *6 '500': *53 x-github: @@ -94181,7 +94554,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -94238,7 +94611,6 @@ paths: parameters: - *325 - *326 - - *601 - *602 - *603 - *604 @@ -94246,15 +94618,16 @@ paths: - *606 - *607 - *608 + - *609 - *60 - *19 - *17 - - *609 - *610 - *611 - *612 - *613 - *614 + - *615 responses: '200': description: Response @@ -94262,7 +94635,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 type: object properties: number: *171 @@ -94278,8 +94651,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *615 - resolution: *616 + state: *616 + resolution: *617 resolved_at: type: - string @@ -94385,7 +94758,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *617 + - *618 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -94547,13 +94920,13 @@ paths: - *325 - *326 - *422 - - *614 + - *615 responses: '200': description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -94617,8 +94990,8 @@ paths: schema: type: object properties: - state: *615 - resolution: *616 + state: *616 + resolution: *617 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -94656,7 +95029,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -94791,7 +95164,6 @@ paths: - commit details: oneOf: - - *619 - *620 - *621 - *622 @@ -94804,6 +95176,7 @@ paths: - *629 - *630 - *631 + - *632 examples: default: value: @@ -94898,14 +95271,14 @@ paths: schema: type: object properties: - reason: &633 + reason: &634 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *632 + placeholder_id: *633 required: - reason - placeholder_id @@ -94922,7 +95295,7 @@ paths: schema: type: object properties: - reason: *633 + reason: *634 expire_at: type: - string @@ -94985,7 +95358,7 @@ paths: properties: incremental_scans: type: array - items: &634 + items: &635 description: Information on a single scan performed by secret scanning on the repository type: object @@ -95013,15 +95386,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *634 + items: *635 backfill_scans: type: array - items: *634 + items: *635 custom_pattern_backfill_scans: type: array items: allOf: - - *634 + - *635 - type: object properties: pattern_name: @@ -95034,7 +95407,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *634 + items: *635 examples: default: value: @@ -95144,9 +95517,9 @@ paths: application/json: schema: type: array - items: *635 + items: *636 examples: - default: *636 + default: *637 '400': *14 '404': *6 x-github: @@ -95340,9 +95713,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: &638 + default: &639 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -95686,7 +96059,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: default: value: @@ -95834,15 +96207,15 @@ paths: parameters: - *325 - *326 - - *637 + - *638 responses: '200': description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: *638 + default: *639 '403': *27 '404': *6 x-github: @@ -95868,7 +96241,7 @@ paths: parameters: - *325 - *326 - - *637 + - *638 requestBody: required: true content: @@ -96039,10 +96412,10 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: *638 - add_credit: *638 + default: *639 + add_credit: *639 '403': *27 '404': *6 '422': @@ -96082,7 +96455,7 @@ paths: parameters: - *325 - *326 - - *637 + - *638 responses: '202': *37 '400': *14 @@ -96111,7 +96484,7 @@ paths: parameters: - *325 - *326 - - *637 + - *638 responses: '202': description: Response @@ -96252,7 +96625,7 @@ paths: application/json: schema: type: array - items: &639 + items: &640 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -96625,7 +96998,7 @@ paths: application/json: schema: type: array - items: *639 + items: *640 examples: default: value: @@ -96715,7 +97088,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: default: value: @@ -96809,7 +97182,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &641 + schema: &642 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -96909,7 +97282,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -97119,7 +97492,7 @@ paths: description: Response content: application/json: - schema: &642 + schema: &643 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -97131,7 +97504,7 @@ paths: required: - names examples: - default: &643 + default: &644 value: names: - octocat @@ -97186,9 +97559,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *643 + default: *644 '404': *6 '422': *7 x-github: @@ -97211,7 +97584,7 @@ paths: parameters: - *325 - *326 - - &644 + - &645 name: per description: The time frame to display results for. in: query @@ -97242,7 +97615,7 @@ paths: - 128 clones: type: array - items: &645 + items: &646 title: Traffic type: object properties: @@ -97490,7 +97863,7 @@ paths: parameters: - *325 - *326 - - *644 + - *645 responses: '200': description: Response @@ -97511,7 +97884,7 @@ paths: - 3782 views: type: array - items: *645 + items: *646 required: - uniques - count @@ -98154,252 +98527,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: - - *142 - - *529 - 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 - examples: - - 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 - examples: - - 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: *532 - examples: - default: *646 - '400': *14 - '403': *27 - '404': *6 - '422': *15 - '503': *114 - 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: - - *142 - - *529 - 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 - examples: - - 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 - examples: - - 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: *532 - examples: - default: *646 - '400': *14 - '403': *27 - '404': *6 - '422': *15 - '503': *114 - 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: - - *142 - - *529 - - *229 - responses: - '204': - description: Issue field value deleted successfully - '403': *27 - '404': *6 - '422': *15 - '503': *114 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/search/code": get: summary: Search code @@ -105359,7 +105486,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *551 responses: '200': description: Response @@ -105390,7 +105517,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *551 responses: '204': description: Response @@ -122242,7 +122369,7 @@ webhooks: - *484 pull_requests: type: array - items: *568 + items: *569 repository: *715 organization: *714 installation: *713 @@ -130432,7 +130559,7 @@ webhooks: pin: anyOf: - type: 'null' - - *547 + - *548 user: title: User type: @@ -131931,7 +132058,7 @@ webhooks: pin: anyOf: - type: 'null' - - *547 + - *548 required: - url - html_url @@ -169899,7 +170026,7 @@ webhooks: organization: *714 pull_request: &758 allOf: - - *568 + - *569 - type: object properties: allow_auto_merge: @@ -225676,7 +225803,7 @@ webhooks: installation: *713 organization: *714 repository: *715 - repository_advisory: *635 + repository_advisory: *636 sender: *4 required: - action @@ -225756,7 +225883,7 @@ webhooks: installation: *713 organization: *714 repository: *715 - repository_advisory: *635 + repository_advisory: *636 sender: *4 required: - action @@ -226847,16 +226974,16 @@ webhooks: properties: added: type: array - items: *588 + items: *589 deleted: type: array - items: *588 + items: *589 updated: type: array items: type: object properties: - rule: *588 + rule: *589 changes: type: object properties: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 31a44bda56..4f82a53bc5 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -91112,6 +91112,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" @@ -91122,6 +91131,10 @@ "string", "null" ] + }, + "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" } } }, @@ -193442,7 +193455,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -193515,6 +193529,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" @@ -193667,7 +193693,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" ], @@ -193758,14 +193784,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": { @@ -193801,12 +193828,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": [ @@ -193853,6 +193892,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" + } } } } @@ -193903,7 +193954,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -193980,6 +194032,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" @@ -194318,7 +194382,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -194391,6 +194456,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" @@ -194459,7 +194536,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" ], @@ -194566,7 +194643,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -194602,12 +194680,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" } } }, @@ -515706,275 +515796,1485 @@ "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", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - 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": [ + { + "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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": "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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/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": "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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/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", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + 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/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -594196,6 +595496,366 @@ } } }, + "/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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", @@ -673504,1191 +675164,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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 25099fc768..b60c938da2 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1124,7 +1124,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &637 + - &638 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -12687,7 +12687,7 @@ paths: pin: anyOf: - type: 'null' - - &547 + - &548 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -13557,7 +13557,7 @@ paths: type: string release: allOf: - - &579 + - &580 title: Release description: A release. type: object @@ -13639,7 +13639,7 @@ paths: author: *4 assets: type: array - items: &580 + items: &581 title: Release Asset description: Data related to a release. type: object @@ -17729,7 +17729,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &555 + - &556 name: all description: If `true`, show notifications marked as read. in: query @@ -17737,7 +17737,7 @@ paths: schema: type: boolean default: false - - &556 + - &557 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -17747,7 +17747,7 @@ paths: type: boolean default: false - *87 - - &557 + - &558 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: @@ -18346,7 +18346,7 @@ paths: - url - subscription_url examples: - default: &558 + default: &559 value: - id: '1' repository: @@ -21985,6 +21985,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`, @@ -21996,6 +22005,11 @@ paths: type: - string - 'null' + 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: @@ -40377,6 +40391,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -40438,6 +40453,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 @@ -40475,7 +40499,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: @@ -40568,8 +40592,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 @@ -40577,6 +40601,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`. @@ -40608,13 +40633,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 @@ -40653,6 +40690,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 @@ -40695,6 +40742,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -40761,6 +40809,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 @@ -40886,7 +40943,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: @@ -40984,6 +41041,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`. @@ -41015,13 +41073,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 @@ -41689,7 +41759,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: &565 + auto_merge: &566 title: Auto merge description: The status of auto merging a pull request. type: @@ -46078,7 +46148,7 @@ paths: - *74 - *17 - *19 - - &587 + - &588 name: targets description: | A comma-separated list of rule targets to filter by. @@ -46364,7 +46434,7 @@ paths: - object rules: type: array - items: &588 + items: &589 title: Repository Rule type: object description: A repository rule. @@ -46426,7 +46496,7 @@ paths: type: string enum: - required_linear_history - - &586 + - &587 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -47328,7 +47398,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *74 - - &589 + - &590 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 @@ -47343,7 +47413,7 @@ paths: in: query schema: type: string - - &590 + - &591 name: time_period description: |- The time period to filter by. @@ -47359,14 +47429,14 @@ paths: - week - month default: day - - &591 + - &592 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 - - &592 + - &593 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -47386,7 +47456,7 @@ paths: description: Response content: application/json: - schema: &593 + schema: &594 title: Rule Suites description: Response type: array @@ -47442,7 +47512,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &594 + default: &595 value: - id: 21 actor_id: 12 @@ -47486,7 +47556,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *74 - - &595 + - &596 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -47502,7 +47572,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &597 title: Rule Suite description: Response type: object @@ -47609,7 +47679,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &597 + default: &598 value: id: 21 actor_id: 12 @@ -47856,7 +47926,7 @@ paths: type: string format: date-time examples: - default: &599 + default: &600 value: - version_id: 3 actor: @@ -47909,7 +47979,7 @@ paths: description: Response content: application/json: - schema: &600 + schema: &601 allOf: - *311 - type: object @@ -47981,7 +48051,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *74 - - &601 + - &602 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -47992,7 +48062,7 @@ paths: enum: - open - resolved - - &602 + - &603 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -48002,7 +48072,7 @@ paths: required: false schema: type: string - - &603 + - &604 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -48013,7 +48083,7 @@ paths: required: false schema: type: string - - &604 + - &605 name: exclude_providers in: query description: |- @@ -48024,7 +48094,7 @@ paths: required: false schema: type: string - - &605 + - &606 name: providers in: query description: |- @@ -48035,7 +48105,7 @@ paths: required: false schema: type: string - - &606 + - &607 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -48044,7 +48114,7 @@ paths: required: false schema: type: string - - &607 + - &608 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -48063,7 +48133,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &608 + - &609 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. @@ -48078,7 +48148,7 @@ paths: - *60 - *19 - *17 - - &609 + - &610 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 @@ -48088,7 +48158,7 @@ paths: required: false schema: type: string - - &610 + - &611 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 @@ -48098,7 +48168,7 @@ paths: required: false schema: type: string - - &611 + - &612 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -48107,7 +48177,7 @@ paths: required: false schema: type: string - - &612 + - &613 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -48116,7 +48186,7 @@ paths: schema: type: boolean default: false - - &613 + - &614 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -48125,7 +48195,7 @@ paths: schema: type: boolean default: false - - &614 + - &615 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -48157,14 +48227,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &615 + state: &616 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: &616 + resolution: &617 type: - string - 'null' @@ -48283,14 +48353,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &617 + - &618 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &619 + - &620 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -48354,7 +48424,7 @@ paths: - blob_url - commit_sha - commit_url - - &620 + - &621 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. @@ -48415,7 +48485,7 @@ paths: - page_url - commit_sha - commit_url - - &621 + - &622 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -48437,7 +48507,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &622 + - &623 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -48459,7 +48529,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &623 + - &624 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -48481,7 +48551,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &624 + - &625 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -48496,7 +48566,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &625 + - &626 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -48511,7 +48581,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &626 + - &627 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -48526,7 +48596,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &627 + - &628 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. @@ -48548,7 +48618,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &628 + - &629 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. @@ -48570,7 +48640,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &629 + - &630 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. @@ -48592,7 +48662,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &630 + - &631 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. @@ -48614,7 +48684,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &631 + - &632 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 @@ -49135,7 +49205,7 @@ paths: application/json: schema: type: array - items: &635 + items: &636 description: A repository security advisory. type: object properties: @@ -49486,7 +49556,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &636 + default: &637 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -70712,7 +70782,7 @@ paths: type: array items: *456 examples: - default: &572 + default: &573 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -71003,7 +71073,7 @@ paths: type: array items: *460 examples: - default: &564 + default: &565 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -71561,7 +71631,7 @@ paths: application/json: schema: *456 examples: - default: &552 + default: &553 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -72224,7 +72294,7 @@ paths: application/json: schema: type: array - items: &640 + items: &641 title: Status description: The status of a commit. type: object @@ -73213,7 +73283,7 @@ paths: - size - type - url - - &577 + - &578 title: Content File description: Content File type: object @@ -73880,7 +73950,7 @@ paths: items: type: object properties: - placeholder_id: &632 + placeholder_id: &633 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -84201,7 +84271,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &534 + - &535 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -84250,7 +84320,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &535 + - &536 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -84378,7 +84448,7 @@ paths: - performed_via_github_app - assignee - assigner - - &536 + - &537 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -84424,7 +84494,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &537 + - &538 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -84470,7 +84540,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &539 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -84519,7 +84589,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &540 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -84561,7 +84631,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &541 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -84603,7 +84673,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &542 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -84659,7 +84729,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &543 title: Locked Issue Event description: Locked Issue Event type: object @@ -84704,7 +84774,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &544 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -84765,7 +84835,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &545 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -84826,7 +84896,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &546 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -84887,7 +84957,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &547 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -85011,7 +85081,7 @@ paths: type: array items: *532 examples: - default: &646 + default: &533 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -85043,6 +85113,254 @@ 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: + - *325 + - *326 + - *529 + 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 + examples: + - 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 + examples: + - 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: *532 + examples: + default: *533 + '400': *14 + '403': *27 + '404': *6 + '422': *15 + '503': *114 + 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: + - *325 + - *326 + - *529 + 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 + examples: + - 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 + examples: + - 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: *532 + examples: + default: *533 + '400': *14 + '403': *27 + '404': *6 + '422': *15 + '503': *114 + 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: + - *325 + - *326 + - *529 + - *229 + responses: + '204': + description: Issue field value deleted successfully + '403': *27 + '404': *6 + '422': *15 + '503': *114 + 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 @@ -85068,7 +85386,7 @@ paths: type: array items: *81 examples: - default: &533 + default: &534 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -85151,7 +85469,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 '301': *329 '404': *6 '410': *523 @@ -85235,7 +85553,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 '301': *329 '404': *6 '410': *523 @@ -85827,7 +86145,6 @@ paths: description: Timeline Event type: object anyOf: - - *534 - *535 - *536 - *537 @@ -85840,6 +86157,7 @@ paths: - *544 - *545 - *546 + - *547 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -85896,7 +86214,7 @@ paths: pin: anyOf: - type: 'null' - - *547 + - *548 required: - event - actor @@ -86172,7 +86490,7 @@ paths: type: string comments: type: array - items: &566 + items: &567 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -86716,7 +87034,7 @@ paths: application/json: schema: type: array - items: &548 + items: &549 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -86821,9 +87139,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: &549 + default: &550 value: id: 1 key: ssh-rsa AAA... @@ -86859,7 +87177,7 @@ paths: parameters: - *325 - *326 - - &550 + - &551 name: key_id description: The unique identifier of the key. in: path @@ -86871,9 +87189,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: *549 + default: *550 '404': *6 x-github: githubCloudOnly: false @@ -86893,7 +87211,7 @@ paths: parameters: - *325 - *326 - - *550 + - *551 responses: '204': description: Response @@ -86926,7 +87244,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 headers: Link: *66 '404': *6 @@ -86986,7 +87304,7 @@ paths: application/json: schema: *81 examples: - default: &551 + default: &552 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -87032,7 +87350,7 @@ paths: application/json: schema: *81 examples: - default: *551 + default: *552 '404': *6 x-github: githubCloudOnly: false @@ -87434,7 +87752,7 @@ paths: application/json: schema: *456 examples: - default: *552 + default: *553 '204': description: Response when already merged '404': @@ -87600,7 +87918,7 @@ paths: application/json: schema: *266 examples: - default: &553 + default: &554 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -87661,7 +87979,7 @@ paths: parameters: - *325 - *326 - - &554 + - &555 name: milestone_number description: The number that identifies the milestone. in: path @@ -87675,7 +87993,7 @@ paths: application/json: schema: *266 examples: - default: *553 + default: *554 '404': *6 x-github: githubCloudOnly: false @@ -87694,7 +88012,7 @@ paths: parameters: - *325 - *326 - - *554 + - *555 requestBody: required: false content: @@ -87734,7 +88052,7 @@ paths: application/json: schema: *266 examples: - default: *553 + default: *554 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87752,7 +88070,7 @@ paths: parameters: - *325 - *326 - - *554 + - *555 responses: '204': description: Response @@ -87775,7 +88093,7 @@ paths: parameters: - *325 - *326 - - *554 + - *555 - *17 - *19 responses: @@ -87787,7 +88105,7 @@ paths: type: array items: *81 examples: - default: *533 + default: *534 headers: Link: *66 x-github: @@ -87808,10 +88126,10 @@ paths: parameters: - *325 - *326 - - *555 - *556 - - *87 - *557 + - *87 + - *558 - *17 - *19 responses: @@ -87823,7 +88141,7 @@ paths: type: array items: *107 examples: - default: *558 + default: *559 headers: Link: *66 x-github: @@ -87913,7 +88231,7 @@ paths: description: Response content: application/json: - schema: &559 + schema: &560 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -88057,7 +88375,7 @@ paths: - custom_404 - public examples: - default: &560 + default: &561 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -88154,9 +88472,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *560 examples: - default: *560 + default: *561 '422': *15 '409': *52 x-github: @@ -88318,7 +88636,7 @@ paths: application/json: schema: type: array - items: &561 + items: &562 title: Page Build description: Page Build type: object @@ -88465,9 +88783,9 @@ paths: description: Response content: application/json: - schema: *561 + schema: *562 examples: - default: &562 + default: &563 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -88527,9 +88845,9 @@ paths: description: Response content: application/json: - schema: *561 + schema: *562 examples: - default: *562 + default: *563 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88660,7 +88978,7 @@ paths: parameters: - *325 - *326 - - &563 + - &564 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -88720,7 +89038,7 @@ paths: parameters: - *325 - *326 - - *563 + - *564 responses: '204': *59 '404': *6 @@ -89292,7 +89610,7 @@ paths: type: array items: *460 examples: - default: *564 + default: *565 headers: Link: *66 '304': *35 @@ -89392,7 +89710,7 @@ paths: description: Response content: application/json: - schema: &568 + schema: &569 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -89626,7 +89944,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: *565 + auto_merge: *566 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -89822,7 +90140,7 @@ paths: - review_comments version: '2026-03-10' examples: - default: &569 + default: &570 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -90390,9 +90708,9 @@ paths: application/json: schema: type: array - items: *566 + items: *567 examples: - default: &571 + default: &572 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -90477,9 +90795,9 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: - default: &567 + default: &568 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -90578,9 +90896,9 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: - default: *567 + default: *568 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90783,7 +91101,7 @@ paths: parameters: - *325 - *326 - - &570 + - &571 name: pull_number description: The number that identifies the pull request. in: path @@ -90796,9 +91114,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *568 + schema: *569 examples: - default: *569 + default: *570 '304': *35 '404': *6 '406': @@ -90835,7 +91153,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -90877,9 +91195,9 @@ paths: description: Response content: application/json: - schema: *568 + schema: *569 examples: - default: *569 + default: *570 '422': *15 '403': *27 x-github: @@ -90887,6 +91205,61 @@ 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: + - *325 + - *326 + - *571 + responses: + '204': + description: Response + '403': *27 + '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: + - *325 + - *326 + - *571 + responses: + '204': + description: Response + '403': *27 + '404': *6 + '422': *15 + 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 @@ -90903,7 +91276,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: true content: @@ -91006,7 +91379,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *104 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -91027,9 +91400,9 @@ paths: application/json: schema: type: array - items: *566 + items: *567 examples: - default: *571 + default: *572 headers: Link: *66 x-github: @@ -91064,7 +91437,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: true content: @@ -91170,7 +91543,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: example-for-a-multi-line-comment: value: @@ -91260,7 +91633,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *96 requestBody: required: true @@ -91283,7 +91656,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: default: value: @@ -91371,7 +91744,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *17 - *19 responses: @@ -91383,7 +91756,7 @@ paths: type: array items: *456 examples: - default: *572 + default: *573 headers: Link: *66 x-github: @@ -91415,7 +91788,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *17 - *19 responses: @@ -91465,7 +91838,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 responses: '204': description: Response if pull request has been merged @@ -91490,7 +91863,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -91604,7 +91977,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 responses: '200': description: Response @@ -91681,7 +92054,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -92256,7 +92629,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: true content: @@ -92808,7 +93181,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 - *17 - *19 responses: @@ -92818,7 +93191,7 @@ paths: application/json: schema: type: array - items: &573 + items: &574 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -92976,7 +93349,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -93066,9 +93439,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: &575 + default: &576 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -93133,8 +93506,8 @@ paths: parameters: - *325 - *326 - - *570 - - &574 + - *571 + - &575 name: review_id description: The unique identifier of the review. in: path @@ -93146,9 +93519,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: &576 + default: &577 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -93209,8 +93582,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 requestBody: required: true content: @@ -93233,7 +93606,7 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: default: value: @@ -93297,16 +93670,16 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 responses: '200': description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: *575 + default: *576 '422': *7 '404': *6 x-github: @@ -93335,8 +93708,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 - *17 - *19 responses: @@ -93596,8 +93969,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 requestBody: required: true content: @@ -93626,7 +93999,7 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: default: value: @@ -93691,8 +94064,8 @@ paths: parameters: - *325 - *326 - - *570 - - *574 + - *571 + - *575 requestBody: required: true content: @@ -93727,9 +94100,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: *576 + default: *577 '404': *6 '422': *7 '403': *27 @@ -93753,7 +94126,7 @@ paths: parameters: - *325 - *326 - - *570 + - *571 requestBody: required: false content: @@ -93831,9 +94204,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: &578 + default: &579 value: type: file encoding: base64 @@ -93896,9 +94269,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '404': *6 '422': *15 x-github: @@ -93931,7 +94304,7 @@ paths: application/json: schema: type: array - items: *579 + items: *580 examples: default: value: @@ -94102,9 +94475,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: &583 + default: &584 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -94211,7 +94584,7 @@ paths: parameters: - *325 - *326 - - &581 + - &582 name: asset_id description: The unique identifier of the asset. in: path @@ -94223,9 +94596,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: - default: &582 + default: &583 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 @@ -94278,7 +94651,7 @@ paths: parameters: - *325 - *326 - - *581 + - *582 requestBody: required: false content: @@ -94307,9 +94680,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: - default: *582 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94327,7 +94700,7 @@ paths: parameters: - *325 - *326 - - *581 + - *582 responses: '204': description: Response @@ -94446,9 +94819,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *583 + default: *584 '404': *6 x-github: githubCloudOnly: false @@ -94480,9 +94853,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *583 + default: *584 '404': *6 x-github: githubCloudOnly: false @@ -94506,7 +94879,7 @@ paths: parameters: - *325 - *326 - - &584 + - &585 name: release_id description: The unique identifier of the release. in: path @@ -94520,9 +94893,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: *579 + schema: *580 examples: - default: *583 + default: *584 '401': description: Unauthorized x-github: @@ -94542,7 +94915,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 requestBody: required: false content: @@ -94606,9 +94979,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *583 + default: *584 '404': description: Not Found if the discussion category name is invalid content: @@ -94631,7 +95004,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 responses: '204': description: Response @@ -94654,7 +95027,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - *17 - *19 responses: @@ -94664,7 +95037,7 @@ paths: application/json: schema: type: array - items: *580 + items: *581 examples: default: value: @@ -94747,7 +95120,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - name: name in: query required: true @@ -94773,7 +95146,7 @@ paths: description: Response for successful upload content: application/json: - schema: *580 + schema: *581 examples: response-for-successful-upload: value: @@ -94830,7 +95203,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - 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. @@ -94879,7 +95252,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 requestBody: required: true content: @@ -94942,7 +95315,7 @@ paths: parameters: - *325 - *326 - - *584 + - *585 - *526 responses: '204': @@ -94986,7 +95359,7 @@ paths: oneOf: - allOf: - *287 - - &585 + - &586 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -95007,67 +95380,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *288 - - *585 + - *586 - allOf: - *289 - - *585 + - *586 - allOf: - *290 - - *585 + - *586 - allOf: + - *587 - *586 - - *585 - allOf: - *291 - - *585 + - *586 - allOf: - *292 - - *585 + - *586 - allOf: - *293 - - *585 + - *586 - allOf: - *294 - - *585 + - *586 - allOf: - *295 - - *585 + - *586 - allOf: - *296 - - *585 + - *586 - allOf: - *297 - - *585 + - *586 - allOf: - *298 - - *585 + - *586 - allOf: - *299 - - *585 + - *586 - allOf: - *300 - - *585 + - *586 - allOf: - *301 - - *585 + - *586 - allOf: - *302 - - *585 + - *586 - allOf: - *303 - - *585 + - *586 - allOf: - *304 - - *585 + - *586 - allOf: - *305 - - *585 + - *586 - allOf: - *306 - - *585 + - *586 - allOf: - *307 - - *585 + - *586 examples: default: value: @@ -95118,7 +95491,7 @@ paths: schema: type: boolean default: true - - *587 + - *588 responses: '200': description: Response @@ -95203,7 +95576,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *588 + items: *589 required: - name - enforcement @@ -95236,7 +95609,7 @@ paths: application/json: schema: *308 examples: - default: &598 + default: &599 value: id: 42 name: super cool ruleset @@ -95286,10 +95659,10 @@ paths: parameters: - *325 - *326 - - *589 - *590 - *591 - *592 + - *593 - *17 - *19 responses: @@ -95297,9 +95670,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: - default: *594 + default: *595 '404': *6 '500': *53 x-github: @@ -95322,15 +95695,15 @@ paths: parameters: - *325 - *326 - - *595 + - *596 responses: '200': description: Response content: application/json: - schema: *596 + schema: *597 examples: - default: *597 + default: *598 '404': *6 '500': *53 x-github: @@ -95381,7 +95754,7 @@ paths: application/json: schema: *308 examples: - default: *598 + default: *599 '404': *6 '500': *53 put: @@ -95434,7 +95807,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *588 + items: *589 examples: default: value: @@ -95464,7 +95837,7 @@ paths: application/json: schema: *308 examples: - default: *598 + default: *599 '404': *6 '422': *15 '500': *53 @@ -95526,7 +95899,7 @@ paths: type: array items: *311 examples: - default: *599 + default: *600 '404': *6 '500': *53 x-github: @@ -95564,7 +95937,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -95621,7 +95994,6 @@ paths: parameters: - *325 - *326 - - *601 - *602 - *603 - *604 @@ -95629,15 +96001,16 @@ paths: - *606 - *607 - *608 + - *609 - *60 - *19 - *17 - - *609 - *610 - *611 - *612 - *613 - *614 + - *615 responses: '200': description: Response @@ -95645,7 +96018,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 type: object properties: number: *171 @@ -95661,8 +96034,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *615 - resolution: *616 + state: *616 + resolution: *617 resolved_at: type: - string @@ -95768,7 +96141,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *617 + - *618 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -95930,13 +96303,13 @@ paths: - *325 - *326 - *422 - - *614 + - *615 responses: '200': description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -96000,8 +96373,8 @@ paths: schema: type: object properties: - state: *615 - resolution: *616 + state: *616 + resolution: *617 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -96039,7 +96412,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -96174,7 +96547,6 @@ paths: - commit details: oneOf: - - *619 - *620 - *621 - *622 @@ -96187,6 +96559,7 @@ paths: - *629 - *630 - *631 + - *632 examples: default: value: @@ -96281,14 +96654,14 @@ paths: schema: type: object properties: - reason: &633 + reason: &634 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *632 + placeholder_id: *633 required: - reason - placeholder_id @@ -96305,7 +96678,7 @@ paths: schema: type: object properties: - reason: *633 + reason: *634 expire_at: type: - string @@ -96368,7 +96741,7 @@ paths: properties: incremental_scans: type: array - items: &634 + items: &635 description: Information on a single scan performed by secret scanning on the repository type: object @@ -96396,15 +96769,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *634 + items: *635 backfill_scans: type: array - items: *634 + items: *635 custom_pattern_backfill_scans: type: array items: allOf: - - *634 + - *635 - type: object properties: pattern_name: @@ -96417,7 +96790,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *634 + items: *635 examples: default: value: @@ -96527,9 +96900,9 @@ paths: application/json: schema: type: array - items: *635 + items: *636 examples: - default: *636 + default: *637 '400': *14 '404': *6 x-github: @@ -96723,9 +97096,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: &638 + default: &639 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -97078,7 +97451,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: default: value: @@ -97233,15 +97606,15 @@ paths: parameters: - *325 - *326 - - *637 + - *638 responses: '200': description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: *638 + default: *639 '403': *27 '404': *6 x-github: @@ -97267,7 +97640,7 @@ paths: parameters: - *325 - *326 - - *637 + - *638 requestBody: required: true content: @@ -97438,10 +97811,10 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: *638 - add_credit: *638 + default: *639 + add_credit: *639 '403': *27 '404': *6 '422': @@ -97481,7 +97854,7 @@ paths: parameters: - *325 - *326 - - *637 + - *638 responses: '202': *37 '400': *14 @@ -97510,7 +97883,7 @@ paths: parameters: - *325 - *326 - - *637 + - *638 responses: '202': description: Response @@ -97651,7 +98024,7 @@ paths: application/json: schema: type: array - items: &639 + items: &640 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -98024,7 +98397,7 @@ paths: application/json: schema: type: array - items: *639 + items: *640 examples: default: value: @@ -98114,7 +98487,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: default: value: @@ -98208,7 +98581,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &641 + schema: &642 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -98308,7 +98681,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -98518,7 +98891,7 @@ paths: description: Response content: application/json: - schema: &642 + schema: &643 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -98530,7 +98903,7 @@ paths: required: - names examples: - default: &643 + default: &644 value: names: - octocat @@ -98585,9 +98958,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *643 + default: *644 '404': *6 '422': *7 x-github: @@ -98610,7 +98983,7 @@ paths: parameters: - *325 - *326 - - &644 + - &645 name: per description: The time frame to display results for. in: query @@ -98641,7 +99014,7 @@ paths: - 128 clones: type: array - items: &645 + items: &646 title: Traffic type: object properties: @@ -98889,7 +99262,7 @@ paths: parameters: - *325 - *326 - - *644 + - *645 responses: '200': description: Response @@ -98910,7 +99283,7 @@ paths: - 3782 views: type: array - items: *645 + items: *646 required: - uniques - count @@ -99560,252 +99933,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: - - *142 - - *529 - 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 - examples: - - 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 - examples: - - 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: *532 - examples: - default: *646 - '400': *14 - '403': *27 - '404': *6 - '422': *15 - '503': *114 - 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: - - *142 - - *529 - 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 - examples: - - 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 - examples: - - 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: *532 - examples: - default: *646 - '400': *14 - '403': *27 - '404': *6 - '422': *15 - '503': *114 - 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: - - *142 - - *529 - - *229 - responses: - '204': - description: Issue field value deleted successfully - '403': *27 - '404': *6 - '422': *15 - '503': *114 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values "/search/code": get: summary: Search code @@ -106638,7 +106765,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *551 responses: '200': description: Response @@ -106669,7 +106796,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *551 responses: '204': description: Response @@ -123635,7 +123762,7 @@ webhooks: - *484 pull_requests: type: array - items: *568 + items: *569 repository: *715 organization: *714 installation: *713 @@ -131825,7 +131952,7 @@ webhooks: pin: anyOf: - type: 'null' - - *547 + - *548 user: title: User type: @@ -133324,7 +133451,7 @@ webhooks: pin: anyOf: - type: 'null' - - *547 + - *548 required: - url - html_url @@ -171394,7 +171521,7 @@ webhooks: organization: *714 pull_request: &758 allOf: - - *568 + - *569 - type: object properties: allow_auto_merge: @@ -227779,7 +227906,7 @@ webhooks: installation: *713 organization: *714 repository: *715 - repository_advisory: *635 + repository_advisory: *636 sender: *4 required: - action @@ -227859,7 +227986,7 @@ webhooks: installation: *713 organization: *714 repository: *715 - repository_advisory: *635 + repository_advisory: *636 sender: *4 required: - action @@ -228950,16 +229077,16 @@ webhooks: properties: added: type: array - items: *588 + items: *589 deleted: type: array - items: *588 + items: *589 updated: type: array items: type: object properties: - rule: *588 + rule: *589 changes: type: object properties: diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index ad135a4c13..92e5ca0df2 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -22393,6 +22393,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" @@ -22403,6 +22412,10 @@ "string", "null" ] + }, + "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" } } }, @@ -139760,6 +139773,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" @@ -139770,6 +139792,10 @@ "string", "null" ] + }, + "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" } } }, @@ -246318,7 +246344,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -246391,6 +246418,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" @@ -246543,7 +246582,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" ], @@ -246634,14 +246673,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": { @@ -246677,12 +246717,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": [ @@ -246729,6 +246781,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" + } } } } @@ -246779,7 +246843,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -246856,6 +246921,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" @@ -247194,7 +247271,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -247267,6 +247345,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" @@ -247335,7 +247425,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" ], @@ -247442,7 +247532,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -247478,12 +247569,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" } } }, @@ -570417,275 +570520,1485 @@ "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", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - 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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + 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": [ { @@ -646701,6 +648014,366 @@ } } }, + "/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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", @@ -724499,1191 +726172,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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index a972070b8f..2d086f54f4 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -1081,7 +1081,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: - - &748 + - &749 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -9069,6 +9069,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`, @@ -9080,6 +9089,11 @@ paths: type: - string - 'null' + 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: @@ -22772,7 +22786,7 @@ paths: - object rules: type: array - items: &714 + items: &715 title: Repository Rule type: object description: A repository rule. @@ -22781,7 +22795,7 @@ paths: - *167 - *168 - *169 - - &712 + - &713 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -23374,14 +23388,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &726 + state: &727 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: &727 + resolution: &728 type: - string - 'null' @@ -23500,14 +23514,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &728 + - &729 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &730 + - &731 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -23571,7 +23585,7 @@ paths: - blob_url - commit_sha - commit_url - - &731 + - &732 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. @@ -23632,7 +23646,7 @@ paths: - page_url - commit_sha - commit_url - - &732 + - &733 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -23654,7 +23668,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &733 + - &734 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -23676,7 +23690,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &734 + - &735 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -23698,7 +23712,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &735 + - &736 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -23713,7 +23727,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &736 + - &737 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -23728,7 +23742,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &737 + - &738 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -23743,7 +23757,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &738 + - &739 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. @@ -23765,7 +23779,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &739 + - &740 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. @@ -23787,7 +23801,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &740 + - &741 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. @@ -23809,7 +23823,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &741 + - &742 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. @@ -23831,7 +23845,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &742 + - &743 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 @@ -28420,7 +28434,7 @@ paths: pin: anyOf: - type: 'null' - - &671 + - &672 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -29247,7 +29261,7 @@ paths: type: string release: allOf: - - &705 + - &706 title: Release description: A release. type: object @@ -29329,7 +29343,7 @@ paths: author: *4 assets: type: array - items: &706 + items: &707 title: Release Asset description: Data related to a release. type: object @@ -33364,7 +33378,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &679 + - &680 name: all description: If `true`, show notifications marked as read. in: query @@ -33372,7 +33386,7 @@ paths: schema: type: boolean default: false - - &680 + - &681 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -33382,7 +33396,7 @@ paths: type: boolean default: false - *224 - - &681 + - &682 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: @@ -33983,7 +33997,7 @@ paths: - url - subscription_url examples: - default: &682 + default: &683 value: - id: '1' repository: @@ -34846,7 +34860,7 @@ paths: type: array items: *152 examples: - default: &688 + default: &689 value: - property_name: environment value: production @@ -34896,7 +34910,7 @@ paths: required: - properties examples: - default: &689 + default: &690 value: properties: - property_name: environment @@ -36403,6 +36417,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`, @@ -36414,6 +36437,11 @@ paths: type: - string - 'null' + 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: @@ -55005,6 +55033,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -55066,6 +55095,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 @@ -55103,7 +55141,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: @@ -55196,8 +55234,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 @@ -55205,6 +55243,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`. @@ -55236,13 +55275,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 @@ -55281,6 +55332,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 @@ -55323,6 +55384,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -55389,6 +55451,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 @@ -55514,7 +55585,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: @@ -55612,6 +55683,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`. @@ -55643,13 +55715,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 @@ -56317,7 +56401,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: &691 + auto_merge: &692 title: Auto merge description: The status of auto merging a pull request. type: @@ -60450,7 +60534,7 @@ paths: - *87 - *17 - *19 - - &713 + - &714 name: targets description: | A comma-separated list of rule targets to filter by. @@ -60667,7 +60751,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *87 - - &715 + - &716 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 @@ -60679,14 +60763,14 @@ paths: x-multi-segment: true - *304 - *105 - - &716 + - &717 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 - - &717 + - &718 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -60706,7 +60790,7 @@ paths: description: Response content: application/json: - schema: &718 + schema: &719 title: Rule Suites description: Response type: array @@ -60762,7 +60846,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &719 + default: &720 value: - id: 21 actor_id: 12 @@ -60806,7 +60890,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *87 - - &720 + - &721 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -60822,7 +60906,7 @@ paths: description: Response content: application/json: - schema: &721 + schema: &722 title: Rule Suite description: Response type: object @@ -60929,7 +61013,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &722 + default: &723 value: id: 21 actor_id: 12 @@ -61265,7 +61349,7 @@ paths: - *110 - *19 - *17 - - &724 + - &725 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 @@ -61275,7 +61359,7 @@ paths: required: false schema: type: string - - &725 + - &726 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 @@ -61488,7 +61572,7 @@ paths: application/json: schema: type: array - items: &746 + items: &747 description: A repository security advisory. type: object properties: @@ -61807,7 +61891,7 @@ paths: - private_fork additionalProperties: false examples: - default: &747 + default: &748 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -83444,7 +83528,7 @@ paths: type: array items: *573 examples: - default: &698 + default: &699 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -83735,7 +83819,7 @@ paths: type: array items: *577 examples: - default: &690 + default: &691 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -84293,7 +84377,7 @@ paths: application/json: schema: *573 examples: - default: &676 + default: &677 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -84956,7 +85040,7 @@ paths: application/json: schema: type: array - items: &751 + items: &752 title: Status description: The status of a commit. type: object @@ -85945,7 +86029,7 @@ paths: - size - type - url - - &703 + - &704 title: Content File description: Content File type: object @@ -86582,7 +86666,7 @@ paths: items: type: object properties: - placeholder_id: &743 + placeholder_id: &744 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -97527,7 +97611,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &658 + - &659 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -97576,7 +97660,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &659 + - &660 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -97704,7 +97788,7 @@ paths: - performed_via_github_app - assignee - assigner - - &660 + - &661 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -97750,7 +97834,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &661 + - &662 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -97796,7 +97880,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &662 + - &663 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -97845,7 +97929,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &663 + - &664 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -97887,7 +97971,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &664 + - &665 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -97929,7 +98013,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &665 + - &666 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -97985,7 +98069,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &667 title: Locked Issue Event description: Locked Issue Event type: object @@ -98030,7 +98114,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &667 + - &668 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -98091,7 +98175,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &669 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -98152,7 +98236,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &670 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -98213,7 +98297,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &671 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -98337,7 +98421,7 @@ paths: type: array items: *656 examples: - default: &757 + default: &657 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -98369,6 +98453,254 @@ 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: + - *459 + - *460 + - *653 + 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 + examples: + - 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 + examples: + - 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: *656 + examples: + default: *657 + '400': *14 + '403': *27 + '404': *6 + '422': *15 + '503': *192 + 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: + - *459 + - *460 + - *653 + 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 + examples: + - 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 + examples: + - 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: *656 + examples: + default: *657 + '400': *14 + '403': *27 + '404': *6 + '422': *15 + '503': *192 + 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: + - *459 + - *460 + - *653 + - *373 + responses: + '204': + description: Issue field value deleted successfully + '403': *27 + '404': *6 + '422': *15 + '503': *192 + 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 @@ -98394,7 +98726,7 @@ paths: type: array items: *218 examples: - default: &657 + default: &658 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -98477,7 +98809,7 @@ paths: type: array items: *218 examples: - default: *657 + default: *658 '301': *465 '404': *6 '410': *647 @@ -98561,7 +98893,7 @@ paths: type: array items: *218 examples: - default: *657 + default: *658 '301': *465 '404': *6 '410': *647 @@ -99153,7 +99485,6 @@ paths: description: Timeline Event type: object anyOf: - - *658 - *659 - *660 - *661 @@ -99166,6 +99497,7 @@ paths: - *668 - *669 - *670 + - *671 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -99222,7 +99554,7 @@ paths: pin: anyOf: - type: 'null' - - *671 + - *672 required: - event - actor @@ -99498,7 +99830,7 @@ paths: type: string comments: type: array - items: &692 + items: &693 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -100042,7 +100374,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -100147,9 +100479,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: &673 + default: &674 value: id: 1 key: ssh-rsa AAA... @@ -100185,7 +100517,7 @@ paths: parameters: - *459 - *460 - - &674 + - &675 name: key_id description: The unique identifier of the key. in: path @@ -100197,9 +100529,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *673 + default: *674 '404': *6 x-github: githubCloudOnly: false @@ -100219,7 +100551,7 @@ paths: parameters: - *459 - *460 - - *674 + - *675 responses: '204': description: Response @@ -100252,7 +100584,7 @@ paths: type: array items: *218 examples: - default: *657 + default: *658 headers: Link: *45 '404': *6 @@ -100312,7 +100644,7 @@ paths: application/json: schema: *218 examples: - default: &675 + default: &676 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -100358,7 +100690,7 @@ paths: application/json: schema: *218 examples: - default: *675 + default: *676 '404': *6 x-github: githubCloudOnly: false @@ -100813,7 +101145,7 @@ paths: application/json: schema: *573 examples: - default: *676 + default: *677 '204': description: Response when already merged '404': @@ -100979,7 +101311,7 @@ paths: application/json: schema: *408 examples: - default: &677 + default: &678 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -101040,7 +101372,7 @@ paths: parameters: - *459 - *460 - - &678 + - &679 name: milestone_number description: The number that identifies the milestone. in: path @@ -101054,7 +101386,7 @@ paths: application/json: schema: *408 examples: - default: *677 + default: *678 '404': *6 x-github: githubCloudOnly: false @@ -101073,7 +101405,7 @@ paths: parameters: - *459 - *460 - - *678 + - *679 requestBody: required: false content: @@ -101113,7 +101445,7 @@ paths: application/json: schema: *408 examples: - default: *677 + default: *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101131,7 +101463,7 @@ paths: parameters: - *459 - *460 - - *678 + - *679 responses: '204': description: Response @@ -101154,7 +101486,7 @@ paths: parameters: - *459 - *460 - - *678 + - *679 - *17 - *19 responses: @@ -101166,7 +101498,7 @@ paths: type: array items: *218 examples: - default: *657 + default: *658 headers: Link: *45 x-github: @@ -101187,10 +101519,10 @@ paths: parameters: - *459 - *460 - - *679 - *680 - - *224 - *681 + - *224 + - *682 - *17 - *19 responses: @@ -101202,7 +101534,7 @@ paths: type: array items: *244 examples: - default: *682 + default: *683 headers: Link: *45 x-github: @@ -101292,7 +101624,7 @@ paths: description: Response content: application/json: - schema: &683 + schema: &684 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -101436,7 +101768,7 @@ paths: - custom_404 - public examples: - default: &684 + default: &685 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -101533,9 +101865,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *684 examples: - default: *684 + default: *685 '422': *15 '409': *119 x-github: @@ -101705,7 +102037,7 @@ paths: application/json: schema: type: array - items: &685 + items: &686 title: Page Build description: Page Build type: object @@ -101852,9 +102184,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *686 examples: - default: &686 + default: &687 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -101914,9 +102246,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *686 examples: - default: *686 + default: *687 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102047,7 +102379,7 @@ paths: parameters: - *459 - *460 - - &687 + - &688 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -102107,7 +102439,7 @@ paths: parameters: - *459 - *460 - - *687 + - *688 responses: '204': *126 '404': *6 @@ -102524,7 +102856,7 @@ paths: type: array items: *152 examples: - default: *688 + default: *689 '403': *27 '404': *6 x-github: @@ -102563,7 +102895,7 @@ paths: required: - properties examples: - default: *689 + default: *690 responses: '204': description: No Content when custom property values are successfully created @@ -102664,7 +102996,7 @@ paths: type: array items: *577 examples: - default: *690 + default: *691 headers: Link: *45 '304': *35 @@ -102764,7 +103096,7 @@ paths: description: Response content: application/json: - schema: &694 + schema: &695 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -102998,7 +103330,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: *691 + auto_merge: *692 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -103100,7 +103432,7 @@ paths: - merged_by - review_comments examples: - default: &695 + default: &696 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -103657,9 +103989,9 @@ paths: application/json: schema: type: array - items: *692 + items: *693 examples: - default: &697 + default: &698 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -103744,9 +104076,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: &693 + default: &694 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -103845,9 +104177,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: *693 + default: *694 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104050,7 +104382,7 @@ paths: parameters: - *459 - *460 - - &696 + - &697 name: pull_number description: The number that identifies the pull request. in: path @@ -104063,9 +104395,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *694 + schema: *695 examples: - default: *695 + default: *696 '304': *35 '404': *6 '406': @@ -104102,7 +104434,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: false content: @@ -104144,11 +104476,66 @@ paths: description: Response content: application/json: - schema: *694 + schema: *695 examples: - default: *695 + default: *696 + '422': *15 + '403': *27 + 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: + - *459 + - *460 + - *697 + responses: + '204': + description: Response + '403': *27 + '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: + - *459 + - *460 + - *697 + responses: + '204': + description: Response '403': *27 + '404': *6 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104170,7 +104557,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: true content: @@ -104273,7 +104660,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 - *241 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -104294,9 +104681,9 @@ paths: application/json: schema: type: array - items: *692 + items: *693 examples: - default: *697 + default: *698 headers: Link: *45 x-github: @@ -104331,7 +104718,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: true content: @@ -104437,7 +104824,7 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: example-for-a-multi-line-comment: value: @@ -104527,7 +104914,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 - *233 requestBody: required: true @@ -104550,7 +104937,7 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: default: value: @@ -104638,7 +105025,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 - *17 - *19 responses: @@ -104650,7 +105037,7 @@ paths: type: array items: *573 examples: - default: *698 + default: *699 headers: Link: *45 x-github: @@ -104682,7 +105069,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 - *17 - *19 responses: @@ -104732,7 +105119,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 responses: '204': description: Response if pull request has been merged @@ -104757,7 +105144,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: false content: @@ -104871,7 +105258,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 responses: '200': description: Response @@ -104948,7 +105335,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: false content: @@ -105523,7 +105910,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: true content: @@ -106064,7 +106451,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 - *17 - *19 responses: @@ -106074,7 +106461,7 @@ paths: application/json: schema: type: array - items: &699 + items: &700 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -106232,7 +106619,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: false content: @@ -106322,9 +106709,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: &701 + default: &702 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -106389,8 +106776,8 @@ paths: parameters: - *459 - *460 - - *696 - - &700 + - *697 + - &701 name: review_id description: The unique identifier of the review. in: path @@ -106402,9 +106789,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: &702 + default: &703 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -106465,8 +106852,8 @@ paths: parameters: - *459 - *460 - - *696 - - *700 + - *697 + - *701 requestBody: required: true content: @@ -106489,7 +106876,7 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: default: value: @@ -106553,16 +106940,16 @@ paths: parameters: - *459 - *460 - - *696 - - *700 + - *697 + - *701 responses: '200': description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: *701 + default: *702 '422': *7 '404': *6 x-github: @@ -106591,8 +106978,8 @@ paths: parameters: - *459 - *460 - - *696 - - *700 + - *697 + - *701 - *17 - *19 responses: @@ -106852,8 +107239,8 @@ paths: parameters: - *459 - *460 - - *696 - - *700 + - *697 + - *701 requestBody: required: true content: @@ -106882,7 +107269,7 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: default: value: @@ -106947,8 +107334,8 @@ paths: parameters: - *459 - *460 - - *696 - - *700 + - *697 + - *701 requestBody: required: true content: @@ -106983,9 +107370,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: *702 + default: *703 '404': *6 '422': *7 '403': *27 @@ -107009,7 +107396,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: false content: @@ -107087,9 +107474,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *704 examples: - default: &704 + default: &705 value: type: file encoding: base64 @@ -107152,9 +107539,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *704 examples: - default: *704 + default: *705 '404': *6 '422': *15 x-github: @@ -107187,7 +107574,7 @@ paths: application/json: schema: type: array - items: *705 + items: *706 examples: default: value: @@ -107358,9 +107745,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: &709 + default: &710 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -107467,7 +107854,7 @@ paths: parameters: - *459 - *460 - - &707 + - &708 name: asset_id description: The unique identifier of the asset. in: path @@ -107479,9 +107866,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: &708 + default: &709 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 @@ -107534,7 +107921,7 @@ paths: parameters: - *459 - *460 - - *707 + - *708 requestBody: required: false content: @@ -107563,9 +107950,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *708 + default: *709 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107583,7 +107970,7 @@ paths: parameters: - *459 - *460 - - *707 + - *708 responses: '204': description: Response @@ -107702,9 +108089,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: *709 + default: *710 '404': *6 x-github: githubCloudOnly: false @@ -107736,9 +108123,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: *709 + default: *710 '404': *6 x-github: githubCloudOnly: false @@ -107762,7 +108149,7 @@ paths: parameters: - *459 - *460 - - &710 + - &711 name: release_id description: The unique identifier of the release. in: path @@ -107776,9 +108163,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: *705 + schema: *706 examples: - default: *709 + default: *710 '401': description: Unauthorized x-github: @@ -107798,7 +108185,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 requestBody: required: false content: @@ -107862,9 +108249,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: *709 + default: *710 '404': description: Not Found if the discussion category name is invalid content: @@ -107887,7 +108274,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 responses: '204': description: Response @@ -107910,7 +108297,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 - *17 - *19 responses: @@ -107920,7 +108307,7 @@ paths: application/json: schema: type: array - items: *706 + items: *707 examples: default: value: @@ -108004,7 +108391,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 - name: name in: query required: true @@ -108030,7 +108417,7 @@ paths: description: Response for successful upload content: application/json: - schema: *706 + schema: *707 examples: response-for-successful-upload: value: @@ -108087,7 +108474,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 - 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. @@ -108136,7 +108523,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 requestBody: required: true content: @@ -108199,7 +108586,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 - *650 responses: '204': @@ -108243,7 +108630,7 @@ paths: oneOf: - allOf: - *166 - - &711 + - &712 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -108264,67 +108651,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *167 - - *711 + - *712 - allOf: - *168 - - *711 + - *712 - allOf: - *169 - - *711 + - *712 - allOf: + - *713 - *712 - - *711 - allOf: - *170 - - *711 + - *712 - allOf: - *171 - - *711 + - *712 - allOf: - *172 - - *711 + - *712 - allOf: - *173 - - *711 + - *712 - allOf: - *174 - - *711 + - *712 - allOf: - *175 - - *711 + - *712 - allOf: - *176 - - *711 + - *712 - allOf: - *177 - - *711 + - *712 - allOf: - *178 - - *711 + - *712 - allOf: - *179 - - *711 + - *712 - allOf: - *180 - - *711 + - *712 - allOf: - *181 - - *711 + - *712 - allOf: - *182 - - *711 + - *712 - allOf: - *183 - - *711 + - *712 - allOf: - *184 - - *711 + - *712 - allOf: - *185 - - *711 + - *712 - allOf: - *186 - - *711 + - *712 examples: default: value: @@ -108375,7 +108762,7 @@ paths: schema: type: boolean default: true - - *713 + - *714 responses: '200': description: Response @@ -108460,7 +108847,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *714 + items: *715 required: - name - enforcement @@ -108493,7 +108880,7 @@ paths: application/json: schema: *187 examples: - default: &723 + default: &724 value: id: 42 name: super cool ruleset @@ -108543,10 +108930,10 @@ paths: parameters: - *459 - *460 - - *715 - - *105 - *716 + - *105 - *717 + - *718 - *17 - *19 responses: @@ -108554,9 +108941,9 @@ paths: description: Response content: application/json: - schema: *718 + schema: *719 examples: - default: *719 + default: *720 '404': *6 '500': *38 x-github: @@ -108579,15 +108966,15 @@ paths: parameters: - *459 - *460 - - *720 + - *721 responses: '200': description: Response content: application/json: - schema: *721 + schema: *722 examples: - default: *722 + default: *723 '404': *6 '500': *38 x-github: @@ -108638,7 +109025,7 @@ paths: application/json: schema: *187 examples: - default: *723 + default: *724 '404': *6 '500': *38 put: @@ -108691,7 +109078,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *714 + items: *715 examples: default: value: @@ -108721,7 +109108,7 @@ paths: application/json: schema: *187 examples: - default: *723 + default: *724 '404': *6 '422': *15 '500': *38 @@ -108889,8 +109276,8 @@ paths: - *110 - *19 - *17 - - *724 - *725 + - *726 - *435 - *436 - *437 @@ -108902,7 +109289,7 @@ paths: application/json: schema: type: array - items: &729 + items: &730 type: object properties: number: *127 @@ -108918,8 +109305,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *726 - resolution: *727 + state: *727 + resolution: *728 resolved_at: type: - string @@ -109025,7 +109412,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *728 + - *729 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -109193,7 +109580,7 @@ paths: description: Response content: application/json: - schema: *729 + schema: *730 examples: default: value: @@ -109257,8 +109644,8 @@ paths: schema: type: object properties: - state: *726 - resolution: *727 + state: *727 + resolution: *728 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -109296,7 +109683,7 @@ paths: description: Response content: application/json: - schema: *729 + schema: *730 examples: default: value: @@ -109431,7 +109818,6 @@ paths: - commit details: oneOf: - - *730 - *731 - *732 - *733 @@ -109444,6 +109830,7 @@ paths: - *740 - *741 - *742 + - *743 examples: default: value: @@ -109538,14 +109925,14 @@ paths: schema: type: object properties: - reason: &744 + reason: &745 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *743 + placeholder_id: *744 required: - reason - placeholder_id @@ -109562,7 +109949,7 @@ paths: schema: type: object properties: - reason: *744 + reason: *745 expire_at: type: - string @@ -109625,7 +110012,7 @@ paths: properties: incremental_scans: type: array - items: &745 + items: &746 description: Information on a single scan performed by secret scanning on the repository type: object @@ -109653,15 +110040,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *745 + items: *746 backfill_scans: type: array - items: *745 + items: *746 custom_pattern_backfill_scans: type: array items: allOf: - - *745 + - *746 - type: object properties: pattern_name: @@ -109674,7 +110061,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *745 + items: *746 examples: default: value: @@ -109784,9 +110171,9 @@ paths: application/json: schema: type: array - items: *746 + items: *747 examples: - default: *747 + default: *748 '400': *14 '404': *6 x-github: @@ -109980,9 +110367,9 @@ paths: description: Response content: application/json: - schema: *746 + schema: *747 examples: - default: &749 + default: &750 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -110329,7 +110716,7 @@ paths: description: Response content: application/json: - schema: *746 + schema: *747 examples: default: value: @@ -110478,15 +110865,15 @@ paths: parameters: - *459 - *460 - - *748 + - *749 responses: '200': description: Response content: application/json: - schema: *746 + schema: *747 examples: - default: *749 + default: *750 '403': *27 '404': *6 x-github: @@ -110512,7 +110899,7 @@ paths: parameters: - *459 - *460 - - *748 + - *749 requestBody: required: true content: @@ -110683,10 +111070,10 @@ paths: description: Response content: application/json: - schema: *746 + schema: *747 examples: - default: *749 - add_credit: *749 + default: *750 + add_credit: *750 '403': *27 '404': *6 '422': @@ -110726,7 +111113,7 @@ paths: parameters: - *459 - *460 - - *748 + - *749 responses: '202': *37 '400': *14 @@ -110755,7 +111142,7 @@ paths: parameters: - *459 - *460 - - *748 + - *749 responses: '202': description: Response @@ -110896,7 +111283,7 @@ paths: application/json: schema: type: array - items: &750 + items: &751 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -111269,7 +111656,7 @@ paths: application/json: schema: type: array - items: *750 + items: *751 examples: default: value: @@ -111359,7 +111746,7 @@ paths: description: Response content: application/json: - schema: *751 + schema: *752 examples: default: value: @@ -111453,7 +111840,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &752 + schema: &753 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -111553,7 +111940,7 @@ paths: description: Response content: application/json: - schema: *752 + schema: *753 examples: default: value: @@ -111763,7 +112150,7 @@ paths: description: Response content: application/json: - schema: &753 + schema: &754 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -111775,7 +112162,7 @@ paths: required: - names examples: - default: &754 + default: &755 value: names: - octocat @@ -111830,9 +112217,9 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: *754 + default: *755 '404': *6 '422': *7 x-github: @@ -111855,7 +112242,7 @@ paths: parameters: - *459 - *460 - - &755 + - &756 name: per description: The time frame to display results for. in: query @@ -111886,7 +112273,7 @@ paths: - 128 clones: type: array - items: &756 + items: &757 title: Traffic type: object properties: @@ -112134,7 +112521,7 @@ paths: parameters: - *459 - *460 - - *755 + - *756 responses: '200': description: Response @@ -112155,7 +112542,7 @@ paths: - 3782 views: type: array - items: *756 + items: *757 required: - uniques - count @@ -112799,252 +113186,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: - - *272 - - *653 - 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 - examples: - - 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 - examples: - - 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: *656 - examples: - default: *757 - '400': *14 - '403': *27 - '404': *6 - '422': *15 - '503': *192 - 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: - - *272 - - *653 - 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 - examples: - - 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 - examples: - - 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: *656 - examples: - default: *757 - '400': *14 - '403': *27 - '404': *6 - '422': *15 - '503': *192 - 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: - - *272 - - *653 - - *373 - responses: - '204': - description: Issue field value deleted successfully - '403': *27 - '404': *6 - '422': *15 - '503': *192 - 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 @@ -122079,7 +122220,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: - - *674 + - *675 responses: '200': description: Response @@ -122110,7 +122251,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: - - *674 + - *675 responses: '204': description: Response @@ -139415,7 +139556,7 @@ webhooks: - *601 pull_requests: type: array - items: *694 + items: *695 repository: *848 organization: *847 installation: *846 @@ -148577,7 +148718,7 @@ webhooks: pin: anyOf: - type: 'null' - - *671 + - *672 user: title: User type: @@ -150076,7 +150217,7 @@ webhooks: pin: anyOf: - type: 'null' - - *671 + - *672 required: - url - html_url @@ -188417,7 +188558,7 @@ webhooks: organization: *847 pull_request: &898 allOf: - - *694 + - *695 - type: object properties: allow_auto_merge: @@ -244509,7 +244650,7 @@ webhooks: installation: *846 organization: *847 repository: *848 - repository_advisory: *746 + repository_advisory: *747 sender: *4 required: - action @@ -244589,7 +244730,7 @@ webhooks: installation: *846 organization: *847 repository: *848 - repository_advisory: *746 + repository_advisory: *747 sender: *4 required: - action @@ -245680,16 +245821,16 @@ webhooks: properties: added: type: array - items: *714 + items: *715 deleted: type: array - items: *714 + items: *715 updated: type: array items: type: object properties: - rule: *714 + rule: *715 changes: type: object properties: diff --git a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json index 01336ccf6c..ad88d5c358 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -22298,6 +22298,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" @@ -22308,6 +22317,10 @@ "string", "null" ] + }, + "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" } } }, @@ -135293,6 +135306,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" @@ -135303,6 +135325,10 @@ "string", "null" ] + }, + "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" } } }, @@ -239467,7 +239493,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -239540,6 +239567,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" @@ -239692,7 +239731,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" ], @@ -239783,14 +239822,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": { @@ -239826,12 +239866,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": [ @@ -239878,6 +239930,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" + } } } } @@ -239928,7 +239992,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -240005,6 +240070,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" @@ -240343,7 +240420,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -240416,6 +240494,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" @@ -240484,7 +240574,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" ], @@ -240591,7 +240681,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -240627,12 +240718,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" } } }, @@ -559173,275 +559276,1485 @@ "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", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - 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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + 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": [ { @@ -633275,6 +634588,366 @@ } } }, + "/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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", @@ -710284,1191 +711957,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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml index bbe2b23ad0..ff711e24a3 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml @@ -1049,7 +1049,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: - - &748 + - &749 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -9017,6 +9017,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`, @@ -9028,6 +9037,11 @@ paths: type: - string - 'null' + 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: @@ -22697,7 +22711,7 @@ paths: - object rules: type: array - items: &714 + items: &715 title: Repository Rule type: object description: A repository rule. @@ -22706,7 +22720,7 @@ paths: - *167 - *168 - *169 - - &712 + - &713 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -23299,14 +23313,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &726 + state: &727 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: &727 + resolution: &728 type: - string - 'null' @@ -23425,14 +23439,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &728 + - &729 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &730 + - &731 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -23496,7 +23510,7 @@ paths: - blob_url - commit_sha - commit_url - - &731 + - &732 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. @@ -23557,7 +23571,7 @@ paths: - page_url - commit_sha - commit_url - - &732 + - &733 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -23579,7 +23593,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &733 + - &734 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -23601,7 +23615,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &734 + - &735 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -23623,7 +23637,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &735 + - &736 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -23638,7 +23652,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &736 + - &737 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -23653,7 +23667,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &737 + - &738 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -23668,7 +23682,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &738 + - &739 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. @@ -23690,7 +23704,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &739 + - &740 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. @@ -23712,7 +23726,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &740 + - &741 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. @@ -23734,7 +23748,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &741 + - &742 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. @@ -23756,7 +23770,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &742 + - &743 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 @@ -28346,7 +28360,7 @@ paths: pin: anyOf: - type: 'null' - - &671 + - &672 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -29172,7 +29186,7 @@ paths: type: string release: allOf: - - &705 + - &706 title: Release description: A release. type: object @@ -29254,7 +29268,7 @@ paths: author: *4 assets: type: array - items: &706 + items: &707 title: Release Asset description: Data related to a release. type: object @@ -33052,7 +33066,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &679 + - &680 name: all description: If `true`, show notifications marked as read. in: query @@ -33060,7 +33074,7 @@ paths: schema: type: boolean default: false - - &680 + - &681 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -33070,7 +33084,7 @@ paths: type: boolean default: false - *224 - - &681 + - &682 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: @@ -33669,7 +33683,7 @@ paths: - url - subscription_url examples: - default: &682 + default: &683 value: - id: '1' repository: @@ -34450,7 +34464,7 @@ paths: type: array items: *152 examples: - default: &688 + default: &689 value: - property_name: environment value: production @@ -34500,7 +34514,7 @@ paths: required: - properties examples: - default: &689 + default: &690 value: properties: - property_name: environment @@ -35997,6 +36011,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`, @@ -36008,6 +36031,11 @@ paths: type: - string - 'null' + 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: @@ -54635,6 +54663,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -54696,6 +54725,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 @@ -54733,7 +54771,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: @@ -54826,8 +54864,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 @@ -54835,6 +54873,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`. @@ -54866,13 +54905,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 @@ -54911,6 +54962,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 @@ -54953,6 +55014,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -55019,6 +55081,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 @@ -55144,7 +55215,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: @@ -55242,6 +55313,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`. @@ -55273,13 +55345,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 @@ -55937,7 +56021,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: &691 + auto_merge: &692 title: Auto merge description: The status of auto merging a pull request. type: @@ -60060,7 +60144,7 @@ paths: - *87 - *17 - *19 - - &713 + - &714 name: targets description: | A comma-separated list of rule targets to filter by. @@ -60277,7 +60361,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *87 - - &715 + - &716 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 @@ -60289,14 +60373,14 @@ paths: x-multi-segment: true - *304 - *105 - - &716 + - &717 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 - - &717 + - &718 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -60316,7 +60400,7 @@ paths: description: Response content: application/json: - schema: &718 + schema: &719 title: Rule Suites description: Response type: array @@ -60372,7 +60456,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &719 + default: &720 value: - id: 21 actor_id: 12 @@ -60416,7 +60500,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *87 - - &720 + - &721 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -60432,7 +60516,7 @@ paths: description: Response content: application/json: - schema: &721 + schema: &722 title: Rule Suite description: Response type: object @@ -60539,7 +60623,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &722 + default: &723 value: id: 21 actor_id: 12 @@ -60875,7 +60959,7 @@ paths: - *110 - *19 - *17 - - &724 + - &725 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 @@ -60885,7 +60969,7 @@ paths: required: false schema: type: string - - &725 + - &726 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 @@ -61098,7 +61182,7 @@ paths: application/json: schema: type: array - items: &746 + items: &747 description: A repository security advisory. type: object properties: @@ -61395,7 +61479,7 @@ paths: - private_fork additionalProperties: false examples: - default: &747 + default: &748 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -82984,7 +83068,7 @@ paths: type: array items: *573 examples: - default: &698 + default: &699 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -83275,7 +83359,7 @@ paths: type: array items: *577 examples: - default: &690 + default: &691 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -83833,7 +83917,7 @@ paths: application/json: schema: *573 examples: - default: &676 + default: &677 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -84496,7 +84580,7 @@ paths: application/json: schema: type: array - items: &751 + items: &752 title: Status description: The status of a commit. type: object @@ -85485,7 +85569,7 @@ paths: - size - type - url - - &703 + - &704 title: Content File description: Content File type: object @@ -86122,7 +86206,7 @@ paths: items: type: object properties: - placeholder_id: &743 + placeholder_id: &744 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -97015,7 +97099,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &658 + - &659 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -97064,7 +97148,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &659 + - &660 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -97192,7 +97276,7 @@ paths: - performed_via_github_app - assignee - assigner - - &660 + - &661 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -97238,7 +97322,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &661 + - &662 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -97284,7 +97368,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &662 + - &663 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -97333,7 +97417,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &663 + - &664 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -97375,7 +97459,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &664 + - &665 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -97417,7 +97501,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &665 + - &666 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -97473,7 +97557,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &667 title: Locked Issue Event description: Locked Issue Event type: object @@ -97518,7 +97602,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &667 + - &668 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -97579,7 +97663,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &669 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -97640,7 +97724,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &670 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -97701,7 +97785,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &671 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -97825,7 +97909,7 @@ paths: type: array items: *656 examples: - default: &757 + default: &657 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -97857,6 +97941,254 @@ 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: + - *459 + - *460 + - *653 + 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 + examples: + - 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 + examples: + - 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: *656 + examples: + default: *657 + '400': *14 + '403': *27 + '404': *6 + '422': *15 + '503': *192 + 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: + - *459 + - *460 + - *653 + 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 + examples: + - 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 + examples: + - 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: *656 + examples: + default: *657 + '400': *14 + '403': *27 + '404': *6 + '422': *15 + '503': *192 + 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: + - *459 + - *460 + - *653 + - *373 + responses: + '204': + description: Issue field value deleted successfully + '403': *27 + '404': *6 + '422': *15 + '503': *192 + 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 @@ -97882,7 +98214,7 @@ paths: type: array items: *218 examples: - default: &657 + default: &658 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -97965,7 +98297,7 @@ paths: type: array items: *218 examples: - default: *657 + default: *658 '301': *465 '404': *6 '410': *647 @@ -98049,7 +98381,7 @@ paths: type: array items: *218 examples: - default: *657 + default: *658 '301': *465 '404': *6 '410': *647 @@ -98641,7 +98973,6 @@ paths: description: Timeline Event type: object anyOf: - - *658 - *659 - *660 - *661 @@ -98654,6 +98985,7 @@ paths: - *668 - *669 - *670 + - *671 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -98710,7 +99042,7 @@ paths: pin: anyOf: - type: 'null' - - *671 + - *672 required: - event - actor @@ -98986,7 +99318,7 @@ paths: type: string comments: type: array - items: &692 + items: &693 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -99530,7 +99862,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -99635,9 +99967,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: &673 + default: &674 value: id: 1 key: ssh-rsa AAA... @@ -99673,7 +100005,7 @@ paths: parameters: - *459 - *460 - - &674 + - &675 name: key_id description: The unique identifier of the key. in: path @@ -99685,9 +100017,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *673 + default: *674 '404': *6 x-github: githubCloudOnly: false @@ -99707,7 +100039,7 @@ paths: parameters: - *459 - *460 - - *674 + - *675 responses: '204': description: Response @@ -99740,7 +100072,7 @@ paths: type: array items: *218 examples: - default: *657 + default: *658 headers: Link: *45 '404': *6 @@ -99800,7 +100132,7 @@ paths: application/json: schema: *218 examples: - default: &675 + default: &676 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -99846,7 +100178,7 @@ paths: application/json: schema: *218 examples: - default: *675 + default: *676 '404': *6 x-github: githubCloudOnly: false @@ -100301,7 +100633,7 @@ paths: application/json: schema: *573 examples: - default: *676 + default: *677 '204': description: Response when already merged '404': @@ -100467,7 +100799,7 @@ paths: application/json: schema: *408 examples: - default: &677 + default: &678 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -100528,7 +100860,7 @@ paths: parameters: - *459 - *460 - - &678 + - &679 name: milestone_number description: The number that identifies the milestone. in: path @@ -100542,7 +100874,7 @@ paths: application/json: schema: *408 examples: - default: *677 + default: *678 '404': *6 x-github: githubCloudOnly: false @@ -100561,7 +100893,7 @@ paths: parameters: - *459 - *460 - - *678 + - *679 requestBody: required: false content: @@ -100601,7 +100933,7 @@ paths: application/json: schema: *408 examples: - default: *677 + default: *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100619,7 +100951,7 @@ paths: parameters: - *459 - *460 - - *678 + - *679 responses: '204': description: Response @@ -100642,7 +100974,7 @@ paths: parameters: - *459 - *460 - - *678 + - *679 - *17 - *19 responses: @@ -100654,7 +100986,7 @@ paths: type: array items: *218 examples: - default: *657 + default: *658 headers: Link: *45 x-github: @@ -100675,10 +101007,10 @@ paths: parameters: - *459 - *460 - - *679 - *680 - - *224 - *681 + - *224 + - *682 - *17 - *19 responses: @@ -100690,7 +101022,7 @@ paths: type: array items: *244 examples: - default: *682 + default: *683 headers: Link: *45 x-github: @@ -100780,7 +101112,7 @@ paths: description: Response content: application/json: - schema: &683 + schema: &684 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -100924,7 +101256,7 @@ paths: - custom_404 - public examples: - default: &684 + default: &685 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -101021,9 +101353,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *684 examples: - default: *684 + default: *685 '422': *15 '409': *119 x-github: @@ -101193,7 +101525,7 @@ paths: application/json: schema: type: array - items: &685 + items: &686 title: Page Build description: Page Build type: object @@ -101340,9 +101672,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *686 examples: - default: &686 + default: &687 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -101402,9 +101734,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *686 examples: - default: *686 + default: *687 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101535,7 +101867,7 @@ paths: parameters: - *459 - *460 - - &687 + - &688 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -101595,7 +101927,7 @@ paths: parameters: - *459 - *460 - - *687 + - *688 responses: '204': *126 '404': *6 @@ -102012,7 +102344,7 @@ paths: type: array items: *152 examples: - default: *688 + default: *689 '403': *27 '404': *6 x-github: @@ -102051,7 +102383,7 @@ paths: required: - properties examples: - default: *689 + default: *690 responses: '204': description: No Content when custom property values are successfully created @@ -102152,7 +102484,7 @@ paths: type: array items: *577 examples: - default: *690 + default: *691 headers: Link: *45 '304': *35 @@ -102252,7 +102584,7 @@ paths: description: Response content: application/json: - schema: &694 + schema: &695 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -102476,7 +102808,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: *691 + auto_merge: *692 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -102576,7 +102908,7 @@ paths: - merged_by - review_comments examples: - default: &695 + default: &696 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -103113,9 +103445,9 @@ paths: application/json: schema: type: array - items: *692 + items: *693 examples: - default: &697 + default: &698 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -103200,9 +103532,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: &693 + default: &694 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -103301,9 +103633,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: *693 + default: *694 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103506,7 +103838,7 @@ paths: parameters: - *459 - *460 - - &696 + - &697 name: pull_number description: The number that identifies the pull request. in: path @@ -103519,9 +103851,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *694 + schema: *695 examples: - default: *695 + default: *696 '304': *35 '404': *6 '406': @@ -103558,7 +103890,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: false content: @@ -103600,11 +103932,66 @@ paths: description: Response content: application/json: - schema: *694 + schema: *695 examples: - default: *695 + default: *696 + '422': *15 + '403': *27 + 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: + - *459 + - *460 + - *697 + responses: + '204': + description: Response + '403': *27 + '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: + - *459 + - *460 + - *697 + responses: + '204': + description: Response '403': *27 + '404': *6 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103626,7 +104013,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: true content: @@ -103729,7 +104116,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 - *241 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -103750,9 +104137,9 @@ paths: application/json: schema: type: array - items: *692 + items: *693 examples: - default: *697 + default: *698 headers: Link: *45 x-github: @@ -103787,7 +104174,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: true content: @@ -103893,7 +104280,7 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: example-for-a-multi-line-comment: value: @@ -103983,7 +104370,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 - *233 requestBody: required: true @@ -104006,7 +104393,7 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: default: value: @@ -104094,7 +104481,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 - *17 - *19 responses: @@ -104106,7 +104493,7 @@ paths: type: array items: *573 examples: - default: *698 + default: *699 headers: Link: *45 x-github: @@ -104138,7 +104525,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 - *17 - *19 responses: @@ -104188,7 +104575,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 responses: '204': description: Response if pull request has been merged @@ -104213,7 +104600,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: false content: @@ -104327,7 +104714,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 responses: '200': description: Response @@ -104404,7 +104791,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: false content: @@ -104979,7 +105366,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: true content: @@ -105500,7 +105887,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 - *17 - *19 responses: @@ -105510,7 +105897,7 @@ paths: application/json: schema: type: array - items: &699 + items: &700 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -105668,7 +106055,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: false content: @@ -105758,9 +106145,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: &701 + default: &702 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -105825,8 +106212,8 @@ paths: parameters: - *459 - *460 - - *696 - - &700 + - *697 + - &701 name: review_id description: The unique identifier of the review. in: path @@ -105838,9 +106225,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: &702 + default: &703 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -105901,8 +106288,8 @@ paths: parameters: - *459 - *460 - - *696 - - *700 + - *697 + - *701 requestBody: required: true content: @@ -105925,7 +106312,7 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: default: value: @@ -105989,16 +106376,16 @@ paths: parameters: - *459 - *460 - - *696 - - *700 + - *697 + - *701 responses: '200': description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: *701 + default: *702 '422': *7 '404': *6 x-github: @@ -106027,8 +106414,8 @@ paths: parameters: - *459 - *460 - - *696 - - *700 + - *697 + - *701 - *17 - *19 responses: @@ -106288,8 +106675,8 @@ paths: parameters: - *459 - *460 - - *696 - - *700 + - *697 + - *701 requestBody: required: true content: @@ -106318,7 +106705,7 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: default: value: @@ -106383,8 +106770,8 @@ paths: parameters: - *459 - *460 - - *696 - - *700 + - *697 + - *701 requestBody: required: true content: @@ -106419,9 +106806,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: *702 + default: *703 '404': *6 '422': *7 '403': *27 @@ -106445,7 +106832,7 @@ paths: parameters: - *459 - *460 - - *696 + - *697 requestBody: required: false content: @@ -106523,9 +106910,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *704 examples: - default: &704 + default: &705 value: type: file encoding: base64 @@ -106588,9 +106975,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *704 examples: - default: *704 + default: *705 '404': *6 '422': *15 x-github: @@ -106623,7 +107010,7 @@ paths: application/json: schema: type: array - items: *705 + items: *706 examples: default: value: @@ -106794,9 +107181,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: &709 + default: &710 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -106903,7 +107290,7 @@ paths: parameters: - *459 - *460 - - &707 + - &708 name: asset_id description: The unique identifier of the asset. in: path @@ -106915,9 +107302,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: &708 + default: &709 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 @@ -106970,7 +107357,7 @@ paths: parameters: - *459 - *460 - - *707 + - *708 requestBody: required: false content: @@ -106999,9 +107386,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *708 + default: *709 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107019,7 +107406,7 @@ paths: parameters: - *459 - *460 - - *707 + - *708 responses: '204': description: Response @@ -107138,9 +107525,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: *709 + default: *710 '404': *6 x-github: githubCloudOnly: false @@ -107172,9 +107559,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: *709 + default: *710 '404': *6 x-github: githubCloudOnly: false @@ -107198,7 +107585,7 @@ paths: parameters: - *459 - *460 - - &710 + - &711 name: release_id description: The unique identifier of the release. in: path @@ -107212,9 +107599,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: *705 + schema: *706 examples: - default: *709 + default: *710 '401': description: Unauthorized x-github: @@ -107234,7 +107621,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 requestBody: required: false content: @@ -107298,9 +107685,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *706 examples: - default: *709 + default: *710 '404': description: Not Found if the discussion category name is invalid content: @@ -107323,7 +107710,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 responses: '204': description: Response @@ -107346,7 +107733,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 - *17 - *19 responses: @@ -107356,7 +107743,7 @@ paths: application/json: schema: type: array - items: *706 + items: *707 examples: default: value: @@ -107440,7 +107827,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 - name: name in: query required: true @@ -107466,7 +107853,7 @@ paths: description: Response for successful upload content: application/json: - schema: *706 + schema: *707 examples: response-for-successful-upload: value: @@ -107523,7 +107910,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 - 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. @@ -107572,7 +107959,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 requestBody: required: true content: @@ -107635,7 +108022,7 @@ paths: parameters: - *459 - *460 - - *710 + - *711 - *650 responses: '204': @@ -107679,7 +108066,7 @@ paths: oneOf: - allOf: - *166 - - &711 + - &712 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -107700,67 +108087,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *167 - - *711 + - *712 - allOf: - *168 - - *711 + - *712 - allOf: - *169 - - *711 + - *712 - allOf: + - *713 - *712 - - *711 - allOf: - *170 - - *711 + - *712 - allOf: - *171 - - *711 + - *712 - allOf: - *172 - - *711 + - *712 - allOf: - *173 - - *711 + - *712 - allOf: - *174 - - *711 + - *712 - allOf: - *175 - - *711 + - *712 - allOf: - *176 - - *711 + - *712 - allOf: - *177 - - *711 + - *712 - allOf: - *178 - - *711 + - *712 - allOf: - *179 - - *711 + - *712 - allOf: - *180 - - *711 + - *712 - allOf: - *181 - - *711 + - *712 - allOf: - *182 - - *711 + - *712 - allOf: - *183 - - *711 + - *712 - allOf: - *184 - - *711 + - *712 - allOf: - *185 - - *711 + - *712 - allOf: - *186 - - *711 + - *712 examples: default: value: @@ -107811,7 +108198,7 @@ paths: schema: type: boolean default: true - - *713 + - *714 responses: '200': description: Response @@ -107896,7 +108283,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *714 + items: *715 required: - name - enforcement @@ -107929,7 +108316,7 @@ paths: application/json: schema: *187 examples: - default: &723 + default: &724 value: id: 42 name: super cool ruleset @@ -107979,10 +108366,10 @@ paths: parameters: - *459 - *460 - - *715 - - *105 - *716 + - *105 - *717 + - *718 - *17 - *19 responses: @@ -107990,9 +108377,9 @@ paths: description: Response content: application/json: - schema: *718 + schema: *719 examples: - default: *719 + default: *720 '404': *6 '500': *38 x-github: @@ -108015,15 +108402,15 @@ paths: parameters: - *459 - *460 - - *720 + - *721 responses: '200': description: Response content: application/json: - schema: *721 + schema: *722 examples: - default: *722 + default: *723 '404': *6 '500': *38 x-github: @@ -108074,7 +108461,7 @@ paths: application/json: schema: *187 examples: - default: *723 + default: *724 '404': *6 '500': *38 put: @@ -108127,7 +108514,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *714 + items: *715 examples: default: value: @@ -108157,7 +108544,7 @@ paths: application/json: schema: *187 examples: - default: *723 + default: *724 '404': *6 '422': *15 '500': *38 @@ -108325,8 +108712,8 @@ paths: - *110 - *19 - *17 - - *724 - *725 + - *726 - *435 - *436 - *437 @@ -108338,7 +108725,7 @@ paths: application/json: schema: type: array - items: &729 + items: &730 type: object properties: number: *127 @@ -108354,8 +108741,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *726 - resolution: *727 + state: *727 + resolution: *728 resolved_at: type: - string @@ -108461,7 +108848,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *728 + - *729 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -108629,7 +109016,7 @@ paths: description: Response content: application/json: - schema: *729 + schema: *730 examples: default: value: @@ -108693,8 +109080,8 @@ paths: schema: type: object properties: - state: *726 - resolution: *727 + state: *727 + resolution: *728 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -108732,7 +109119,7 @@ paths: description: Response content: application/json: - schema: *729 + schema: *730 examples: default: value: @@ -108867,7 +109254,6 @@ paths: - commit details: oneOf: - - *730 - *731 - *732 - *733 @@ -108880,6 +109266,7 @@ paths: - *740 - *741 - *742 + - *743 examples: default: value: @@ -108974,14 +109361,14 @@ paths: schema: type: object properties: - reason: &744 + reason: &745 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *743 + placeholder_id: *744 required: - reason - placeholder_id @@ -108998,7 +109385,7 @@ paths: schema: type: object properties: - reason: *744 + reason: *745 expire_at: type: - string @@ -109061,7 +109448,7 @@ paths: properties: incremental_scans: type: array - items: &745 + items: &746 description: Information on a single scan performed by secret scanning on the repository type: object @@ -109089,15 +109476,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *745 + items: *746 backfill_scans: type: array - items: *745 + items: *746 custom_pattern_backfill_scans: type: array items: allOf: - - *745 + - *746 - type: object properties: pattern_name: @@ -109110,7 +109497,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *745 + items: *746 examples: default: value: @@ -109220,9 +109607,9 @@ paths: application/json: schema: type: array - items: *746 + items: *747 examples: - default: *747 + default: *748 '400': *14 '404': *6 x-github: @@ -109416,9 +109803,9 @@ paths: description: Response content: application/json: - schema: *746 + schema: *747 examples: - default: &749 + default: &750 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -109762,7 +110149,7 @@ paths: description: Response content: application/json: - schema: *746 + schema: *747 examples: default: value: @@ -109910,15 +110297,15 @@ paths: parameters: - *459 - *460 - - *748 + - *749 responses: '200': description: Response content: application/json: - schema: *746 + schema: *747 examples: - default: *749 + default: *750 '403': *27 '404': *6 x-github: @@ -109944,7 +110331,7 @@ paths: parameters: - *459 - *460 - - *748 + - *749 requestBody: required: true content: @@ -110115,10 +110502,10 @@ paths: description: Response content: application/json: - schema: *746 + schema: *747 examples: - default: *749 - add_credit: *749 + default: *750 + add_credit: *750 '403': *27 '404': *6 '422': @@ -110158,7 +110545,7 @@ paths: parameters: - *459 - *460 - - *748 + - *749 responses: '202': *37 '400': *14 @@ -110187,7 +110574,7 @@ paths: parameters: - *459 - *460 - - *748 + - *749 responses: '202': description: Response @@ -110328,7 +110715,7 @@ paths: application/json: schema: type: array - items: &750 + items: &751 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -110701,7 +111088,7 @@ paths: application/json: schema: type: array - items: *750 + items: *751 examples: default: value: @@ -110791,7 +111178,7 @@ paths: description: Response content: application/json: - schema: *751 + schema: *752 examples: default: value: @@ -110885,7 +111272,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &752 + schema: &753 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -110985,7 +111372,7 @@ paths: description: Response content: application/json: - schema: *752 + schema: *753 examples: default: value: @@ -111195,7 +111582,7 @@ paths: description: Response content: application/json: - schema: &753 + schema: &754 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -111207,7 +111594,7 @@ paths: required: - names examples: - default: &754 + default: &755 value: names: - octocat @@ -111262,9 +111649,9 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: *754 + default: *755 '404': *6 '422': *7 x-github: @@ -111287,7 +111674,7 @@ paths: parameters: - *459 - *460 - - &755 + - &756 name: per description: The time frame to display results for. in: query @@ -111318,7 +111705,7 @@ paths: - 128 clones: type: array - items: &756 + items: &757 title: Traffic type: object properties: @@ -111566,7 +111953,7 @@ paths: parameters: - *459 - *460 - - *755 + - *756 responses: '200': description: Response @@ -111587,7 +111974,7 @@ paths: - 3782 views: type: array - items: *756 + items: *757 required: - uniques - count @@ -112230,252 +112617,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: - - *272 - - *653 - 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 - examples: - - 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 - examples: - - 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: *656 - examples: - default: *757 - '400': *14 - '403': *27 - '404': *6 - '422': *15 - '503': *192 - 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: - - *272 - - *653 - 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 - examples: - - 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 - examples: - - 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: *656 - examples: - default: *757 - '400': *14 - '403': *27 - '404': *6 - '422': *15 - '503': *192 - 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: - - *272 - - *653 - - *373 - responses: - '204': - description: Issue field value deleted successfully - '403': *27 - '404': *6 - '422': *15 - '503': *192 - 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 @@ -121677,7 +121818,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: - - *674 + - *675 responses: '200': description: Response @@ -121708,7 +121849,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: - - *674 + - *675 responses: '204': description: Response @@ -138972,7 +139113,7 @@ webhooks: - *601 pull_requests: type: array - items: *694 + items: *695 repository: *848 organization: *847 installation: *846 @@ -148134,7 +148275,7 @@ webhooks: pin: anyOf: - type: 'null' - - *671 + - *672 user: title: User type: @@ -149633,7 +149774,7 @@ webhooks: pin: anyOf: - type: 'null' - - *671 + - *672 required: - url - html_url @@ -187917,7 +188058,7 @@ webhooks: organization: *847 pull_request: &898 allOf: - - *694 + - *695 - type: object properties: allow_auto_merge: @@ -243694,7 +243835,7 @@ webhooks: installation: *846 organization: *847 repository: *848 - repository_advisory: *746 + repository_advisory: *747 sender: *4 required: - action @@ -243774,7 +243915,7 @@ webhooks: installation: *846 organization: *847 repository: *848 - repository_advisory: *746 + repository_advisory: *747 sender: *4 required: - action @@ -244865,16 +245006,16 @@ webhooks: properties: added: type: array - items: *714 + items: *715 deleted: type: array - items: *714 + items: *715 updated: type: array items: type: object properties: - rule: *714 + rule: *715 changes: type: object properties: diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index b4515ffb60..6806d6bf02 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -22634,6 +22634,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" @@ -22644,6 +22653,10 @@ "string", "null" ] + }, + "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" } } }, @@ -141625,6 +141638,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" @@ -141635,6 +141657,10 @@ "string", "null" ] + }, + "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" } } }, @@ -252109,7 +252135,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -252182,6 +252209,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" @@ -252334,7 +252373,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" ], @@ -252425,14 +252464,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": { @@ -252468,12 +252508,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": [ @@ -252520,6 +252572,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" + } } } } @@ -252570,7 +252634,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -252647,6 +252712,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" @@ -252985,7 +253062,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -253058,6 +253136,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" @@ -253126,7 +253216,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" ], @@ -253233,7 +253323,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -253269,12 +253360,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" } } }, @@ -582069,275 +582172,1485 @@ "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", - "examples": [ - 208045946 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDU6TGFiZWwyMDgwNDU5NDY=" - ] - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/labels/bug" - ] - }, - "name": { - "description": "The name of the label.", - "type": "string", - "examples": [ - "bug" - ] - }, - "description": { - "description": "Optional description of the label, such as its purpose.", - "type": [ - "string", - "null" - ], - "examples": [ - "Something isn't working" - ] - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string", - "examples": [ - "FFFFFF" - ] - }, - "default": { - "description": "Whether this label comes by default in a new repository.", - "type": "boolean", - "examples": [ - 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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "examples": [ + 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", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "examples": [ + 208045946 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDU6TGFiZWwyMDgwNDU5NDY=" + ] + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/labels/bug" + ] + }, + "name": { + "description": "The name of the label.", + "type": "string", + "examples": [ + "bug" + ] + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": [ + "string", + "null" + ], + "examples": [ + "Something isn't working" + ] + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string", + "examples": [ + "FFFFFF" + ] + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "examples": [ + 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": [ { @@ -660678,6 +661991,366 @@ } } }, + "/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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", @@ -740064,1191 +741737,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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "examples": [ - 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", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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": {"code":"deadline_exceeded","msg":"operation timed out"}