diff options
Diffstat (limited to 'descriptions/api.github.com')
8 files changed, 76 insertions, 116 deletions
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 f538052ea..b9b2b60ac 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 @@ -19592,7 +19592,7 @@ "/orgs/{org}/private-registries": { "get": { "summary": "List private registries for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -19664,7 +19664,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\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).\"\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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -19796,7 +19796,7 @@ "/orgs/{org}/private-registries/public-key": { "get": { "summary": "Get private registries public key for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -19862,7 +19862,7 @@ "/orgs/{org}/private-registries/{secret_name}": { "get": { "summary": "Get a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -19908,7 +19908,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\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).\"\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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -20003,7 +20003,7 @@ }, "delete": { "summary": "Delete a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -35555,7 +35555,7 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { "post": { "summary": "Rerequest a check run", - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], @@ -269058,6 +269058,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", @@ -299334,7 +299335,7 @@ "secret-scanning-alert-secret-type": { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" 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 be21a6101..8676a6ff9 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 @@ -14216,9 +14216,7 @@ paths: "/orgs/{org}/private-registries": get: summary: List private registries for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Lists all private registry configurations available at the organization-level without revealing their encrypted values. @@ -14268,9 +14266,7 @@ paths: subcategory: organization-configurations post: summary: Create a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + 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)." @@ -14383,9 +14379,7 @@ paths: "/orgs/{org}/private-registries/public-key": get: summary: Get private registries public key for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. @@ -14433,9 +14427,7 @@ paths: "/orgs/{org}/private-registries/{secret_name}": get: summary: Get a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Get the configuration of a single private registry defined for an organization, omitting its encrypted value. @@ -14468,9 +14460,7 @@ paths: subcategory: organization-configurations patch: summary: Update a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + 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)." @@ -14550,9 +14540,7 @@ paths: subcategory: organization-configurations delete: summary: Delete a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Delete a private registry configuration at the organization-level. @@ -25852,7 +25840,7 @@ paths: post: summary: Rerequest a check run description: |- - Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". @@ -201100,6 +201088,7 @@ components: cookie: https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8 cool: https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8 cop: https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 + copilot: https://github.githubassets.com/images/icons/emoji/copilot.png?v8 copyright: https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8 corn: https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8 costa_rica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8 @@ -227424,7 +227413,7 @@ components: in: query description: A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) - in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index f538052ea..b9b2b60ac 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -19592,7 +19592,7 @@ "/orgs/{org}/private-registries": { "get": { "summary": "List private registries for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -19664,7 +19664,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\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).\"\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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -19796,7 +19796,7 @@ "/orgs/{org}/private-registries/public-key": { "get": { "summary": "Get private registries public key for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -19862,7 +19862,7 @@ "/orgs/{org}/private-registries/{secret_name}": { "get": { "summary": "Get a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -19908,7 +19908,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\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).\"\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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -20003,7 +20003,7 @@ }, "delete": { "summary": "Delete a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -35555,7 +35555,7 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { "post": { "summary": "Rerequest a check run", - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], @@ -269058,6 +269058,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", @@ -299334,7 +299335,7 @@ "secret-scanning-alert-secret-type": { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index be21a6101..8676a6ff9 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -14216,9 +14216,7 @@ paths: "/orgs/{org}/private-registries": get: summary: List private registries for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Lists all private registry configurations available at the organization-level without revealing their encrypted values. @@ -14268,9 +14266,7 @@ paths: subcategory: organization-configurations post: summary: Create a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + 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)." @@ -14383,9 +14379,7 @@ paths: "/orgs/{org}/private-registries/public-key": get: summary: Get private registries public key for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. @@ -14433,9 +14427,7 @@ paths: "/orgs/{org}/private-registries/{secret_name}": get: summary: Get a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Get the configuration of a single private registry defined for an organization, omitting its encrypted value. @@ -14468,9 +14460,7 @@ paths: subcategory: organization-configurations patch: summary: Update a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + 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)." @@ -14550,9 +14540,7 @@ paths: subcategory: organization-configurations delete: summary: Delete a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Delete a private registry configuration at the organization-level. @@ -25852,7 +25840,7 @@ paths: post: summary: Rerequest a check run description: |- - Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". @@ -201100,6 +201088,7 @@ components: cookie: https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8 cool: https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8 cop: https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 + copilot: https://github.githubassets.com/images/icons/emoji/copilot.png?v8 copyright: https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8 corn: https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8 costa_rica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8 @@ -227424,7 +227413,7 @@ components: in: query description: A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) - in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: 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 5838daccd..bc75ff26f 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 @@ -14646,6 +14646,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", @@ -21877,7 +21878,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -117624,7 +117625,7 @@ "/orgs/{org}/private-registries": { "get": { "summary": "List private registries for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -117855,7 +117856,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\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).\"\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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -118152,7 +118153,7 @@ "/orgs/{org}/private-registries/public-key": { "get": { "summary": "Get private registries public key for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -118253,7 +118254,7 @@ "/orgs/{org}/private-registries/{secret_name}": { "get": { "summary": "Get a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -118387,7 +118388,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\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).\"\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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -118583,7 +118584,7 @@ }, "delete": { "summary": "Delete a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -135408,7 +135409,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -215520,7 +215521,7 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { "post": { "summary": "Rerequest a check run", - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], @@ -419202,7 +419203,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" 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 b2cef57f9..ff1d17fbd 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 @@ -5420,6 +5420,7 @@ paths: cookie: https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8 cool: https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8 cop: https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 + copilot: https://github.githubassets.com/images/icons/emoji/copilot.png?v8 copyright: https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8 corn: https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8 costa_rica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8 @@ -9240,7 +9241,7 @@ paths: in: query description: A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token - name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: @@ -31627,9 +31628,7 @@ paths: "/orgs/{org}/private-registries": get: summary: List private registries for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Lists all private registry configurations available at the organization-level without revealing their encrypted values. @@ -31722,9 +31721,7 @@ paths: subcategory: organization-configurations post: summary: Create a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + 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)." @@ -31895,9 +31892,7 @@ paths: "/orgs/{org}/private-registries/public-key": get: summary: Get private registries public key for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. @@ -31945,9 +31940,7 @@ paths: "/orgs/{org}/private-registries/{secret_name}": get: summary: Get a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Get the configuration of a single private registry defined for an organization, omitting its encrypted value. @@ -31977,9 +31970,7 @@ paths: subcategory: organization-configurations patch: summary: Update a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + 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)." @@ -32057,9 +32048,7 @@ paths: subcategory: organization-configurations delete: summary: Delete a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Delete a private registry configuration at the organization-level. @@ -53288,7 +53277,7 @@ paths: post: summary: Rerequest a check run description: |- - Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". 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 5838daccd..bc75ff26f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -14646,6 +14646,7 @@ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", @@ -21877,7 +21878,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -117624,7 +117625,7 @@ "/orgs/{org}/private-registries": { "get": { "summary": "List private registries for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -117855,7 +117856,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\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).\"\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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -118152,7 +118153,7 @@ "/orgs/{org}/private-registries/public-key": { "get": { "summary": "Get private registries public key for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -118253,7 +118254,7 @@ "/orgs/{org}/private-registries/{secret_name}": { "get": { "summary": "Get a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -118387,7 +118388,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\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).\"\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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -118583,7 +118584,7 @@ }, "delete": { "summary": "Delete a private registry for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -135408,7 +135409,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -215520,7 +215521,7 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { "post": { "summary": "Rerequest a check run", - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], @@ -419202,7 +419203,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" 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 b2cef57f9..ff1d17fbd 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -5420,6 +5420,7 @@ paths: cookie: https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8 cool: https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8 cop: https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 + copilot: https://github.githubassets.com/images/icons/emoji/copilot.png?v8 copyright: https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8 corn: https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8 costa_rica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8 @@ -9240,7 +9241,7 @@ paths: in: query description: A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token - name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: @@ -31627,9 +31628,7 @@ paths: "/orgs/{org}/private-registries": get: summary: List private registries for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Lists all private registry configurations available at the organization-level without revealing their encrypted values. @@ -31722,9 +31721,7 @@ paths: subcategory: organization-configurations post: summary: Create a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + 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)." @@ -31895,9 +31892,7 @@ paths: "/orgs/{org}/private-registries/public-key": get: summary: Get private registries public key for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. @@ -31945,9 +31940,7 @@ paths: "/orgs/{org}/private-registries/{secret_name}": get: summary: Get a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Get the configuration of a single private registry defined for an organization, omitting its encrypted value. @@ -31977,9 +31970,7 @@ paths: subcategory: organization-configurations patch: summary: Update a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + 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)." @@ -32057,9 +32048,7 @@ paths: subcategory: organization-configurations delete: summary: Delete a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Delete a private registry configuration at the organization-level. @@ -53288,7 +53277,7 @@ paths: post: summary: Rerequest a check run description: |- - Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". |