diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 39344d004f..50997cfb6b 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -10218,6 +10218,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -10226,6 +10235,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -26163,7 +26176,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26246,14 +26259,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26289,12 +26303,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -26341,6 +26367,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -26495,7 +26533,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26588,7 +26626,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26624,12 +26663,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -59967,6 +60018,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", @@ -118024,7 +118163,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -118093,6 +118233,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -118148,7 +118300,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -118223,6 +118376,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 5d8a0c68b0..9026140be6 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -7332,6 +7332,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -7342,6 +7351,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -19044,7 +19058,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19136,8 +19150,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -19145,6 +19159,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19176,13 +19191,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -19221,6 +19248,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -19329,7 +19366,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19426,6 +19463,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19457,13 +19495,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -43651,6 +43701,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 @@ -86409,6 +86520,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86465,6 +86577,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -86513,6 +86634,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86575,6 +86697,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index 3cc0a2852c..8daf568db0 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/api.github.com/api.github.com.2026-03-10.json @@ -10217,6 +10217,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -10225,6 +10234,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -26122,7 +26135,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26205,14 +26218,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26248,12 +26262,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -26300,6 +26326,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -26454,7 +26492,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26547,7 +26585,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26583,12 +26622,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -59884,6 +59935,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", @@ -117525,7 +117664,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -117594,6 +117734,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -117649,7 +117801,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -117724,6 +117877,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index c059b19cff..7feed554a5 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/api.github.com/api.github.com.2026-03-10.yaml @@ -7330,6 +7330,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -7340,6 +7349,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -19013,7 +19027,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19105,8 +19119,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -19114,6 +19128,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19145,13 +19160,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -19190,6 +19217,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -19298,7 +19335,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19395,6 +19432,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19426,13 +19464,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -43580,6 +43630,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 @@ -86016,6 +86127,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86072,6 +86184,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -86120,6 +86241,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86182,6 +86304,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index bad14541f6..19e576b858 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -10264,6 +10264,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -10272,6 +10281,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -26342,7 +26355,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26425,14 +26438,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26468,12 +26482,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -26520,6 +26546,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -26674,7 +26712,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -26767,7 +26805,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -26803,12 +26842,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -60269,6 +60320,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", @@ -118801,7 +118940,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -118870,6 +119010,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -118925,7 +119077,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -119000,6 +119153,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index cd14a5fbf3..fa45359723 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -7357,6 +7357,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -7367,6 +7376,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -19139,7 +19153,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19231,8 +19245,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -19240,6 +19254,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19271,13 +19286,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -19316,6 +19343,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -19424,7 +19461,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -19521,6 +19558,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -19552,13 +19590,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -43836,6 +43886,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 @@ -86914,6 +87025,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -86970,6 +87082,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -87018,6 +87139,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -87080,6 +87202,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index fe7bdee7c5..fdb683c2af 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -76753,6 +76753,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -76761,6 +76770,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -162607,7 +162620,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -162676,6 +162690,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -162820,7 +162846,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -162909,14 +162935,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -162952,12 +162979,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -163004,6 +163043,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -163052,7 +163103,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -163127,6 +163179,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -163453,7 +163517,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -163522,6 +163587,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -163590,7 +163667,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -163695,7 +163772,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -163731,12 +163809,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -489652,6 +489742,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index b097f3bb4f..474b11efca 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -20935,6 +20935,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -20945,6 +20954,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -38991,6 +39005,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39050,6 +39065,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -39087,7 +39111,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -39179,8 +39203,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -39188,6 +39212,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -39219,13 +39244,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -39264,6 +39301,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -39305,6 +39352,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39370,6 +39418,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -39493,7 +39550,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -39590,6 +39647,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -39621,13 +39679,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -87999,6 +88069,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: + - *342 + - *343 + - *597 + responses: + '204': + description: Response + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *342 + - *343 + - *597 + responses: + '204': + description: Response + '403': *29 + '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 diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 1c04ebcd57..6c4f876b70 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -73444,6 +73444,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -73452,6 +73461,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -157387,7 +157400,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -157456,6 +157470,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -157600,7 +157626,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -157689,14 +157715,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -157732,12 +157759,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -157784,6 +157823,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -157832,7 +157883,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -157907,6 +157959,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -158233,7 +158297,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -158302,6 +158367,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -158370,7 +158447,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -158475,7 +158552,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -158511,12 +158589,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -479353,6 +479443,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index dbd202eb49..28e58f3760 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -20620,6 +20620,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -20630,6 +20639,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -38643,6 +38657,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -38702,6 +38717,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -38739,7 +38763,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -38831,8 +38855,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -38840,6 +38864,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -38871,13 +38896,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -38916,6 +38953,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -38957,6 +39004,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39022,6 +39070,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -39145,7 +39202,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -39242,6 +39299,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -39273,13 +39331,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -87483,6 +87553,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: + - *342 + - *343 + - *597 + responses: + '204': + description: Response + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *342 + - *343 + - *597 + responses: + '204': + description: Response + '403': *29 + '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 diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 79f1f0c12c..ba373c7f68 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -78364,6 +78364,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -78372,6 +78381,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -167604,7 +167617,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -167673,6 +167687,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -167817,7 +167843,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -167906,14 +167932,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -167949,12 +167976,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -168001,6 +168040,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -168049,7 +168100,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -168124,6 +168176,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -168450,7 +168514,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -168519,6 +168584,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -168587,7 +168664,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -168692,7 +168769,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -168728,12 +168806,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -502829,6 +502919,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 5412b156b0..233221dc50 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -21228,6 +21228,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -21238,6 +21247,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -39363,6 +39377,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39422,6 +39437,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -39459,7 +39483,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -39551,8 +39575,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -39560,6 +39584,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -39591,13 +39616,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -39636,6 +39673,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -39677,6 +39724,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -39742,6 +39790,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -39865,7 +39922,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -39962,6 +40019,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -39993,13 +40051,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -88822,6 +88892,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: + - *344 + - *345 + - *600 + responses: + '204': + description: Response + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *344 + - *345 + - *600 + responses: + '204': + description: Response + '403': *29 + '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 diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 2fdceb5aa2..334b493365 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -20231,6 +20231,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20239,6 +20248,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -123479,6 +123492,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -123487,6 +123509,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -216827,7 +216853,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -216896,6 +216923,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -217040,7 +217079,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -217129,14 +217168,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -217172,12 +217212,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -217224,6 +217276,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -217272,7 +217336,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -217347,6 +217412,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -217673,7 +217750,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -217742,6 +217820,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -217810,7 +217900,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -217915,7 +218005,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -217951,12 +218042,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -551411,6 +551514,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 39f68d681f..06ae882c74 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -8706,6 +8706,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -8716,6 +8725,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -35392,6 +35406,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -35402,6 +35425,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -53743,6 +53771,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -53802,6 +53831,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -53839,7 +53877,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -53931,8 +53969,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -53940,6 +53978,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -53971,13 +54010,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -54016,6 +54067,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -54057,6 +54118,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -54122,6 +54184,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -54245,7 +54316,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -54342,6 +54413,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -54373,13 +54445,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -101906,6 +101990,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/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - *478 + - *479 + - *725 + responses: + '204': + description: Response + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *478 + - *479 + - *725 + responses: + '204': + description: Response + '403': *29 + '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 diff --git a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json index 8ff4c39053..d13309c61e 100644 --- a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -20150,6 +20150,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20158,6 +20167,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -119935,6 +119948,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -119943,6 +119965,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -211360,7 +211386,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -211429,6 +211456,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -211573,7 +211612,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -211662,14 +211701,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -211705,12 +211745,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -211757,6 +211809,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -211805,7 +211869,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -211880,6 +211945,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -212206,7 +212283,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -212275,6 +212353,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -212343,7 +212433,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -212448,7 +212538,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -212484,12 +212575,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -540865,6 +540968,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", diff --git a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml index 9c09cfde50..3b5f13aaa7 100644 --- a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml @@ -8658,6 +8658,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -8668,6 +8677,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -34997,6 +35011,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -35007,6 +35030,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -53384,6 +53412,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -53443,6 +53472,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -53480,7 +53518,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -53572,8 +53610,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -53581,6 +53619,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -53612,13 +53651,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -53657,6 +53708,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -53698,6 +53759,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -53763,6 +53825,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -53886,7 +53957,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -53983,6 +54054,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -54014,13 +54086,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -101379,6 +101463,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/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - *478 + - *479 + - *725 + responses: + '204': + description: Response + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *478 + - *479 + - *725 + responses: + '204': + description: Response + '403': *29 + '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 diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 29ebeaca83..2564b7d92a 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -20472,6 +20472,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20480,6 +20489,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -125338,6 +125351,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -125346,6 +125368,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -222072,7 +222098,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -222141,6 +222168,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -222285,7 +222324,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -222374,14 +222413,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -222417,12 +222457,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -222469,6 +222521,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -222517,7 +222581,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -222592,6 +222657,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -222918,7 +222995,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -222987,6 +223065,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -223055,7 +223145,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -223160,7 +223250,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -223196,12 +223287,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -564836,6 +564939,354 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 5669a6a467..c72ccb638b 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -8860,6 +8860,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -8870,6 +8879,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -35698,6 +35712,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -35708,6 +35731,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -54128,6 +54156,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -54187,6 +54216,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -54224,7 +54262,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -54316,8 +54354,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -54325,6 +54363,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -54356,13 +54395,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -54401,6 +54452,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -54442,6 +54503,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -54507,6 +54569,15 @@ paths: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -54630,7 +54701,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -54727,6 +54798,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -54758,13 +54830,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -102742,6 +102826,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/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - *480 + - *481 + - *728 + responses: + '204': + description: Response + '403': *29 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - *480 + - *481 + - *728 + responses: + '204': + description: Response + '403': *29 + '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 diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index c62fa2897f..c2563ccaee 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -3434,6 +3434,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -3442,6 +3451,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -20765,6 +20778,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20773,6 +20795,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -38329,7 +38355,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38412,14 +38438,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38455,12 +38482,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -38507,6 +38546,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -38661,7 +38712,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38754,7 +38805,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38790,12 +38842,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -74014,6 +74078,94 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -142213,7 +142365,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -142282,6 +142435,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -142337,7 +142502,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -142412,6 +142578,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index f1b3075481..5dcbe1623c 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -2416,6 +2416,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -2426,6 +2435,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -14902,6 +14916,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -14912,6 +14935,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -27787,7 +27815,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -27879,8 +27907,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -27888,6 +27916,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -27919,13 +27948,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -27964,6 +28005,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -28072,7 +28123,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -28169,6 +28220,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -28200,13 +28252,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -53713,6 +53777,67 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -104038,6 +104163,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -104094,6 +104220,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -104142,6 +104277,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -104204,6 +104340,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time diff --git a/descriptions/ghec/ghec.2026-03-10.json b/descriptions/ghec/ghec.2026-03-10.json index bf078783cb..7460983d96 100644 --- a/descriptions/ghec/ghec.2026-03-10.json +++ b/descriptions/ghec/ghec.2026-03-10.json @@ -3434,6 +3434,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -3442,6 +3451,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -20746,6 +20759,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20754,6 +20776,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -38270,7 +38296,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38353,14 +38379,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38396,12 +38423,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -38448,6 +38487,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -38602,7 +38653,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38695,7 +38746,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38731,12 +38783,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -73913,6 +73977,94 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -141696,7 +141848,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -141765,6 +141918,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -141820,7 +141985,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -141895,6 +142061,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/ghec/ghec.2026-03-10.yaml b/descriptions/ghec/ghec.2026-03-10.yaml index ae492d5fbd..0442a01aca 100644 --- a/descriptions/ghec/ghec.2026-03-10.yaml +++ b/descriptions/ghec/ghec.2026-03-10.yaml @@ -2416,6 +2416,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -2426,6 +2435,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -14888,6 +14902,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -14898,6 +14921,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -27744,7 +27772,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -27836,8 +27864,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -27845,6 +27873,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -27876,13 +27905,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -27921,6 +27962,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -28029,7 +28080,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -28126,6 +28177,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -28157,13 +28209,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -53630,6 +53694,67 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -103633,6 +103758,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -103689,6 +103815,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time @@ -103737,6 +103872,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -103799,6 +103935,15 @@ components: identity_mapping_name: description: The JFrog identity mapping name. type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string created_at: type: string format: date-time diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 76f141fb59..cb62645554 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -3448,6 +3448,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -3456,6 +3465,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -20837,6 +20850,15 @@ "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, + "image_source": { + "description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, "image_id": { "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", "type": "string" @@ -20845,6 +20867,10 @@ "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true + }, + "image_gen": { + "description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.", + "type": "boolean" } } }, @@ -38534,7 +38560,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38617,14 +38643,15 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", "type": "string", "enum": [ "token", "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38660,12 +38687,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } }, "required": [ @@ -38712,6 +38751,18 @@ "tenant_id": "12345678-1234-1234-1234-123456789012", "client_id": "abcdef01-2345-6789-abcd-ef0123456789" } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } } } } @@ -38866,7 +38917,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -38959,7 +39010,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ] }, "tenant_id": { @@ -38995,12 +39047,24 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" } } }, @@ -74342,6 +74406,94 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { + "put": { + "summary": "Archive a pull request", + "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", + "tags": [ + "pulls" + ], + "operationId": "pulls/archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "delete": { + "summary": "Unarchive a pull request", + "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", + "tags": [ + "pulls" + ], + "operationId": "pulls/unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -143016,7 +143168,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -143085,6 +143238,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -143140,7 +143305,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -143215,6 +143381,18 @@ "description": "The JFrog identity mapping name.", "type": "string" }, + "namespace": { + "description": "The Cloudsmith organization namespace.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host.", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 3672c0926b..b691b73f9b 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -2424,6 +2424,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -2434,6 +2443,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -14941,6 +14955,15 @@ paths: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string + image_source: + description: The source type of the runner image to use. Must match + the source of the image specified by `image_id`. Can be one of + `github`, `partner`, or `custom`. + type: string + enum: + - github + - partner + - custom image_id: description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, @@ -14951,6 +14974,11 @@ paths: relevant only for runners using custom images. type: string nullable: true + image_gen: + description: Whether to enable image generation for this runner + pool. When enabled, the runner pool is used to build and publish + custom runner images. + type: boolean examples: default: value: @@ -27896,7 +27924,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -27988,8 +28016,8 @@ paths: type: integer auth_type: description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, + or `oidc_cloudsmith` for OIDC authentication. type: string enum: - token @@ -27997,6 +28025,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -28028,13 +28057,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string required: - registry_type - url @@ -28073,6 +28114,16 @@ paths: visibility: all tenant_id: 12345678-1234-1234-1234-123456789012 client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org responses: '201': description: The organization private registry configuration @@ -28181,7 +28232,7 @@ paths: description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -28278,6 +28329,7 @@ paths: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -28309,13 +28361,25 @@ paths: is `oidc_jfrog`. type: string audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string examples: secret-based-update: summary: Update a secret-based private registry @@ -53912,6 +53976,67 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/archive": + put: + summary: Archive a pull request + description: |- + Archives a pull request. Closes, locks, and marks the pull request as archived. + Only repository admins can archive pull requests. + Archived pull requests are hidden from non-admin users. + tags: + - pulls + operationId: pulls/archive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#archive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + delete: + summary: Unarchive a pull request + description: |- + Unarchives a pull request. Removes the archived flag from the pull request. + Does not automatically reopen or unlock the pull request. + Only repository admins can unarchive pull requests. + tags: + - pulls + operationId: pulls/unarchive + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#unarchive-a-pull-request + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -104557,6 +104682,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -104613,6 +104739,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 @@ -104661,6 +104796,7 @@ components: - oidc_azure - oidc_aws - oidc_jfrog + - oidc_cloudsmith type: string url: description: The URL of the private registry. @@ -104723,6 +104859,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/ghes-3.16/dereferenced/ghes-3.16.2022-11-28.deref.json b/descriptions/ghes-3.16/dereferenced/ghes-3.16.2022-11-28.deref.json index 9e308da84a..73aa247696 100644 --- a/descriptions/ghes-3.16/dereferenced/ghes-3.16.2022-11-28.deref.json +++ b/descriptions/ghes-3.16/dereferenced/ghes-3.16.2022-11-28.deref.json @@ -177960,7 +177960,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -178029,6 +178030,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" @@ -178348,7 +178361,8 @@ "username_password", "oidc_azure", "oidc_aws", - "oidc_jfrog" + "oidc_jfrog", + "oidc_cloudsmith" ], "type": "string" }, @@ -178417,6 +178431,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" @@ -178485,7 +178511,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-server@3.16/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-server@3.16/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based r{"code":"deadline_exceeded","msg":"operation timed out"}