Update OpenAPI 3.0 Descriptions

github · Sep 27, 2024 · 35ac41f · 35ac41f
1 parent bbb5aae
commit 35ac41f
Show file tree

Hide file tree

Showing 16 changed files with 8,548 additions and 8,292 deletions.
diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json
@@ -31431,6 +31431,9 @@
           {
             "$ref": "#/components/parameters/git-ref"
           },
+          {
+            "$ref": "#/components/parameters/pr-alias"
+          },
           {
             "$ref": "#/components/parameters/direction"
           },
@@ -31685,6 +31688,9 @@
           },
           {
             "$ref": "#/components/parameters/git-ref"
+          },
+          {
+            "$ref": "#/components/parameters/pr-alias"
           }
         ],
         "responses": {
@@ -31755,6 +31761,9 @@
           {
             "$ref": "#/components/parameters/per-page"
           },
+          {
+            "$ref": "#/components/parameters/pr-alias"
+          },
           {
             "name": "ref",
             "in": "query",
@@ -290314,6 +290323,15 @@
           "$ref": "#/components/schemas/code-scanning-ref"
         }
       },
+      "pr-alias": {
+        "name": "pr",
+        "description": "The number of the pull request for the results you want to list.",
+        "in": "query",
+        "required": false,
+        "schema": {
+          "type": "integer"
+        }
+      },
       "alert-number": {
         "name": "alert_number",
         "in": "path",

diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml
@@ -22777,6 +22777,7 @@ paths:
       - "$ref": "#/components/parameters/page"
       - "$ref": "#/components/parameters/per-page"
       - "$ref": "#/components/parameters/git-ref"
+      - "$ref": "#/components/parameters/pr-alias"
       - "$ref": "#/components/parameters/direction"
       - name: sort
         description: The property by which to sort the results.
@@ -22945,6 +22946,7 @@ paths:
       - "$ref": "#/components/parameters/page"
       - "$ref": "#/components/parameters/per-page"
       - "$ref": "#/components/parameters/git-ref"
+      - "$ref": "#/components/parameters/pr-alias"
       responses:
         '200':
           description: Response
@@ -23000,6 +23002,7 @@ paths:
       - "$ref": "#/components/parameters/tool-guid"
       - "$ref": "#/components/parameters/page"
       - "$ref": "#/components/parameters/per-page"
+      - "$ref": "#/components/parameters/pr-alias"
       - name: ref
         in: query
         description: The Git reference for the analyses you want to list. The `ref`
@@ -220753,6 +220756,13 @@ components:
       required: false
       schema:
         "$ref": "#/components/schemas/code-scanning-ref"
+    pr-alias:
+      name: pr
+      description: The number of the pull request for the results you want to list.
+      in: query
+      required: false
+      schema:
+        type: integer
     alert-number:
       name: alert_number
       in: path

diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
@@ -31431,6 +31431,9 @@
           {
             "$ref": "#/components/parameters/git-ref"
           },
+          {
+            "$ref": "#/components/parameters/pr-alias"
+          },
           {
             "$ref": "#/components/parameters/direction"
           },
@@ -31685,6 +31688,9 @@
           },
           {
             "$ref": "#/components/parameters/git-ref"
+          },
+          {
+            "$ref": "#/components/parameters/pr-alias"
           }
         ],
         "responses": {
@@ -31755,6 +31761,9 @@
           {
             "$ref": "#/components/parameters/per-page"
           },
+          {
+            "$ref": "#/components/parameters/pr-alias"
+          },
           {
             "name": "ref",
             "in": "query",
@@ -290314,6 +290323,15 @@
           "$ref": "#/components/schemas/code-scanning-ref"
         }
       },
+      "pr-alias": {
+        "name": "pr",
+        "description": "The number of the pull request for the results you want to list.",
+        "in": "query",
+        "required": false,
+        "schema": {
+          "type": "integer"
+        }
+      },
       "alert-number": {
         "name": "alert_number",
         "in": "path",

diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml
@@ -22777,6 +22777,7 @@ paths:
       - "$ref": "#/components/parameters/page"
       - "$ref": "#/components/parameters/per-page"
       - "$ref": "#/components/parameters/git-ref"
+      - "$ref": "#/components/parameters/pr-alias"
       - "$ref": "#/components/parameters/direction"
       - name: sort
         description: The property by which to sort the results.
@@ -22945,6 +22946,7 @@ paths:
       - "$ref": "#/components/parameters/page"
       - "$ref": "#/components/parameters/per-page"
       - "$ref": "#/components/parameters/git-ref"
+      - "$ref": "#/components/parameters/pr-alias"
       responses:
         '200':
           description: Response
@@ -23000,6 +23002,7 @@ paths:
       - "$ref": "#/components/parameters/tool-guid"
       - "$ref": "#/components/parameters/page"
       - "$ref": "#/components/parameters/per-page"
+      - "$ref": "#/components/parameters/pr-alias"
       - name: ref
         in: query
         description: The Git reference for the analyses you want to list. The `ref`
@@ -220753,6 +220756,13 @@ components:
       required: false
       schema:
         "$ref": "#/components/schemas/code-scanning-ref"
+    pr-alias:
+      name: pr
+      description: The number of the pull request for the results you want to list.
+      in: query
+      required: false
+      schema:
+        type: integer
     alert-number:
       name: alert_number
       in: path

diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json
@@ -201020,6 +201020,15 @@
               "description": "The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,\n`refs/heads/<branch name>` or simply `<branch name>`."
             }
           },
+          {
+            "name": "pr",
+            "description": "The number of the pull request for the results you want to list.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "integer"
+            }
+          },
           {
             "name": "direction",
             "description": "The direction to sort the results by.",
@@ -202964,6 +202973,15 @@
               "type": "string",
               "description": "The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,\n`refs/heads/<branch name>` or simply `<branch name>`."
             }
+          },
+          {
+            "name": "pr",
+            "description": "The number of the pull request for the results you want to list.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "integer"
+            }
           }
         ],
         "responses": {
@@ -203259,6 +203277,15 @@
               "default": 30
             }
           },
+          {
+            "name": "pr",
+            "description": "The number of the pull request for the results you want to list.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "integer"
+            }
+          },
           {
             "name": "ref",
             "in": "query",