Merge pull request #3023 from github/openapi-update-9ae2537b4aa4bcc22…

…9a3f8f61e3d4aae1b8d7f9db9b1c7afdb49da844468e243 Update OpenAPI 3.1 Descriptions
github · Sep 29, 2023 · 2b0299e · 2b0299e
2 parents db8fca9 + 09f824e
commit 2b0299e
Show file tree

Hide file tree

Showing 36 changed files with 2,170 additions and 20 deletions.
diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json
@@ -30377,6 +30377,90 @@
         }
       }
     },
+    "/repos/{owner}/{repo}/codespaces/permissions_check": {
+      "get": {
+        "summary": "Check if permissions defined by a devcontainer have been accepted by the authenticated user",
+        "description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.",
+        "tags": [
+          "codespaces"
+        ],
+        "operationId": "codespaces/check-permissions-for-devcontainer",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/owner"
+          },
+          {
+            "$ref": "#/components/parameters/repo"
+          },
+          {
+            "name": "ref",
+            "description": "The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "examples": [
+                "master"
+              ]
+            }
+          },
+          {
+            "name": "devcontainer_path",
+            "description": "Path to the devcontainer.json configuration to use for the permission check.",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "examples": [
+                ".devcontainer/example/devcontainer.json"
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response when the permission check is successful",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/codespaces-permissions-check-for-devcontainer"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/codespaces-permissions-check-for-devcontainer"
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/requires_authentication"
+          },
+          "403": {
+            "$ref": "#/components/responses/forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/not_found"
+          },
+          "422": {
+            "$ref": "#/components/responses/validation_failed"
+          },
+          "503": {
+            "$ref": "#/components/responses/service_unavailable"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "codespaces",
+          "subcategory": "codespaces"
+        }
+      }
+    },
     "/repos/{owner}/{repo}/codespaces/secrets": {
       "get": {
         "summary": "List repository secrets",
@@ -104431,6 +104515,23 @@
           "errors"
         ]
       },
+      "codespaces-permissions-check-for-devcontainer": {
+        "title": "Codespaces Permissions Check",
+        "description": "Permission check result for a given devcontainer config.",
+        "type": "object",
+        "properties": {
+          "accepted": {
+            "description": "Whether the user has accepted the permissions defined by the devcontainer config",
+            "type": "boolean",
+            "examples": [
+              true
+            ]
+          }
+        },
+        "required": [
+          "accepted"
+        ]
+      },
       "repo-codespaces-secret": {
         "title": "Codespaces Secret",
         "description": "Set repository secrets for GitHub Codespaces.",
@@ -298555,6 +298656,11 @@
           }
         }
       },
+      "codespaces-permissions-check-for-devcontainer": {
+        "value": {
+          "accepted": true
+        }
+      },
       "collaborator-items": {
         "value": [
           {

diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
@@ -21694,6 +21694,71 @@ paths:
         enabledForGitHubApps: true
         category: codespaces
         subcategory: codespaces
+  "/repos/{owner}/{repo}/codespaces/permissions_check":
+    get:
+      summary: Check if permissions defined by a devcontainer have been accepted by
+        the authenticated user
+      description: |-
+        Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.
+
+        You must authenticate using an access token with the `codespace` scope to use this endpoint.
+
+        GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+      tags:
+      - codespaces
+      operationId: codespaces/check-permissions-for-devcontainer
+      externalDocs:
+        description: API method documentation
+        url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user
+      parameters:
+      - "$ref": "#/components/parameters/owner"
+      - "$ref": "#/components/parameters/repo"
+      - name: ref
+        description: The git reference that points to the location of the devcontainer
+          configuration to use for the permission check. The value of `ref` will typically
+          be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git
+          References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)"
+          in the Git documentation.
+        in: query
+        required: true
+        schema:
+          type: string
+          examples:
+          - master
+      - name: devcontainer_path
+        description: Path to the devcontainer.json configuration to use for the permission
+          check.
+        in: query
+        required: true
+        schema:
+          type: string
+          examples:
+          - ".devcontainer/example/devcontainer.json"
+      responses:
+        '200':
+          description: Response when the permission check is successful
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/codespaces-permissions-check-for-devcontainer"
+              examples:
+                default:
+                  "$ref": "#/components/examples/codespaces-permissions-check-for-devcontainer"
+        '401':
+          "$ref": "#/components/responses/requires_authentication"
+        '403':
+          "$ref": "#/components/responses/forbidden"
+        '404':
+          "$ref": "#/components/responses/not_found"
+        '422':
+          "$ref": "#/components/responses/validation_failed"
+        '503':
+          "$ref": "#/components/responses/service_unavailable"
+      x-github:
+        githubCloudOnly: false
+        enabledForGitHubApps: true
+        category: codespaces
+        subcategory: codespaces
   "/repos/{owner}/{repo}/codespaces/secrets":
     get:
       summary: List repository secrets
@@ -74811,6 +74876,19 @@ components:
             - path
       required:
       - errors
+    codespaces-permissions-check-for-devcontainer:
+      title: Codespaces Permissions Check
+      description: Permission check result for a given devcontainer config.
+      type: object
+      properties:
+        accepted:
+          description: Whether the user has accepted the permissions defined by the
+            devcontainer config
+          type: boolean
+          examples:
+          - true
+      required:
+      - accepted
     repo-codespaces-secret:
       title: Codespaces Secret
       description: Set repository secrets for GitHub Codespaces.
@@ -220626,6 +220704,9 @@ components:
         defaults:
           location: EastUs
           devcontainer_path: ".devcontainer/devcontainer.json"
+    codespaces-permissions-check-for-devcontainer:
+      value:
+        accepted: true
     collaborator-items:
       value:
       - login: octocat

diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json
@@ -30377,6 +30377,90 @@
         }
       }
     },
+    "/repos/{owner}/{repo}/codespaces/permissions_check": {
+      "get": {
+        "summary": "Check if permissions defined by a devcontainer have been accepted by the authenticated user",
+        "description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.",
+        "tags": [
+          "codespaces"
+        ],
+        "operationId": "codespaces/check-permissions-for-devcontainer",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/owner"
+          },
+          {
+            "$ref": "#/components/parameters/repo"
+          },
+          {
+            "name": "ref",
+            "description": "The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "examples": [
+                "master"
+              ]
+            }
+          },
+          {
+            "name": "devcontainer_path",
+            "description": "Path to the devcontainer.json configuration to use for the permission check.",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "examples": [
+                ".devcontainer/example/devcontainer.json"
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response when the permission check is successful",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/codespaces-permissions-check-for-devcontainer"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/codespaces-permissions-check-for-devcontainer"
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/requires_authentication"
+          },
+          "403": {
+            "$ref": "#/components/responses/forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/not_found"
+          },
+          "422": {
+            "$ref": "#/components/responses/validation_failed"
+          },
+          "503": {
+            "$ref": "#/components/responses/service_unavailable"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "codespaces",
+          "subcategory": "codespaces"
+        }
+      }
+    },
     "/repos/{owner}/{repo}/codespaces/secrets": {
       "get": {
         "summary": "List repository secrets",
@@ -104431,6 +104515,23 @@
           "errors"
         ]
       },
+      "codespaces-permissions-check-for-devcontainer": {
+        "title": "Codespaces Permissions Check",
+        "description": "Permission check result for a given devcontainer config.",
+        "type": "object",
+        "properties": {
+          "accepted": {
+            "description": "Whether the user has accepted the permissions defined by the devcontainer config",
+            "type": "boolean",
+            "examples": [
+              true
+            ]
+          }
+        },
+        "required": [
+          "accepted"
+        ]
+      },
       "repo-codespaces-secret": {
         "title": "Codespaces Secret",
         "description": "Set repository secrets for GitHub Codespaces.",
@@ -298555,6 +298656,11 @@
           }
         }
       },
+      "codespaces-permissions-check-for-devcontainer": {
+        "value": {
+          "accepted": true
+        }
+      },
       "collaborator-items": {
         "value": [
           {