Skip to content

Commit

Permalink
Update OpenAPI 3.0 Descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-openapi-bot
github-openapi-bot committed Jan 10, 2024
1 parent 0a02946 commit 8b7f4c2
Show file tree
Hide file tree
Showing 16 changed files with 440 additions and 176 deletions.
22 changes: 11 additions & 11 deletions descriptions/api.github.com/api.github.com.2022-11-28.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31035,7 +31035,7 @@
"/repos/{owner}/{repo}/codespaces": {
"get": {
"summary": "List codespaces in a repository for the authenticated user",
"description": "Lists the codespaces associated to a specified repository and the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.",
"description": "Lists the codespaces associated to a specified repository and the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have read access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down Expand Up @@ -31111,7 +31111,7 @@
},
"post": {
"summary": "Create a codespace in a repository",
"description": "Creates a codespace owned by the authenticated user in the specified repository.\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.",
"description": "Creates a codespace owned by the authenticated user in the specified repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have write access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down Expand Up @@ -31453,7 +31453,7 @@
"/repos/{owner}/{repo}/codespaces/new": {
"get": {
"summary": "Get default attributes for a codespace",
"description": "Gets the default attributes for codespaces created by the user with the repository.\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.",
"description": "Gets the default attributes for codespaces created by the user with the repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have write access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down Expand Up @@ -31546,7 +31546,7 @@
"/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.",
"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\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have write access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down Expand Up @@ -45257,7 +45257,7 @@
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
"post": {
"summary": "Create a codespace from a pull request",
"description": "Creates a codespace owned by the authenticated user for the specified pull request.\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.",
"description": "Creates a codespace owned by the authenticated user for the specified pull request.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have write access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down Expand Up @@ -55373,7 +55373,7 @@
"/user/codespaces": {
"get": {
"summary": "List codespaces for the authenticated user",
"description": "Lists the authenticated user's codespaces.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.",
"description": "Lists the authenticated user's codespaces.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have read access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down Expand Up @@ -55449,7 +55449,7 @@
},
"post": {
"summary": "Create a codespace for the authenticated user",
"description": "Creates a new codespace, owned by the authenticated user.\n\nThis endpoint requires either a `repository_id` OR a `pull_request` but not both.\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.",
"description": "Creates a new codespace, owned by the authenticated user.\n\nThis endpoint requires either a `repository_id` OR a `pull_request` but not both.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have write access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down Expand Up @@ -56161,7 +56161,7 @@
"/user/codespaces/{codespace_name}": {
"get": {
"summary": "Get a codespace for the authenticated user",
"description": "Gets information about a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.",
"description": "Gets information about a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have read access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down Expand Up @@ -56216,7 +56216,7 @@
},
"patch": {
"summary": "Update a codespace for the authenticated user",
"description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\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.",
"description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have write access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down Expand Up @@ -56299,7 +56299,7 @@
},
"delete": {
"summary": "Delete a codespace for the authenticated user",
"description": "Deletes a user's codespace.\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.",
"description": "Deletes a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have write access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down Expand Up @@ -56521,7 +56521,7 @@
"/user/codespaces/{codespace_name}/publish": {
"post": {
"summary": "Create a repository from an unpublished codespace",
"description": "Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.\n\nThe codespace's token is granted write permissions to the repository, allowing the user to push their changes.\n\nThis will fail for a codespace that is already published, meaning it has an associated repository.\n\nYou must authenticate using a personal 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.",
"description": "Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.\n\nThe codespace's token is granted write permissions to the repository, allowing the user to push their changes.\n\nThis will fail for a codespace that is already published, meaning it has an associated repository.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nTo use this endpoint with GitHub Apps:\n\n- The app must be authenticated on behalf of the user. For more information, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"\n- The app must have write access to the `codespaces` repository permission.",
"tags": [
"codespaces"
],
Expand Down
Loading

0 comments on commit 8b7f4c2

Please sign in to comment.