|
31177 | 31177 | "/repos/{owner}/{repo}/codespaces": { |
31178 | 31178 | "get": { |
31179 | 31179 | "summary": "List codespaces in a repository for the authenticated user", |
31180 | | - "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.", |
| 31180 | + "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.", |
31181 | 31181 | "tags": [ |
31182 | 31182 | "codespaces" |
31183 | 31183 | ], |
|
31253 | 31253 | }, |
31254 | 31254 | "post": { |
31255 | 31255 | "summary": "Create a codespace in a repository", |
31256 | | - "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.", |
| 31256 | + "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.", |
31257 | 31257 | "tags": [ |
31258 | 31258 | "codespaces" |
31259 | 31259 | ], |
|
31601 | 31601 | "/repos/{owner}/{repo}/codespaces/new": { |
31602 | 31602 | "get": { |
31603 | 31603 | "summary": "Get default attributes for a codespace", |
31604 | | - "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.", |
| 31604 | + "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.", |
31605 | 31605 | "tags": [ |
31606 | 31606 | "codespaces" |
31607 | 31607 | ], |
|
31700 | 31700 | "/repos/{owner}/{repo}/codespaces/permissions_check": { |
31701 | 31701 | "get": { |
31702 | 31702 | "summary": "Check if permissions defined by a devcontainer have been accepted by the authenticated user", |
31703 | | - "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.", |
| 31703 | + "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.", |
31704 | 31704 | "tags": [ |
31705 | 31705 | "codespaces" |
31706 | 31706 | ], |
|
45498 | 45498 | "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { |
45499 | 45499 | "post": { |
45500 | 45500 | "summary": "Create a codespace from a pull request", |
45501 | | - "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.", |
| 45501 | + "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.", |
45502 | 45502 | "tags": [ |
45503 | 45503 | "codespaces" |
45504 | 45504 | ], |
|
55654 | 55654 | "/user/codespaces": { |
55655 | 55655 | "get": { |
55656 | 55656 | "summary": "List codespaces for the authenticated user", |
55657 | | - "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.", |
| 55657 | + "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.", |
55658 | 55658 | "tags": [ |
55659 | 55659 | "codespaces" |
55660 | 55660 | ], |
|
55730 | 55730 | }, |
55731 | 55731 | "post": { |
55732 | 55732 | "summary": "Create a codespace for the authenticated user", |
55733 | | - "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.", |
| 55733 | + "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.", |
55734 | 55734 | "tags": [ |
55735 | 55735 | "codespaces" |
55736 | 55736 | ], |
|
56442 | 56442 | "/user/codespaces/{codespace_name}": { |
56443 | 56443 | "get": { |
56444 | 56444 | "summary": "Get a codespace for the authenticated user", |
56445 | | - "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.", |
| 56445 | + "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.", |
56446 | 56446 | "tags": [ |
56447 | 56447 | "codespaces" |
56448 | 56448 | ], |
|
56497 | 56497 | }, |
56498 | 56498 | "patch": { |
56499 | 56499 | "summary": "Update a codespace for the authenticated user", |
56500 | | - "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.", |
| 56500 | + "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.", |
56501 | 56501 | "tags": [ |
56502 | 56502 | "codespaces" |
56503 | 56503 | ], |
|
56580 | 56580 | }, |
56581 | 56581 | "delete": { |
56582 | 56582 | "summary": "Delete a codespace for the authenticated user", |
56583 | | - "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.", |
| 56583 | + "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.", |
56584 | 56584 | "tags": [ |
56585 | 56585 | "codespaces" |
56586 | 56586 | ], |
|
56802 | 56802 | "/user/codespaces/{codespace_name}/publish": { |
56803 | 56803 | "post": { |
56804 | 56804 | "summary": "Create a repository from an unpublished codespace", |
56805 | | - "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.", |
| 56805 | + "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.", |
56806 | 56806 | "tags": [ |
56807 | 56807 | "codespaces" |
56808 | 56808 | ], |
|
0 commit comments