From 8a3d415da423eb7a854c9fb1563ba56a0064915a Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Mon, 1 Feb 2021 17:58:13 -0500 Subject: [PATCH] Update OpenAPI Descriptions (#17609) * Update OpenAPI Descriptions * Add decorated OpenAPI schema files Co-authored-by: Sarah Edwards --- lib/rest/static/decorated/github.ae.json | 4 ++-- lib/rest/static/dereferenced/github.ae.deref.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 9f9de893eacf..7c466a825ba6 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -6153,7 +6153,7 @@ } ], "summary": "Disable encryption at rest", - "description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nDisables encryption at rest and deletes the encryption key. To freeze your enterprise, you can disable encryption at rest. For example, you can freeze your enterprise in the case of a breach. It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"[Get an encryption status](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-an-encryption-status)\" REST API.\n\nTo unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"[Receiving enterprise support](/admin/enterprise-support/receiving-help-from-github-support).\"", + "description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nMarks your encryption key as disabled and disables encryption at rest. This will freeze your enterprise. For example, you can use this operation to freeze your enterprise in case of a breach. Note: This operation does not delete the key permanently.\n\nIt takes approximately ten minutes to disable encryption at rest. To check the status, use the \"[Get an encryption status](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-an-encryption-status)\" REST API.\n\nTo unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"[Receiving enterprise support](/admin/enterprise-support/receiving-help-from-github-support).\"", "operationId": "enterprise-admin/disable-encryption", "tags": [ "enterprise-admin" @@ -6176,7 +6176,7 @@ "subcategoryLabel": "Encryption at rest", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Warning: The encryption at rest endpoints are currently in beta and are subject to change.

\n

Disables encryption at rest and deletes the encryption key. To freeze your enterprise, you can disable encryption at rest. For example, you can freeze your enterprise in the case of a breach. It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"Get an encryption status\" REST API.

\n

To unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"Receiving enterprise support.\"

", + "descriptionHTML": "

Warning: The encryption at rest endpoints are currently in beta and are subject to change.

\n

Marks your encryption key as disabled and disables encryption at rest. This will freeze your enterprise. For example, you can use this operation to freeze your enterprise in case of a breach. Note: This operation does not delete the key permanently.

\n

It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"Get an encryption status\" REST API.

\n

To unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"Receiving enterprise support.\"

", "responses": [ { "httpStatusCode": "202", diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index c2b211472bc0..88191914e858 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -12328,7 +12328,7 @@ }, "delete": { "summary": "Disable encryption at rest", - "description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nDisables encryption at rest and deletes the encryption key. To freeze your enterprise, you can disable encryption at rest. For example, you can freeze your enterprise in the case of a breach. It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"[Get an encryption status](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-an-encryption-status)\" REST API.\n\nTo unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"[Receiving enterprise support](/admin/enterprise-support/receiving-help-from-github-support).\"", + "description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nMarks your encryption key as disabled and disables encryption at rest. This will freeze your enterprise. For example, you can use this operation to freeze your enterprise in case of a breach. Note: This operation does not delete the key permanently.\n\nIt takes approximately ten minutes to disable encryption at rest. To check the status, use the \"[Get an encryption status](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-an-encryption-status)\" REST API.\n\nTo unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"[Receiving enterprise support](/admin/enterprise-support/receiving-help-from-github-support).\"", "operationId": "enterprise-admin/disable-encryption", "tags": [ "enterprise-admin"