Update OpenAPI Descriptions (github#21889)

* Update OpenAPI Descriptions
Z-byte-prog · Oct 5, 2021 · 9ca7c41 · 9ca7c41
1 parent bd72aeb
commit 9ca7c41
Show file tree

Hide file tree

Showing 12 changed files with 130 additions and 237 deletions.
diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json
diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json
@@ -33521,16 +33521,16 @@
     "x-github": {
       "githubCloudOnly": false,
       "enabledForGitHubApps": true,
+      "category": "repos",
+      "subcategory": "branches",
       "previews": [
         {
           "required": true,
           "name": "zzzax",
           "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```",
           "html": "<p>Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures\">blog post</a> for full details. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/[email protected]/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.zzzax-preview+json</code></pre>"
         }
-      ],
-      "category": "repos",
-      "subcategory": "branches"
+      ]
     },
     "slug": "get-commit-signature-protection",
     "category": "repos",
@@ -33614,16 +33614,16 @@
     "x-github": {
       "githubCloudOnly": false,
       "enabledForGitHubApps": true,
+      "category": "repos",
+      "subcategory": "branches",
       "previews": [
         {
           "required": true,
           "name": "zzzax",
           "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```",
           "html": "<p>Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures\">blog post</a> for full details. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/[email protected]/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.zzzax-preview+json</code></pre>"
         }
-      ],
-      "category": "repos",
-      "subcategory": "branches"
+      ]
     },
     "slug": "create-commit-signature-protection",
     "category": "repos",
@@ -33707,16 +33707,16 @@
     "x-github": {
       "githubCloudOnly": false,
       "enabledForGitHubApps": true,
+      "category": "repos",
+      "subcategory": "branches",
       "previews": [
         {
           "required": true,
           "name": "zzzax",
           "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```",
           "html": "<p>Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures\">blog post</a> for full details. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/[email protected]/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.zzzax-preview+json</code></pre>"
         }
-      ],
-      "category": "repos",
-      "subcategory": "branches"
+      ]
     },
     "slug": "delete-commit-signature-protection",
     "category": "repos",

diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json
diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json
diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json
diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json
diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json
@@ -155575,13 +155575,6 @@
         "x-github": {
           "githubCloudOnly": false,
           "enabledForGitHubApps": true,
-          "previews": [
-            {
-              "required": true,
-              "name": "zzzax",
-              "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
-            }
-          ],
           "category": "repos",
           "subcategory": "branches"
         }
@@ -155691,13 +155684,6 @@
         "x-github": {
           "githubCloudOnly": false,
           "enabledForGitHubApps": true,
-          "previews": [
-            {
-              "required": true,
-              "name": "zzzax",
-              "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
-            }
-          ],
           "category": "repos",
           "subcategory": "branches"
         }
@@ -155775,13 +155761,6 @@
         "x-github": {
           "githubCloudOnly": false,
           "enabledForGitHubApps": true,
-          "previews": [
-            {
-              "required": true,
-              "name": "zzzax",
-              "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
-            }
-          ],
           "category": "repos",
           "subcategory": "branches"
         }
@@ -178262,9 +178241,6 @@
                       "readOnly": true,
                       "nullable": false
                     },
-                    "instances": {
-                      "deprecated": true
-                    },
                     "instances_url": {
                       "type": "string",
                       "description": "The REST API URL for fetching the list of instances for an alert.",
@@ -178661,8 +178637,7 @@
                           "test"
                         ]
                       },
-                      "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances",
-                      "instances": null
+                      "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
                     }
                   }
                 }
@@ -178867,9 +178842,6 @@
                       "readOnly": true,
                       "nullable": false
                     },
-                    "instances": {
-                      "deprecated": true
-                    },
                     "instances_url": {
                       "type": "string",
                       "description": "The REST API URL for fetching the list of instances for an alert.",

diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json
@@ -128804,15 +128804,15 @@
         "x-github": {
           "githubCloudOnly": false,
           "enabledForGitHubApps": true,
+          "category": "repos",
+          "subcategory": "branches",
           "previews": [
             {
               "required": true,
               "name": "zzzax",
               "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
             }
-          ],
-          "category": "repos",
-          "subcategory": "branches"
+          ]
         }
       },
       "post": {
@@ -128920,15 +128920,15 @@
         "x-github": {
           "githubCloudOnly": false,
           "enabledForGitHubApps": true,
+          "category": "repos",
+          "subcategory": "branches",
           "previews": [
             {
               "required": true,
               "name": "zzzax",
               "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
             }
-          ],
-          "category": "repos",
-          "subcategory": "branches"
+          ]
         }
       },
       "delete": {
@@ -129004,15 +129004,15 @@
         "x-github": {
           "githubCloudOnly": false,
           "enabledForGitHubApps": true,
+          "category": "repos",
+          "subcategory": "branches",
           "previews": [
             {
               "required": true,
               "name": "zzzax",
               "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
             }
-          ],
-          "category": "repos",
-          "subcategory": "branches"
+          ]
         }
       }
     },
@@ -149913,9 +149913,6 @@
                       "readOnly": true,
                       "nullable": false
                     },
-                    "instances": {
-                      "deprecated": true
-                    },
                     "state": {
                       "type": "string",
                       "description": "State of a code scanning alert.",
@@ -150128,6 +150125,9 @@
                           "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
                         }
                       }
+                    },
+                    "instances": {
+                      "deprecated": true
                     }
                   },
                   "required": [
@@ -150437,9 +150437,6 @@
                       "readOnly": true,
                       "nullable": false
                     },
-                    "instances": {
-                      "deprecated": true
-                    },
                     "state": {
                       "type": "string",
                       "description": "State of a code scanning alert.",
@@ -150652,6 +150649,9 @@
                           "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
                         }
                       }
+                    },
+                    "instances": {
+                      "deprecated": true
                     }
                   },
                   "required": [