diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index a8fdf85a0a..10e948cd06 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -19666,7 +19666,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" ], @@ -19738,7 +19738,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" ], @@ -19872,7 +19872,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" ], @@ -19942,7 +19942,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" ], @@ -19988,7 +19988,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" ], @@ -20085,7 +20085,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" ], @@ -308383,7 +308383,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-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index d81627f57b..32efc96ccb 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -14251,9 +14251,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. @@ -14303,9 +14301,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)." @@ -14419,9 +14415,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. @@ -14471,9 +14465,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. @@ -14506,9 +14498,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)." @@ -14589,9 +14579,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. @@ -230906,7 +230894,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-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index a8fdf85a0a..10e948cd06 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -19666,7 +19666,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" ], @@ -19738,7 +19738,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" ], @@ -19872,7 +19872,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" ], @@ -19942,7 +19942,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" ], @@ -19988,7 +19988,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" ], @@ -20085,7 +20085,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" ], @@ -308383,7 +308383,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-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index d81627f57b..32efc96ccb 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -14251,9 +14251,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. @@ -14303,9 +14301,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)." @@ -14419,9 +14415,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. @@ -14471,9 +14465,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. @@ -14506,9 +14498,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)." @@ -14589,9 +14579,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. @@ -230906,7 +230894,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index de105b078d..e922dc7061 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -24230,7 +24230,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" @@ -135475,7 +135475,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" ], @@ -135720,7 +135720,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" ], @@ -136029,7 +136029,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" ], @@ -136134,7 +136134,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" ], @@ -136274,7 +136274,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" ], @@ -136478,7 +136478,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" ], @@ -154822,7 +154822,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" @@ -493869,7 +493869,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 13e0ee2c2c..ded770e6d8 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -9620,7 +9620,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: @@ -32491,9 +32491,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. @@ -32589,9 +32587,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)." @@ -32765,9 +32761,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. @@ -32817,9 +32811,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. @@ -32849,9 +32841,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)." @@ -32930,9 +32920,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. diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index de105b078d..e922dc7061 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -24230,7 +24230,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" @@ -135475,7 +135475,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" ], @@ -135720,7 +135720,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" ], @@ -136029,7 +136029,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" ], @@ -136134,7 +136134,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" ], @@ -136274,7 +136274,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" ], @@ -136478,7 +136478,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" ], @@ -154822,7 +154822,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" @@ -493869,7 +493869,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-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 13e0ee2c2c..ded770e6d8 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -9620,7 +9620,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: @@ -32491,9 +32491,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. @@ -32589,9 +32587,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)." @@ -32765,9 +32761,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. @@ -32817,9 +32811,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. @@ -32849,9 +32841,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)." @@ -32930,9 +32920,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. diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 06254462c1..03db6202ce 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -48856,7 +48856,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//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/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -169351,7 +169351,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" ], @@ -169596,7 +169596,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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" ], @@ -169905,7 +169905,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" ], @@ -170010,7 +170010,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" ], @@ -170150,7 +170150,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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" ], @@ -170354,7 +170354,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" ], @@ -188806,7 +188806,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//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/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -531589,7 +531589,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//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/enterprise-cloud@latest//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-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index e664c7d12f..981925a553 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -17950,7 +17950,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//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/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: @@ -41338,9 +41338,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. @@ -41436,9 +41434,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/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." @@ -41612,9 +41608,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. @@ -41664,9 +41658,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. @@ -41696,9 +41688,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/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." @@ -41777,9 +41767,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. diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 06254462c1..03db6202ce 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -48856,7 +48856,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//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/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -169351,7 +169351,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" ], @@ -169596,7 +169596,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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" ], @@ -169905,7 +169905,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" ], @@ -170010,7 +170010,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" ], @@ -170150,7 +170150,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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" ], @@ -170354,7 +170354,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" ], @@ -188806,7 +188806,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//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/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -531589,7 +531589,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//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/enterprise-cloud@latest//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-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index e664c7d12f..981925a553 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -17950,7 +17950,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//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/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: @@ -41338,9 +41338,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. @@ -41436,9 +41434,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/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." @@ -41612,9 +41608,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. @@ -41664,9 +41658,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. @@ -41696,9 +41688,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/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." @@ -41777,9 +41767,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. diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 91554efa41..4375336ab0 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -26787,7 +26787,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" ], @@ -26859,7 +26859,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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" ], @@ -26993,7 +26993,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" ], @@ -27063,7 +27063,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" ], @@ -27109,7 +27109,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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" ], @@ -27206,7 +27206,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" ], @@ -325637,7 +325637,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//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/enterprise-cloud@latest//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-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 0758d2c73e..8e36203892 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -19358,9 +19358,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. @@ -19410,9 +19408,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/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." @@ -19526,9 +19522,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. @@ -19578,9 +19572,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. @@ -19613,9 +19605,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/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." @@ -19696,9 +19686,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. @@ -243357,7 +243345,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//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/enterprise-cloud@latest//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-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 91554efa41..4375336ab0 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -26787,7 +26787,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" ], @@ -26859,7 +26859,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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" ], @@ -26993,7 +26993,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" ], @@ -27063,7 +27063,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" ], @@ -27109,7 +27109,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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" ], @@ -27206,7 +27206,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" ], @@ -325637,7 +325637,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//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/enterprise-cloud@latest//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-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 0758d2c73e..8e36203892 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -19358,9 +19358,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. @@ -19410,9 +19408,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/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." @@ -19526,9 +19522,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. @@ -19578,9 +19572,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. @@ -19613,9 +19605,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/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." @@ -19696,9 +19686,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. @@ -243357,7 +243345,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//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/enterprise-cloud@latest//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-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.json b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.json index 4e4ab1ce82..a78c27c706 100644 --- a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.json @@ -45197,7 +45197,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-server@3.15/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/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -154091,7 +154091,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-server@3.15/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/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -451358,7 +451358,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-server@3.15/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/enterprise-server@3.15/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-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.yaml b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.yaml index 853d7fea37..218e1c769a 100644 --- a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.yaml @@ -14428,7 +14428,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-server@3.15/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/enterprise-server@3.15/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-next/ghes-3.15/dereferenced/ghes-3.15.deref.json b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.json index 4e4ab1ce82..a78c27c706 100644 --- a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.json +++ b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.json @@ -45197,7 +45197,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-server@3.15/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/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -154091,7 +154091,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-server@3.15/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/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -451358,7 +451358,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-server@3.15/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/enterprise-server@3.15/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-next/ghes-3.15/dereferenced/ghes-3.15.deref.yaml b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.yaml index 853d7fea37..218e1c769a 100644 --- a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.yaml +++ b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.yaml @@ -14428,7 +14428,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-server@3.15/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/enterprise-server@3.15/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-next/ghes-3.15/ghes-3.15.2022-11-28.json b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json index 525d6fd01a..42648ba1e6 100644 --- a/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json +++ b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json @@ -292060,7 +292060,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-server@3.15/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/enterprise-server@3.15/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-next/ghes-3.15/ghes-3.15.2022-11-28.yaml b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml index 3866be02b2..0c51fa1269 100644 --- a/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml +++ b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml @@ -217751,7 +217751,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-server@3.15/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/enterprise-server@3.15/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-next/ghes-3.15/ghes-3.15.json b/descriptions-next/ghes-3.15/ghes-3.15.json index 525d6fd01a..42648ba1e6 100644 --- a/descriptions-next/ghes-3.15/ghes-3.15.json +++ b/descriptions-next/ghes-3.15/ghes-3.15.json @@ -292060,7 +292060,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-server@3.15/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/enterprise-server@3.15/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-next/ghes-3.15/ghes-3.15.yaml b/descriptions-next/ghes-3.15/ghes-3.15.yaml index 3866be02b2..0c51fa1269 100644 --- a/descriptions-next/ghes-3.15/ghes-3.15.yaml +++ b/descriptions-next/ghes-3.15/ghes-3.15.yaml @@ -217751,7 +217751,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-server@3.15/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/enterprise-server@3.15/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-next/ghes-3.16/dereferenced/ghes-3.16.2022-11-28.deref.json b/descriptions-next/ghes-3.16/dereferenced/ghes-3.16.2022-11-28.deref.json index ff14277a36..0c1a08af32 100644 --- a/descriptions-next/ghes-3.16/dereferenced/ghes-3.16.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.16/dereferenced/ghes-3.16.2022-11-28.deref.json @@ -50192,7 +50192,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-server@3.16/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/enterprise-server@3.16/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -142633,7 +142633,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" ], @@ -142878,7 +142878,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/enterprise-server@3.16/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/enterprise-server@3.16/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" ], @@ -143187,7 +143187,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" ], @@ -143292,7 +143292,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" ], @@ -143432,7 +143432,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:{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}