You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Sources/codespaces/Client.swift
+44-11Lines changed: 44 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -1869,7 +1869,10 @@ public struct Client: APIProtocol {
1869
1869
///
1870
1870
/// You must authenticate using an access token with the `codespace` scope to use this endpoint.
1871
1871
///
1872
-
/// GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
1872
+
/// To use this endpoint with GitHub Apps:
1873
+
///
1874
+
/// - 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)."
1875
+
/// - The app must have read access to the `codespaces` repository permission.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/get(codespaces/list-in-repository-for-authenticated-user)`.
@@ -2040,7 +2043,10 @@ public struct Client: APIProtocol {
2040
2043
///
2041
2044
/// You must authenticate using an access token with the `codespace` scope to use this endpoint.
2042
2045
///
2043
-
/// GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
2046
+
/// To use this endpoint with GitHub Apps:
2047
+
///
2048
+
/// - 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)."
2049
+
/// - The app must have write access to the `codespaces` repository permission.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/post(codespaces/create-with-repo-for-authenticated-user)`.
@@ -2642,7 +2648,10 @@ public struct Client: APIProtocol {
2642
2648
///
2643
2649
/// You must authenticate using an access token with the `codespace` scope to use this endpoint.
2644
2650
///
2645
-
/// GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
2651
+
/// To use this endpoint with GitHub Apps:
2652
+
///
2653
+
/// - 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)."
2654
+
/// - The app must have write access to the `codespaces` repository permission.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/new/get(codespaces/pre-flight-with-repo-for-authenticated-user)`.
@@ -2791,7 +2800,10 @@ public struct Client: APIProtocol {
2791
2800
///
2792
2801
/// You must authenticate using an access token with the `codespace` scope to use this endpoint.
2793
2802
///
2794
-
/// GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
2803
+
/// To use this endpoint with GitHub Apps:
2804
+
///
2805
+
/// - 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)."
2806
+
/// - The app must have write access to the `codespaces` repository permission.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/permissions_check/get(codespaces/check-permissions-for-devcontainer)`.
@@ -3326,7 +3338,10 @@ public struct Client: APIProtocol {
3326
3338
///
3327
3339
/// You must authenticate using an access token with the `codespace` scope to use this endpoint.
3328
3340
///
3329
-
/// GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
3341
+
/// To use this endpoint with GitHub Apps:
3342
+
///
3343
+
/// - 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)."
3344
+
/// - The app must have write access to the `codespaces` repository permission.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pulls/{pull_number}/codespaces/post(codespaces/create-with-pr-for-authenticated-user)`.
@@ -3515,7 +3530,10 @@ public struct Client: APIProtocol {
3515
3530
///
3516
3531
/// You must authenticate using an access token with the `codespace` scope to use this endpoint.
3517
3532
///
3518
-
/// GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
3533
+
/// To use this endpoint with GitHub Apps:
3534
+
///
3535
+
/// - 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)."
3536
+
/// - The app must have read access to the `codespaces` repository permission.
3519
3537
///
3520
3538
/// - Remark: HTTP `GET /user/codespaces`.
3521
3539
/// - Remark: Generated from `#/paths//user/codespaces/get(codespaces/list-for-authenticated-user)`.
@@ -3694,7 +3712,10 @@ public struct Client: APIProtocol {
3694
3712
///
3695
3713
/// You must authenticate using an access token with the `codespace` scope to use this endpoint.
3696
3714
///
3697
-
/// GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
3715
+
/// To use this endpoint with GitHub Apps:
3716
+
///
3717
+
/// - 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)."
3718
+
/// - The app must have write access to the `codespaces` repository permission.
3698
3719
///
3699
3720
/// - Remark: HTTP `POST /user/codespaces`.
3700
3721
/// - Remark: Generated from `#/paths//user/codespaces/post(codespaces/create-for-authenticated-user)`.
@@ -4841,7 +4862,10 @@ public struct Client: APIProtocol {
4841
4862
///
4842
4863
/// You must authenticate using an access token with the `codespace` scope to use this endpoint.
4843
4864
///
4844
-
/// GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
4865
+
/// To use this endpoint with GitHub Apps:
4866
+
///
4867
+
/// - 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)."
4868
+
/// - The app must have read access to the `codespaces` repository permission.
/// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/get(codespaces/get-for-authenticated-user)`.
@@ -5001,7 +5025,10 @@ public struct Client: APIProtocol {
5001
5025
///
5002
5026
/// You must authenticate using an access token with the `codespace` scope to use this endpoint.
5003
5027
///
5004
-
/// GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
5028
+
/// To use this endpoint with GitHub Apps:
5029
+
///
5030
+
/// - 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)."
5031
+
/// - The app must have write access to the `codespaces` repository permission.
/// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/patch(codespaces/update-for-authenticated-user)`.
@@ -5146,7 +5173,10 @@ public struct Client: APIProtocol {
5146
5173
///
5147
5174
/// You must authenticate using an access token with the `codespace` scope to use this endpoint.
5148
5175
///
5149
-
/// GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
5176
+
/// To use this endpoint with GitHub Apps:
5177
+
///
5178
+
/// - 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)."
5179
+
/// - The app must have write access to the `codespaces` repository permission.
/// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/delete(codespaces/delete-for-authenticated-user)`.
@@ -5737,7 +5767,10 @@ public struct Client: APIProtocol {
5737
5767
///
5738
5768
/// You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
5739
5769
///
5740
-
/// GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
5770
+
/// To use this endpoint with GitHub Apps:
5771
+
///
5772
+
/// - 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)."
5773
+
/// - The app must have write access to the `codespaces` repository permission.
0 commit comments