Update OpenAPI Descriptions

Author: github-openapi-bot

descriptions/api.github.com/api.github.com.json

@@ -24166,7 +24166,7 @@
       },
       "delete": {
         "summary": "Delete a code scanning analysis from a repository",
-        "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` and `repo:security_events` scopes.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set\n(see the example default response below).\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin the set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find the deletable analysis for one of the sets,\nstep through deleting the analyses in that set,\nand then repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n  **Inner loop**:\n  * Delete the identified analysis.\n  * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.",
+        "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` and `repo:security_events` scopes.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n  **Inner loop**:\n  * Delete the identified analysis.\n  * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.",
         "operationId": "code-scanning/delete-analysis",
         "tags": [
           "code-scanning"
@@ -45763,6 +45763,9 @@
           },
           {
             "$ref": "#/components/parameters/page"
+          },
+          {
+            "$ref": "#/components/parameters/repository-id-in-query"
           }
         ],
         "responses": {
@@ -98470,6 +98473,14 @@
           "type": "integer"
         }
       },
+      "repository-id-in-query": {
+        "name": "repository_id",
+        "description": "ID of the Repository to filter on",
+        "in": "query",
+        "schema": {
+          "type": "integer"
+        }
+      },
       "codespace-name": {
         "name": "codespace_name",
         "in": "path",

descriptions/api.github.com/api.github.com.yaml

@@ -17369,13 +17369,13 @@ paths:
         ```
 
         The response from a successful `DELETE` operation provides you with
-        two alternative URLs for deleting the next analysis in the set
-        (see the example default response below).
+        two alternative URLs for deleting the next analysis in the set:
+        `next_analysis_url` and `confirm_delete_url`.
         Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis
-        in the set. This is a useful option if you want to preserve at least one analysis
+        in a set. This is a useful option if you want to preserve at least one analysis
         for the specified tool in your repository.
         Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool.
-        When you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url`
+        When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`
         in the 200 response is `null`.
 
         As an example of the deletion process,
@@ -17385,9 +17385,11 @@ paths:
         You therefore have two separate sets of analyses for this tool.
         You've now decided that you want to remove all of the analyses for the tool.
         To do this you must make 15 separate deletion requests.
-        To start, you must find the deletable analysis for one of the sets,
-        step through deleting the analyses in that set,
-        and then repeat the process for the second set.
+        To start, you must find an analysis that's identified as deletable.
+        Each set of analyses always has one that's identified as deletable.
+        Having found the deletable analysis for one of the two sets,
+        delete this analysis and then continue deleting the next analysis in the set until they're all deleted.
+        Then repeat the process for the second set.
         The procedure therefore consists of a nested loop:
 
         **Outer loop**:
@@ -32871,6 +32873,7 @@ paths:
       parameters:
       - "$ref": "#/components/parameters/per-page"
       - "$ref": "#/components/parameters/page"
+      - "$ref": "#/components/parameters/repository-id-in-query"
       responses:
         '200':
           description: Response
@@ -75165,6 +75168,12 @@ components:
       required: true
       schema:
         type: integer
+    repository-id-in-query:
+      name: repository_id
+      description: ID of the Repository to filter on
+      in: query
+      schema:
+        type: integer
     codespace-name:
       name: codespace_name
       in: path

descriptions/api.github.com/dereferenced/api.github.com.deref.json

@@ -180468,7 +180468,7 @@
       },
       "delete": {
         "summary": "Delete a code scanning analysis from a repository",
-        "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` and `repo:security_events` scopes.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set\n(see the example default response below).\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin the set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find the deletable analysis for one of the sets,\nstep through deleting the analyses in that set,\nand then repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n  **Inner loop**:\n  * Delete the identified analysis.\n  * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.",
+        "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` and `repo:security_events` scopes.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n  **Inner loop**:\n  * Delete the identified analysis.\n  * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.",
         "operationId": "code-scanning/delete-analysis",
         "tags": [
           "code-scanning"
@@ -381256,6 +381256,14 @@
               "type": "integer",
               "default": 1
             }
+          },
+          {
+            "name": "repository_id",
+            "description": "ID of the Repository to filter on",
+            "in": "query",
+            "schema": {
+              "type": "integer"
+            }
           }
         ],
         "responses": {

descriptions/api.github.com/dereferenced/api.github.com.deref.yaml

@@ -39665,13 +39665,13 @@ paths:
         ```
 
         The response from a successful `DELETE` operation provides you with
-        two alternative URLs for deleting the next analysis in the set
-        (see the example default response below).
+        two alternative URLs for deleting the next analysis in the set:
+        `next_analysis_url` and `confirm_delete_url`.
         Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis
-        in the set. This is a useful option if you want to preserve at least one analysis
+        in a set. This is a useful option if you want to preserve at least one analysis
         for the specified tool in your repository.
         Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool.
-        When you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url`
+        When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`
         in the 200 response is `null`.
 
         As an example of the deletion process,
@@ -39681,9 +39681,11 @@ paths:
         You therefore have two separate sets of analyses for this tool.
         You've now decided that you want to remove all of the analyses for the tool.
         To do this you must make 15 separate deletion requests.
-        To start, you must find the deletable analysis for one of the sets,
-        step through deleting the analyses in that set,
-        and then repeat the process for the second set.
+        To start, you must find an analysis that's identified as deletable.
+        Each set of analyses always has one that's identified as deletable.
+        Having found the deletable analysis for one of the two sets,
+        delete this analysis and then continue deleting the next analysis in the set until they're all deleted.
+        Then repeat the process for the second set.
         The procedure therefore consists of a nested loop:
 
         **Outer loop**:
@@ -75141,6 +75143,11 @@ paths:
         description: Page number of the results to fetch.
         in: query
         schema: *20
+      - name: repository_id
+        description: ID of the Repository to filter on
+        in: query
+        schema:
+          type: integer
       responses:
         '200':
           description: Response