Merge pull request #5907 from github/repo-sync

repo sync

Author: Octomerger

lib/rest/static/decorated/github.ae.json

@@ -6214,246 +6214,6 @@
     "bodyParameters": [],
     "descriptionHTML": "<p>Removes the global announcement banner in your enterprise.</p>"
   },
-  {
-    "verb": "get",
-    "requestPath": "/enterprise/encryption",
-    "serverUrl": "http(s)://api.{hostname}",
-    "parameters": [],
-    "x-codeSamples": [
-      {
-        "lang": "Shell",
-        "source": "curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption",
-        "html": "<pre><code class=\"hljs language-shell\">curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption</code></pre>"
-      },
-      {
-        "lang": "JavaScript",
-        "source": "await octokit.request('GET /enterprise/encryption')",
-        "html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /enterprise/encryption'</span>)\n</code></pre>"
-      }
-    ],
-    "summary": "Get an encryption key",
-    "description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nGets information about the current key used for encryption at rest.",
-    "operationId": "enterprise-admin/get-encryption-key",
-    "tags": [
-      "enterprise-admin"
-    ],
-    "x-github": {
-      "githubCloudOnly": false,
-      "enabledForGitHubApps": false,
-      "previews": [],
-      "category": "enterprise-admin",
-      "subcategory": "encryption-at-rest"
-    },
-    "slug": "get-an-encryption-key",
-    "category": "enterprise-admin",
-    "categoryLabel": "Enterprise admin",
-    "subcategory": "encryption-at-rest",
-    "subcategoryLabel": "Encryption at rest",
-    "notes": [],
-    "bodyParameters": [],
-    "descriptionHTML": "<p><strong>Warning:</strong> The encryption at rest endpoints are currently in beta and are subject to change.</p>\n<p>Gets information about the current key used for encryption at rest.</p>",
-    "responses": [
-      {
-        "httpStatusCode": "200",
-        "httpStatusMessage": "OK",
-        "description": "Response",
-        "payload": "<pre><code class=\"hljs language-json\">{\n  <span class=\"hljs-attr\">\"updated_at\"</span>: <span class=\"hljs-string\">\"2020-09-09T10:04:26.000Z\"</span>,\n  <span class=\"hljs-attr\">\"primary_key_version\"</span>: <span class=\"hljs-string\">\"9b24a469887e416787173383958c6fb9\"</span>,\n  <span class=\"hljs-attr\">\"replica_key_version\"</span>: <span class=\"hljs-string\">\"4621542832e447f285ea2dbeaf6f621b\"</span>,\n  <span class=\"hljs-attr\">\"backup_key_version\"</span>: <span class=\"hljs-string\">\"d067172e711b44a5963fe53b6b976c0f\"</span>\n}\n</code></pre>"
-      }
-    ]
-  },
-  {
-    "verb": "patch",
-    "requestPath": "/enterprise/encryption",
-    "serverUrl": "http(s)://api.{hostname}",
-    "parameters": [],
-    "x-codeSamples": [
-      {
-        "lang": "Shell",
-        "source": "curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption \\\n  -d '{\"key\":\"key\"}'",
-        "html": "<pre><code class=\"hljs language-shell\">curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption \\\n  -d '{\"key\":\"key\"}'</code></pre>"
-      },
-      {
-        "lang": "JavaScript",
-        "source": "await octokit.request('PATCH /enterprise/encryption', {\n  key: 'key'\n})",
-        "html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PATCH /enterprise/encryption'</span>, {\n  <span class=\"hljs-attr\">key</span>: <span class=\"hljs-string\">'key'</span>\n})\n</code></pre>"
-      }
-    ],
-    "summary": "Update an encryption key",
-    "description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nUpdates the current encryption at rest key with a new private key.\n\nYou can add a new encryption key as often as you need. When you add a new key, the old key is discarded.\n\nYour enterprise won't experience downtime when you update the key, because the key vault that GitHub manages uses the \"envelope\" technique. For more information, see [Encryption and decryption via the envelope technique](https://docs.microsoft.com/en-us/azure/storage/common/storage-client-side-encryption#encryption-and-decryption-via-the-envelope-technique) in the Azure documentation.\n\nYour 2048 bit RSA private key should be in PEM format. For more information, see \"[Configuring data encryption for your enterprise](/admin/configuration/configuring-data-encryption-for-your-enterprise#adding-or-updating-an-encryption-key).\"",
-    "operationId": "enterprise-admin/update-encryption-key",
-    "tags": [
-      "enterprise-admin"
-    ],
-    "requestBody": {
-      "content": {
-        "application/json": {
-          "schema": {
-            "type": "object",
-            "properties": {
-              "key": {
-                "type": "string",
-                "description": "<p><strong>Required</strong>. A 2048 bit RSA private key in PEM format.</p>",
-                "name": "key",
-                "in": "body",
-                "rawType": "string",
-                "rawDescription": "A 2048 bit RSA private key in PEM format.",
-                "childParamsGroups": []
-              }
-            },
-            "required": [
-              "key"
-            ]
-          },
-          "example": {
-            "key": "\\\"$(awk '{printf \"%s\\\\n\", $0}' ~/private-key.pem)\\\""
-          }
-        }
-      }
-    },
-    "x-github": {
-      "githubCloudOnly": false,
-      "enabledForGitHubApps": false,
-      "previews": [],
-      "category": "enterprise-admin",
-      "subcategory": "encryption-at-rest"
-    },
-    "slug": "update-an-encryption-key",
-    "category": "enterprise-admin",
-    "categoryLabel": "Enterprise admin",
-    "subcategory": "encryption-at-rest",
-    "subcategoryLabel": "Encryption at rest",
-    "notes": [],
-    "descriptionHTML": "<p><strong>Warning:</strong> The encryption at rest endpoints are currently in beta and are subject to change.</p>\n<p>Updates the current encryption at rest key with a new private key.</p>\n<p>You can add a new encryption key as often as you need. When you add a new key, the old key is discarded.</p>\n<p>Your enterprise won't experience downtime when you update the key, because the key vault that GitHub manages uses the \"envelope\" technique. For more information, see <a href=\"https://docs.microsoft.com/en-us/azure/storage/common/storage-client-side-encryption#encryption-and-decryption-via-the-envelope-technique\">Encryption and decryption via the envelope technique</a> in the Azure documentation.</p>\n<p>Your 2048 bit RSA private key should be in PEM format. For more information, see \"<a href=\"/admin/configuration/configuring-data-encryption-for-your-enterprise#adding-or-updating-an-encryption-key\">Configuring data encryption for your enterprise</a>.\"</p>",
-    "bodyParameters": [
-      {
-        "type": "string",
-        "description": "<p><strong>Required</strong>. A 2048 bit RSA private key in PEM format.</p>",
-        "name": "key",
-        "in": "body",
-        "rawType": "string",
-        "rawDescription": "A 2048 bit RSA private key in PEM format.",
-        "childParamsGroups": []
-      }
-    ],
-    "responses": [
-      {
-        "httpStatusCode": "202",
-        "httpStatusMessage": "Accepted",
-        "description": "Response",
-        "payload": "<pre><code class=\"hljs language-json\">{\n  <span class=\"hljs-attr\">\"message\"</span>: <span class=\"hljs-string\">\"Started update of private key for encryption at rest.\"</span>,\n  <span class=\"hljs-attr\">\"status_url\"</span>: <span class=\"hljs-string\">\"https://octocoders.github.io/api/v3/enterprise/encryption/status/6020dd37-ce35-49e8-a15b-0b9df458c049\"</span>\n}\n</code></pre>"
-      }
-    ]
-  },
-  {
-    "verb": "delete",
-    "requestPath": "/enterprise/encryption",
-    "serverUrl": "http(s)://api.{hostname}",
-    "parameters": [],
-    "x-codeSamples": [
-      {
-        "lang": "Shell",
-        "source": "curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption",
-        "html": "<pre><code class=\"hljs language-shell\">curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption</code></pre>"
-      },
-      {
-        "lang": "JavaScript",
-        "source": "await octokit.request('DELETE /enterprise/encryption')",
-        "html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /enterprise/encryption'</span>)\n</code></pre>"
-      }
-    ],
-    "summary": "Disable encryption at rest",
-    "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"
-    ],
-    "x-github": {
-      "githubCloudOnly": false,
-      "enabledForGitHubApps": false,
-      "previews": [],
-      "category": "enterprise-admin",
-      "subcategory": "encryption-at-rest"
-    },
-    "slug": "disable-encryption-at-rest",
-    "category": "enterprise-admin",
-    "categoryLabel": "Enterprise admin",
-    "subcategory": "encryption-at-rest",
-    "subcategoryLabel": "Encryption at rest",
-    "notes": [],
-    "bodyParameters": [],
-    "descriptionHTML": "<p><strong>Warning:</strong> The encryption at rest endpoints are currently in beta and are subject to change.</p>\n<p>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.</p>\n<p>It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-an-encryption-status\">Get an encryption status</a>\" REST API.</p>\n<p>To unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"<a href=\"/admin/enterprise-support/receiving-help-from-github-support\">Receiving enterprise support</a>.\"</p>",
-    "responses": [
-      {
-        "httpStatusCode": "202",
-        "httpStatusMessage": "Accepted",
-        "description": "Response",
-        "payload": "<pre><code class=\"hljs language-json\">{\n  <span class=\"hljs-attr\">\"message\"</span>: <span class=\"hljs-string\">\"Started disabling encryption at rest.\"</span>,\n  <span class=\"hljs-attr\">\"status_url\"</span>: <span class=\"hljs-string\">\"https://octocoders.github.io/api/v3/enterprise/encryption/status/db8ef711-ef82-464b-9013-5e0a1bb0031e\"</span>\n}\n</code></pre>"
-      }
-    ]
-  },
-  {
-    "verb": "get",
-    "requestPath": "/enterprise/encryption/status/{request_id}",
-    "serverUrl": "http(s)://api.{hostname}",
-    "parameters": [
-      {
-        "name": "request_id",
-        "description": "The id provided in the `status_url` after updating or deleting an encryption key.",
-        "in": "path",
-        "required": true,
-        "schema": {
-          "type": "string"
-        },
-        "descriptionHTML": "<p>The id provided in the <code>status_url</code> after updating or deleting an encryption key.</p>"
-      }
-    ],
-    "x-codeSamples": [
-      {
-        "lang": "Shell",
-        "source": "curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption/status/REQUEST_ID",
-        "html": "<pre><code class=\"hljs language-shell\">curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://api.{hostname}/enterprise/encryption/status/REQUEST_ID</code></pre>"
-      },
-      {
-        "lang": "JavaScript",
-        "source": "await octokit.request('GET /enterprise/encryption/status/{request_id}', {\n  request_id: 'request_id'\n})",
-        "html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /enterprise/encryption/status/{request_id}'</span>, {\n  <span class=\"hljs-attr\">request_id</span>: <span class=\"hljs-string\">'request_id'</span>\n})\n</code></pre>"
-      }
-    ],
-    "summary": "Get an encryption status",
-    "description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nChecks the status of updating an encryption key or disabling encryption at rest.",
-    "operationId": "enterprise-admin/get-encryption-status",
-    "tags": [
-      "enterprise-admin"
-    ],
-    "x-github": {
-      "githubCloudOnly": false,
-      "enabledForGitHubApps": false,
-      "previews": [],
-      "category": "enterprise-admin",
-      "subcategory": "encryption-at-rest"
-    },
-    "slug": "get-an-encryption-status",
-    "category": "enterprise-admin",
-    "categoryLabel": "Enterprise admin",
-    "subcategory": "encryption-at-rest",
-    "subcategoryLabel": "Encryption at rest",
-    "notes": [],
-    "bodyParameters": [],
-    "descriptionHTML": "<p><strong>Warning:</strong> The encryption at rest endpoints are currently in beta and are subject to change.</p>\n<p>Checks the status of updating an encryption key or disabling encryption at rest.</p>",
-    "responses": [
-      {
-        "httpStatusCode": "200",
-        "httpStatusMessage": "OK",
-        "description": "Response",
-        "payload": "<pre><code class=\"hljs language-json\">{\n  <span class=\"hljs-attr\">\"result\"</span>: <span class=\"hljs-string\">\"started\"</span>,\n  <span class=\"hljs-attr\">\"error\"</span>: <span class=\"hljs-literal\">null</span>\n}\n</code></pre>"
-      },
-      {
-        "httpStatusCode": "404",
-        "httpStatusMessage": "Not Found",
-        "description": "Not Found if the URL cannot be found"
-      }
-    ]
-  },
   {
     "verb": "get",
     "requestPath": "/enterprise/settings/license",