@octokit/openapi 7.0.0 → 7.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/generated/api.github.com.deref.json +1523 -250
  2. package/generated/api.github.com.json +803 -61
  3. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
  4. package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
  5. package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +17 -8
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +9 -8
  7. package/generated/ghes-3.2.deref.json +1108 -313
  8. package/generated/ghes-3.2.json +451 -31
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +16 -0
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +209 -1
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +9 -1
  12. package/generated/ghes-3.3.deref.json +1108 -313
  13. package/generated/ghes-3.3.json +451 -31
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -8
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -8
  16. package/generated/ghes-3.4.deref.json +1092 -313
  17. package/generated/ghes-3.4.json +451 -31
  18. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  19. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  20. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +17 -8
  21. package/generated/ghes-3.5-diff-to-ghes-3.6.json +9 -8
  22. package/generated/ghes-3.5.deref.json +1094 -315
  23. package/generated/ghes-3.5.json +453 -33
  24. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +94 -56
  25. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +89 -164
  26. package/generated/ghes-3.6-diff-to-api.github.com.json +9 -130
  27. package/generated/ghes-3.6.deref.json +1299 -488
  28. package/generated/ghes-3.6.json +499 -47
  29. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +38 -0
  30. package/generated/github.ae-diff-to-api.github.com.deref.json +49 -8
  31. package/generated/github.ae-diff-to-api.github.com.json +9 -8
  32. package/generated/github.ae.deref.json +783 -32
  33. package/generated/github.ae.json +495 -31
  34. package/index.js +2 -0
  35. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.0.0",
4
+ "version": "7.3.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -91,6 +91,10 @@
91
91
  "name": "markdown",
92
92
  "description": "Render GitHub flavored markdown"
93
93
  },
94
+ {
95
+ "name": "merge-queue",
96
+ "description": "Interact with GitHub Merge Queues."
97
+ },
94
98
  {
95
99
  "name": "meta",
96
100
  "description": "Endpoints that give information about the API."
@@ -99,10 +103,6 @@
99
103
  "name": "migrations",
100
104
  "description": "Move projects to or from GitHub."
101
105
  },
102
- {
103
- "name": "oauth-authorizations",
104
- "description": "Manage access of OAuth applications"
105
- },
106
106
  {
107
107
  "name": "oidc",
108
108
  "description": "Endpoints to manage GitHub OIDC configuration using the REST API."
@@ -2487,6 +2487,14 @@
2487
2487
  "write"
2488
2488
  ]
2489
2489
  },
2490
+ "organization_custom_roles": {
2491
+ "type": "string",
2492
+ "description": "The level of permission to grant the access token for custom roles management.",
2493
+ "enum": [
2494
+ "read",
2495
+ "write"
2496
+ ]
2497
+ },
2490
2498
  "deployments": {
2491
2499
  "type": "string",
2492
2500
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -3276,6 +3284,14 @@
3276
3284
  "write"
3277
3285
  ]
3278
3286
  },
3287
+ "organization_custom_roles": {
3288
+ "type": "string",
3289
+ "description": "The level of permission to grant the access token for custom roles management.",
3290
+ "enum": [
3291
+ "read",
3292
+ "write"
3293
+ ]
3294
+ },
3279
3295
  "deployments": {
3280
3296
  "type": "string",
3281
3297
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -3929,6 +3945,14 @@
3929
3945
  "write"
3930
3946
  ]
3931
3947
  },
3948
+ "organization_custom_roles": {
3949
+ "type": "string",
3950
+ "description": "The level of permission to grant the access token for custom roles management.",
3951
+ "enum": [
3952
+ "read",
3953
+ "write"
3954
+ ]
3955
+ },
3932
3956
  "deployments": {
3933
3957
  "type": "string",
3934
3958
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -4150,7 +4174,7 @@
4150
4174
  "examples": {
4151
4175
  "default": {
4152
4176
  "value": {
4153
- "respoitory": "Hello-World",
4177
+ "repository": "Hello-World",
4154
4178
  "permissions": {
4155
4179
  "issues": "write",
4156
4180
  "contents": "read"
@@ -4214,6 +4238,14 @@
4214
4238
  "write"
4215
4239
  ]
4216
4240
  },
4241
+ "organization_custom_roles": {
4242
+ "type": "string",
4243
+ "description": "The level of permission to grant the access token for custom roles management.",
4244
+ "enum": [
4245
+ "read",
4246
+ "write"
4247
+ ]
4248
+ },
4217
4249
  "deployments": {
4218
4250
  "type": "string",
4219
4251
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -6441,6 +6473,14 @@
6441
6473
  "write"
6442
6474
  ]
6443
6475
  },
6476
+ "organization_custom_roles": {
6477
+ "type": "string",
6478
+ "description": "The level of permission to grant the access token for custom roles management.",
6479
+ "enum": [
6480
+ "read",
6481
+ "write"
6482
+ ]
6483
+ },
6444
6484
  "deployments": {
6445
6485
  "type": "string",
6446
6486
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -7284,6 +7324,14 @@
7284
7324
  "write"
7285
7325
  ]
7286
7326
  },
7327
+ "organization_custom_roles": {
7328
+ "type": "string",
7329
+ "description": "The level of permission to grant the access token for custom roles management.",
7330
+ "enum": [
7331
+ "read",
7332
+ "write"
7333
+ ]
7334
+ },
7287
7335
  "deployments": {
7288
7336
  "type": "string",
7289
7337
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -8051,6 +8099,14 @@
8051
8099
  "write"
8052
8100
  ]
8053
8101
  },
8102
+ "organization_custom_roles": {
8103
+ "type": "string",
8104
+ "description": "The level of permission to grant the access token for custom roles management.",
8105
+ "enum": [
8106
+ "read",
8107
+ "write"
8108
+ ]
8109
+ },
8054
8110
  "deployments": {
8055
8111
  "type": "string",
8056
8112
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -8526,6 +8582,14 @@
8526
8582
  "write"
8527
8583
  ]
8528
8584
  },
8585
+ "organization_custom_roles": {
8586
+ "type": "string",
8587
+ "description": "The level of permission to grant the access token for custom roles management.",
8588
+ "enum": [
8589
+ "read",
8590
+ "write"
8591
+ ]
8592
+ },
8529
8593
  "deployments": {
8530
8594
  "type": "string",
8531
8595
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -19823,6 +19887,328 @@
19823
19887
  "x-octokit": {}
19824
19888
  }
19825
19889
  },
19890
+ "/enterprises/{enterprise}/consumed-licenses": {
19891
+ "get": {
19892
+ "summary": "List enterprise consumed licenses",
19893
+ "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
19894
+ "tags": [
19895
+ "enterprise-admin"
19896
+ ],
19897
+ "operationId": "enterprise-admin/get-consumed-licenses",
19898
+ "externalDocs": {
19899
+ "description": "API method documentation",
19900
+ "url": "https://docs.github.com/rest/reference/enterprise-admin#list-enterprise-consumed-licenses"
19901
+ },
19902
+ "parameters": [
19903
+ {
19904
+ "name": "enterprise",
19905
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
19906
+ "in": "path",
19907
+ "required": true,
19908
+ "schema": {
19909
+ "type": "string"
19910
+ }
19911
+ },
19912
+ {
19913
+ "name": "per_page",
19914
+ "description": "The number of results per page (max 100).",
19915
+ "in": "query",
19916
+ "schema": {
19917
+ "type": "integer",
19918
+ "default": 30
19919
+ }
19920
+ },
19921
+ {
19922
+ "name": "page",
19923
+ "description": "Page number of the results to fetch.",
19924
+ "in": "query",
19925
+ "schema": {
19926
+ "type": "integer",
19927
+ "default": 1
19928
+ }
19929
+ }
19930
+ ],
19931
+ "responses": {
19932
+ "200": {
19933
+ "description": "Consumed Licenses Response",
19934
+ "content": {
19935
+ "application/json": {
19936
+ "schema": {
19937
+ "title": "Enterprise Consumed Licenses",
19938
+ "description": "A breakdown of the licenses consumed by an enterprise.",
19939
+ "properties": {
19940
+ "total_seats_consumed": {
19941
+ "type": "integer"
19942
+ },
19943
+ "total_seats_purchased": {
19944
+ "type": "integer"
19945
+ },
19946
+ "users": {
19947
+ "type": "array",
19948
+ "items": {
19949
+ "type": "object",
19950
+ "properties": {
19951
+ "github_com_login": {
19952
+ "type": "string"
19953
+ },
19954
+ "github_com_name": {
19955
+ "type": "string",
19956
+ "nullable": true
19957
+ },
19958
+ "github_com_profile": {
19959
+ "type": "string",
19960
+ "nullable": true
19961
+ },
19962
+ "license_type": {
19963
+ "type": "string"
19964
+ },
19965
+ "github_com_member_roles": {
19966
+ "type": "array",
19967
+ "items": {
19968
+ "type": "string"
19969
+ }
19970
+ },
19971
+ "github_com_enterprise_role": {
19972
+ "type": "string",
19973
+ "nullable": true
19974
+ },
19975
+ "visual_studio_subscription_user": {
19976
+ "type": "boolean"
19977
+ },
19978
+ "github_com_verified_domain_emails": {
19979
+ "type": "array",
19980
+ "items": {
19981
+ "type": "string"
19982
+ }
19983
+ },
19984
+ "github_com_saml_name_id": {
19985
+ "type": "string",
19986
+ "nullable": true
19987
+ },
19988
+ "enterprise_server_user": {
19989
+ "type": "boolean",
19990
+ "nullable": true
19991
+ },
19992
+ "enterprise_server_emails": {
19993
+ "type": "array",
19994
+ "items": {
19995
+ "type": "string"
19996
+ }
19997
+ },
19998
+ "github_com_user": {
19999
+ "type": "boolean"
20000
+ },
20001
+ "total_user_accounts": {
20002
+ "type": "integer"
20003
+ },
20004
+ "enterprise_server_user_ids": {
20005
+ "type": "array",
20006
+ "items": {
20007
+ "type": "string"
20008
+ }
20009
+ },
20010
+ "github_com_orgs_with_pending_invites": {
20011
+ "type": "array",
20012
+ "items": {
20013
+ "type": "string"
20014
+ }
20015
+ },
20016
+ "visual_studio_subscription_email": {
20017
+ "type": "string",
20018
+ "nullable": true
20019
+ }
20020
+ }
20021
+ }
20022
+ }
20023
+ }
20024
+ },
20025
+ "examples": {
20026
+ "default": {
20027
+ "value": {
20028
+ "total_seats_consumed": 5000,
20029
+ "total_seats_purchased": 4500,
20030
+ "users": [
20031
+ {
20032
+ "enterprise_server_emails": [
20033
+ "monalisa@github.com"
20034
+ ],
20035
+ "github_com_login": "monalisa",
20036
+ "github_com_name": "Mona Lisa",
20037
+ "github_com_profile": "https://github.com/monalisa",
20038
+ "license_type": "enterprise",
20039
+ "github_com_member_roles": [
20040
+ "org1:Owner",
20041
+ "org2:Owner"
20042
+ ],
20043
+ "github_com_enterprise_role": "owner",
20044
+ "visual_studio_subscription_user": false,
20045
+ "github_com_verified_domain_emails": [
20046
+ "monalisa@github.com"
20047
+ ],
20048
+ "github_com_saml_name_id": "monalisa",
20049
+ "enterprise_server_user": true,
20050
+ "github_com_user": true,
20051
+ "total_user_accounts": 3,
20052
+ "enterprise_server_user_ids": [
20053
+ "example_host_name.com:123",
20054
+ "example_host_name_2:222"
20055
+ ],
20056
+ "github_com_orgs_with_pending_invites": [
20057
+ "org1",
20058
+ "org2"
20059
+ ],
20060
+ "visual_studio_subscription_email": ""
20061
+ },
20062
+ {
20063
+ "enterprise_server_emails": [
20064
+ "deleonjavier@example.com"
20065
+ ],
20066
+ "github_com_login": "",
20067
+ "github_com_name": "",
20068
+ "github_com_profile": "",
20069
+ "license_type": "enterprise",
20070
+ "github_com_member_roles": [],
20071
+ "github_com_enterprise_role": "",
20072
+ "visual_studio_subscription_user": false,
20073
+ "github_com_verified_domain_emails": [],
20074
+ "github_com_saml_name_id": "",
20075
+ "enterprise_server_user": true,
20076
+ "github_com_user": false,
20077
+ "total_user_accounts": 1,
20078
+ "enterprise_server_user_ids": [
20079
+ "example_host_name:123"
20080
+ ],
20081
+ "github_com_orgs_with_pending_invites": [],
20082
+ "visual_studio_subscription_email": ""
20083
+ }
20084
+ ]
20085
+ }
20086
+ }
20087
+ }
20088
+ }
20089
+ },
20090
+ "headers": {
20091
+ "Link": {
20092
+ "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
20093
+ "schema": {
20094
+ "type": "string"
20095
+ }
20096
+ }
20097
+ }
20098
+ }
20099
+ },
20100
+ "x-github": {
20101
+ "githubCloudOnly": true,
20102
+ "enabledForGitHubApps": false,
20103
+ "previews": [],
20104
+ "category": "enterprise-admin",
20105
+ "subcategory": "license"
20106
+ },
20107
+ "x-octokit": {}
20108
+ }
20109
+ },
20110
+ "/enterprises/{enterprise}/license-sync-status": {
20111
+ "get": {
20112
+ "summary": "Get a license sync status",
20113
+ "description": "Gets information about the status of a license sync job for an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
20114
+ "tags": [
20115
+ "enterprise-admin"
20116
+ ],
20117
+ "operationId": "enterprise-admin/get-license-sync-status",
20118
+ "externalDocs": {
20119
+ "description": "API method documentation",
20120
+ "url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-license-sync-status"
20121
+ },
20122
+ "parameters": [
20123
+ {
20124
+ "name": "enterprise",
20125
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
20126
+ "in": "path",
20127
+ "required": true,
20128
+ "schema": {
20129
+ "type": "string"
20130
+ }
20131
+ }
20132
+ ],
20133
+ "responses": {
20134
+ "200": {
20135
+ "description": "License Sync Status Response",
20136
+ "content": {
20137
+ "application/json": {
20138
+ "schema": {
20139
+ "title": "License Sync Status",
20140
+ "description": "Information about the status of a license sync job for an enterprise.",
20141
+ "properties": {
20142
+ "server_instances": {
20143
+ "type": "array",
20144
+ "items": {
20145
+ "type": "object",
20146
+ "properties": {
20147
+ "server_id": {
20148
+ "type": "string"
20149
+ },
20150
+ "hostname": {
20151
+ "type": "string"
20152
+ },
20153
+ "last_sync": {
20154
+ "type": "object",
20155
+ "properties": {
20156
+ "date": {
20157
+ "type": "string"
20158
+ },
20159
+ "status": {
20160
+ "type": "string"
20161
+ },
20162
+ "error": {
20163
+ "type": "string"
20164
+ }
20165
+ }
20166
+ }
20167
+ }
20168
+ }
20169
+ }
20170
+ }
20171
+ },
20172
+ "examples": {
20173
+ "default": {
20174
+ "value": {
20175
+ "server_instances": [
20176
+ {
20177
+ "server_id": "deadbeef1",
20178
+ "hostname": "github.example.com",
20179
+ "last_sync": {
20180
+ "date": "2020-01-01T00:00:00Z",
20181
+ "status": "success",
20182
+ "error": ""
20183
+ }
20184
+ },
20185
+ {
20186
+ "server_id": "filetoffish1",
20187
+ "hostname": "github2.example.com",
20188
+ "last_sync": {
20189
+ "date": "2020-01-01T00:00:00Z",
20190
+ "status": "success",
20191
+ "error": ""
20192
+ }
20193
+ }
20194
+ ]
20195
+ }
20196
+ }
20197
+ }
20198
+ }
20199
+ }
20200
+ }
20201
+ },
20202
+ "x-github": {
20203
+ "githubCloudOnly": true,
20204
+ "enabledForGitHubApps": false,
20205
+ "previews": [],
20206
+ "category": "enterprise-admin",
20207
+ "subcategory": "license"
20208
+ },
20209
+ "x-octokit": {}
20210
+ }
20211
+ },
19826
20212
  "/enterprises/{enterprise}/secret-scanning/alerts": {
19827
20213
  "get": {
19828
20214
  "summary": "List secret scanning alerts for an enterprise",
@@ -67482,6 +67868,19 @@
67482
67868
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
67483
67869
  "type": "string",
67484
67870
  "nullable": true
67871
+ },
67872
+ "retention_period_minutes": {
67873
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
67874
+ "type": "integer",
67875
+ "example": 60,
67876
+ "nullable": true
67877
+ },
67878
+ "retention_expires_at": {
67879
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
67880
+ "type": "string",
67881
+ "format": "date-time",
67882
+ "example": "2011-01-26T20:01:12Z",
67883
+ "nullable": true
67485
67884
  }
67486
67885
  },
67487
67886
  "required": [
@@ -77244,6 +77643,14 @@
77244
77643
  "write"
77245
77644
  ]
77246
77645
  },
77646
+ "organization_custom_roles": {
77647
+ "type": "string",
77648
+ "description": "The level of permission to grant the access token for custom roles management.",
77649
+ "enum": [
77650
+ "read",
77651
+ "write"
77652
+ ]
77653
+ },
77247
77654
  "deployments": {
77248
77655
  "type": "string",
77249
77656
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -78047,6 +78454,14 @@
78047
78454
  "write"
78048
78455
  ]
78049
78456
  },
78457
+ "organization_custom_roles": {
78458
+ "type": "string",
78459
+ "description": "The level of permission to grant the access token for custom roles management.",
78460
+ "enum": [
78461
+ "read",
78462
+ "write"
78463
+ ]
78464
+ },
78050
78465
  "deployments": {
78051
78466
  "type": "string",
78052
78467
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -85596,6 +86011,19 @@
85596
86011
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
85597
86012
  "type": "string",
85598
86013
  "nullable": true
86014
+ },
86015
+ "retention_period_minutes": {
86016
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
86017
+ "type": "integer",
86018
+ "example": 60,
86019
+ "nullable": true
86020
+ },
86021
+ "retention_expires_at": {
86022
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
86023
+ "type": "string",
86024
+ "format": "date-time",
86025
+ "example": "2011-01-26T20:01:12Z",
86026
+ "nullable": true
85599
86027
  }
85600
86028
  },
85601
86029
  "required": [
@@ -85762,6 +86190,8 @@
85762
86190
  },
85763
86191
  "location": "WestUs2",
85764
86192
  "idle_timeout_minutes": 60,
86193
+ "retention_period_minutes": "43200,",
86194
+ "retention_expires_at": "null,",
85765
86195
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
85766
86196
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
85767
86197
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -119239,14 +119669,7 @@
119239
119669
  "properties": {
119240
119670
  "permission": {
119241
119671
  "type": "string",
119242
- "description": "The permission to grant the team on this repository. In addition to the enumerated values, you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.",
119243
- "enum": [
119244
- "pull",
119245
- "push",
119246
- "admin",
119247
- "maintain",
119248
- "triage"
119249
- ],
119672
+ "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.",
119250
119673
  "default": "push"
119251
119674
  }
119252
119675
  }
@@ -137576,7 +137999,7 @@
137576
137999
  "/repos/{owner}/{repo}/actions/permissions/access": {
137577
138000
  "get": {
137578
138001
  "summary": "Get the level of access for workflows outside of the repository",
137579
- "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" for GitHub.com and\n\"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)\" for GitHub Enterprise Cloud.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
138002
+ "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
137580
138003
  "tags": [
137581
138004
  "actions"
137582
138005
  ],
@@ -137618,7 +138041,6 @@
137618
138041
  "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository.",
137619
138042
  "enum": [
137620
138043
  "none",
137621
- "user",
137622
138044
  "organization",
137623
138045
  "enterprise"
137624
138046
  ]
@@ -137650,7 +138072,7 @@
137650
138072
  },
137651
138073
  "put": {
137652
138074
  "summary": "Set the level of access for workflows outside of the repository",
137653
- "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" for GitHub.com and\n\"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)\" for GitHub Enterprise Cloud.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
138075
+ "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
137654
138076
  "tags": [
137655
138077
  "actions"
137656
138078
  ],
@@ -137691,7 +138113,6 @@
137691
138113
  "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository.",
137692
138114
  "enum": [
137693
138115
  "none",
137694
- "user",
137695
138116
  "organization",
137696
138117
  "enterprise"
137697
138118
  ]
@@ -204834,6 +205255,19 @@
204834
205255
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
204835
205256
  "type": "string",
204836
205257
  "nullable": true
205258
+ },
205259
+ "retention_period_minutes": {
205260
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
205261
+ "type": "integer",
205262
+ "example": 60,
205263
+ "nullable": true
205264
+ },
205265
+ "retention_expires_at": {
205266
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
205267
+ "type": "string",
205268
+ "format": "date-time",
205269
+ "example": "2011-01-26T20:01:12Z",
205270
+ "nullable": true
204837
205271
  }
204838
205272
  },
204839
205273
  "required": [
@@ -205359,8 +205793,8 @@
205359
205793
  "examples": {
205360
205794
  "default": {
205361
205795
  "value": {
205362
- "repository_id": 1,
205363
- "ref": "main"
205796
+ "ref": "main",
205797
+ "machine": "standardLinux32gb"
205364
205798
  }
205365
205799
  }
205366
205800
  }
@@ -207541,6 +207975,19 @@
207541
207975
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
207542
207976
  "type": "string",
207543
207977
  "nullable": true
207978
+ },
207979
+ "retention_period_minutes": {
207980
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
207981
+ "type": "integer",
207982
+ "example": 60,
207983
+ "nullable": true
207984
+ },
207985
+ "retention_expires_at": {
207986
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
207987
+ "type": "string",
207988
+ "format": "date-time",
207989
+ "example": "2011-01-26T20:01:12Z",
207990
+ "nullable": true
207544
207991
  }
207545
207992
  },
207546
207993
  "required": [
@@ -207707,6 +208154,8 @@
207707
208154
  },
207708
208155
  "location": "WestUs2",
207709
208156
  "idle_timeout_minutes": 60,
208157
+ "retention_period_minutes": "43200,",
208158
+ "retention_expires_at": "null,",
207710
208159
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
207711
208160
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
207712
208161
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -209892,6 +210341,19 @@
209892
210341
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
209893
210342
  "type": "string",
209894
210343
  "nullable": true
210344
+ },
210345
+ "retention_period_minutes": {
210346
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
210347
+ "type": "integer",
210348
+ "example": 60,
210349
+ "nullable": true
210350
+ },
210351
+ "retention_expires_at": {
210352
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
210353
+ "type": "string",
210354
+ "format": "date-time",
210355
+ "example": "2011-01-26T20:01:12Z",
210356
+ "nullable": true
209895
210357
  }
209896
210358
  },
209897
210359
  "required": [
@@ -210058,6 +210520,8 @@
210058
210520
  },
210059
210521
  "location": "WestUs2",
210060
210522
  "idle_timeout_minutes": 60,
210523
+ "retention_period_minutes": "43200,",
210524
+ "retention_expires_at": "null,",
210061
210525
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
210062
210526
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
210063
210527
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -210070,201 +210534,261 @@
210070
210534
  }
210071
210535
  }
210072
210536
  },
210073
- "401": {
210074
- "description": "Requires authentication",
210075
- "content": {
210076
- "application/json": {
210077
- "schema": {
210078
- "title": "Basic Error",
210079
- "description": "Basic Error",
210080
- "type": "object",
210081
- "properties": {
210082
- "message": {
210083
- "type": "string"
210084
- },
210085
- "documentation_url": {
210086
- "type": "string"
210087
- },
210088
- "url": {
210089
- "type": "string"
210090
- },
210091
- "status": {
210092
- "type": "string"
210093
- }
210094
- }
210095
- }
210096
- }
210097
- }
210098
- },
210099
- "403": {
210100
- "description": "Forbidden",
210101
- "content": {
210102
- "application/json": {
210103
- "schema": {
210104
- "title": "Basic Error",
210105
- "description": "Basic Error",
210106
- "type": "object",
210107
- "properties": {
210108
- "message": {
210109
- "type": "string"
210110
- },
210111
- "documentation_url": {
210112
- "type": "string"
210113
- },
210114
- "url": {
210115
- "type": "string"
210116
- },
210117
- "status": {
210118
- "type": "string"
210119
- }
210120
- }
210121
- }
210122
- }
210123
- }
210124
- },
210125
- "404": {
210126
- "description": "Resource not found",
210127
- "content": {
210128
- "application/json": {
210129
- "schema": {
210130
- "title": "Basic Error",
210131
- "description": "Basic Error",
210132
- "type": "object",
210133
- "properties": {
210134
- "message": {
210135
- "type": "string"
210136
- },
210137
- "documentation_url": {
210138
- "type": "string"
210139
- },
210140
- "url": {
210141
- "type": "string"
210142
- },
210143
- "status": {
210144
- "type": "string"
210145
- }
210146
- }
210147
- }
210148
- }
210149
- }
210150
- }
210151
- },
210152
- "x-github": {
210153
- "githubCloudOnly": false,
210154
- "enabledForGitHubApps": false,
210155
- "category": "codespaces",
210156
- "subcategory": null
210157
- },
210158
- "x-octokit": {}
210159
- }
210160
- },
210161
- "/repos/{owner}/{repo}/codespaces/devcontainers": {
210162
- "get": {
210163
- "summary": "List devcontainer configurations in a repository for the authenticated user",
210164
- "description": "Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files\nspecify launchpoint configurations for codespaces created within the repository.\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_metadata` repository permission to use this endpoint.",
210165
- "tags": [
210166
- "codespaces"
210167
- ],
210168
- "operationId": "codespaces/list-devcontainers-in-repository-for-authenticated-user",
210169
- "externalDocs": {
210170
- "description": "API method documentation",
210171
- "url": "https://docs.github.com/rest/reference/codespaces#list-devcontainers-in-a-repository-for-the-authenticated-user"
210172
- },
210173
- "parameters": [
210174
- {
210175
- "name": "per_page",
210176
- "description": "The number of results per page (max 100).",
210177
- "in": "query",
210178
- "schema": {
210179
- "type": "integer",
210180
- "default": 30
210181
- }
210182
- },
210183
- {
210184
- "name": "page",
210185
- "description": "Page number of the results to fetch.",
210186
- "in": "query",
210187
- "schema": {
210188
- "type": "integer",
210189
- "default": 1
210190
- }
210191
- },
210192
- {
210193
- "name": "owner",
210194
- "description": "The account owner of the repository. The name is not case sensitive.",
210195
- "in": "path",
210196
- "required": true,
210197
- "schema": {
210198
- "type": "string"
210199
- }
210200
- },
210201
- {
210202
- "name": "repo",
210203
- "description": "The name of the repository. The name is not case sensitive.",
210204
- "in": "path",
210205
- "required": true,
210206
- "schema": {
210207
- "type": "string"
210208
- }
210209
- }
210210
- ],
210211
- "responses": {
210212
- "200": {
210213
- "description": "Response",
210214
- "content": {
210215
- "application/json": {
210216
- "schema": {
210217
- "type": "object",
210218
- "required": [
210219
- "total_count",
210220
- "devcontainers"
210221
- ],
210222
- "properties": {
210223
- "total_count": {
210224
- "type": "integer"
210225
- },
210226
- "devcontainers": {
210227
- "type": "array",
210228
- "items": {
210229
- "type": "object",
210230
- "required": [
210231
- "path"
210232
- ],
210233
- "properties": {
210234
- "path": {
210235
- "type": "string"
210236
- },
210237
- "name": {
210238
- "type": "string"
210239
- }
210240
- }
210241
- }
210242
- }
210243
- }
210244
- },
210245
- "examples": {
210246
- "default": {
210247
- "value": {
210248
- "devcontainers": [
210249
- {
210250
- "path": ".devcontainer/foobar/devcontainer.json",
210251
- "name": "foobar"
210252
- },
210253
- {
210254
- "path": ".devcontainer/devcontainer.json",
210255
- "name": "kitchensink"
210256
- },
210257
- {
210258
- "path": ".devcontainer.json"
210259
- }
210260
- ],
210261
- "total_count": 3
210262
- }
210263
- }
210264
- }
210265
- }
210266
- }
210267
- },
210537
+ "400": {
210538
+ "description": "Bad Request",
210539
+ "content": {
210540
+ "application/json": {
210541
+ "schema": {
210542
+ "title": "Basic Error",
210543
+ "description": "Basic Error",
210544
+ "type": "object",
210545
+ "properties": {
210546
+ "message": {
210547
+ "type": "string"
210548
+ },
210549
+ "documentation_url": {
210550
+ "type": "string"
210551
+ },
210552
+ "url": {
210553
+ "type": "string"
210554
+ },
210555
+ "status": {
210556
+ "type": "string"
210557
+ }
210558
+ }
210559
+ }
210560
+ },
210561
+ "application/scim+json": {
210562
+ "schema": {
210563
+ "title": "Scim Error",
210564
+ "description": "Scim Error",
210565
+ "type": "object",
210566
+ "properties": {
210567
+ "message": {
210568
+ "type": "string",
210569
+ "nullable": true
210570
+ },
210571
+ "documentation_url": {
210572
+ "type": "string",
210573
+ "nullable": true
210574
+ },
210575
+ "detail": {
210576
+ "type": "string",
210577
+ "nullable": true
210578
+ },
210579
+ "status": {
210580
+ "type": "integer"
210581
+ },
210582
+ "scimType": {
210583
+ "type": "string",
210584
+ "nullable": true
210585
+ },
210586
+ "schemas": {
210587
+ "type": "array",
210588
+ "items": {
210589
+ "type": "string"
210590
+ }
210591
+ }
210592
+ }
210593
+ }
210594
+ }
210595
+ }
210596
+ },
210597
+ "401": {
210598
+ "description": "Requires authentication",
210599
+ "content": {
210600
+ "application/json": {
210601
+ "schema": {
210602
+ "title": "Basic Error",
210603
+ "description": "Basic Error",
210604
+ "type": "object",
210605
+ "properties": {
210606
+ "message": {
210607
+ "type": "string"
210608
+ },
210609
+ "documentation_url": {
210610
+ "type": "string"
210611
+ },
210612
+ "url": {
210613
+ "type": "string"
210614
+ },
210615
+ "status": {
210616
+ "type": "string"
210617
+ }
210618
+ }
210619
+ }
210620
+ }
210621
+ }
210622
+ },
210623
+ "403": {
210624
+ "description": "Forbidden",
210625
+ "content": {
210626
+ "application/json": {
210627
+ "schema": {
210628
+ "title": "Basic Error",
210629
+ "description": "Basic Error",
210630
+ "type": "object",
210631
+ "properties": {
210632
+ "message": {
210633
+ "type": "string"
210634
+ },
210635
+ "documentation_url": {
210636
+ "type": "string"
210637
+ },
210638
+ "url": {
210639
+ "type": "string"
210640
+ },
210641
+ "status": {
210642
+ "type": "string"
210643
+ }
210644
+ }
210645
+ }
210646
+ }
210647
+ }
210648
+ },
210649
+ "404": {
210650
+ "description": "Resource not found",
210651
+ "content": {
210652
+ "application/json": {
210653
+ "schema": {
210654
+ "title": "Basic Error",
210655
+ "description": "Basic Error",
210656
+ "type": "object",
210657
+ "properties": {
210658
+ "message": {
210659
+ "type": "string"
210660
+ },
210661
+ "documentation_url": {
210662
+ "type": "string"
210663
+ },
210664
+ "url": {
210665
+ "type": "string"
210666
+ },
210667
+ "status": {
210668
+ "type": "string"
210669
+ }
210670
+ }
210671
+ }
210672
+ }
210673
+ }
210674
+ }
210675
+ },
210676
+ "x-github": {
210677
+ "githubCloudOnly": false,
210678
+ "enabledForGitHubApps": false,
210679
+ "category": "codespaces",
210680
+ "subcategory": null
210681
+ },
210682
+ "x-octokit": {}
210683
+ }
210684
+ },
210685
+ "/repos/{owner}/{repo}/codespaces/devcontainers": {
210686
+ "get": {
210687
+ "summary": "List devcontainer configurations in a repository for the authenticated user",
210688
+ "description": "Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files\nspecify launchpoint configurations for codespaces created within the repository.\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_metadata` repository permission to use this endpoint.",
210689
+ "tags": [
210690
+ "codespaces"
210691
+ ],
210692
+ "operationId": "codespaces/list-devcontainers-in-repository-for-authenticated-user",
210693
+ "externalDocs": {
210694
+ "description": "API method documentation",
210695
+ "url": "https://docs.github.com/rest/reference/codespaces#list-devcontainers-in-a-repository-for-the-authenticated-user"
210696
+ },
210697
+ "parameters": [
210698
+ {
210699
+ "name": "per_page",
210700
+ "description": "The number of results per page (max 100).",
210701
+ "in": "query",
210702
+ "schema": {
210703
+ "type": "integer",
210704
+ "default": 30
210705
+ }
210706
+ },
210707
+ {
210708
+ "name": "page",
210709
+ "description": "Page number of the results to fetch.",
210710
+ "in": "query",
210711
+ "schema": {
210712
+ "type": "integer",
210713
+ "default": 1
210714
+ }
210715
+ },
210716
+ {
210717
+ "name": "owner",
210718
+ "description": "The account owner of the repository. The name is not case sensitive.",
210719
+ "in": "path",
210720
+ "required": true,
210721
+ "schema": {
210722
+ "type": "string"
210723
+ }
210724
+ },
210725
+ {
210726
+ "name": "repo",
210727
+ "description": "The name of the repository. The name is not case sensitive.",
210728
+ "in": "path",
210729
+ "required": true,
210730
+ "schema": {
210731
+ "type": "string"
210732
+ }
210733
+ }
210734
+ ],
210735
+ "responses": {
210736
+ "200": {
210737
+ "description": "Response",
210738
+ "content": {
210739
+ "application/json": {
210740
+ "schema": {
210741
+ "type": "object",
210742
+ "required": [
210743
+ "total_count",
210744
+ "devcontainers"
210745
+ ],
210746
+ "properties": {
210747
+ "total_count": {
210748
+ "type": "integer"
210749
+ },
210750
+ "devcontainers": {
210751
+ "type": "array",
210752
+ "items": {
210753
+ "type": "object",
210754
+ "required": [
210755
+ "path"
210756
+ ],
210757
+ "properties": {
210758
+ "path": {
210759
+ "type": "string"
210760
+ },
210761
+ "name": {
210762
+ "type": "string"
210763
+ }
210764
+ }
210765
+ }
210766
+ }
210767
+ }
210768
+ },
210769
+ "examples": {
210770
+ "default": {
210771
+ "value": {
210772
+ "devcontainers": [
210773
+ {
210774
+ "path": ".devcontainer/foobar/devcontainer.json",
210775
+ "name": "foobar"
210776
+ },
210777
+ {
210778
+ "path": ".devcontainer/devcontainer.json",
210779
+ "name": "kitchensink"
210780
+ },
210781
+ {
210782
+ "path": ".devcontainer.json"
210783
+ }
210784
+ ],
210785
+ "total_count": 3
210786
+ }
210787
+ }
210788
+ }
210789
+ }
210790
+ }
210791
+ },
210268
210792
  "400": {
210269
210793
  "description": "Bad Request",
210270
210794
  "content": {
@@ -211892,14 +212416,7 @@
211892
212416
  "properties": {
211893
212417
  "permission": {
211894
212418
  "type": "string",
211895
- "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** In addition to the enumerated values, you can also specify a custom repository role name, if the owning organization has defined any.",
211896
- "enum": [
211897
- "pull",
211898
- "push",
211899
- "admin",
211900
- "maintain",
211901
- "triage"
211902
- ],
212419
+ "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.",
211903
212420
  "default": "push"
211904
212421
  }
211905
212422
  }
@@ -232284,7 +232801,13 @@
232284
232801
  "type": "object",
232285
232802
  "properties": {
232286
232803
  "type": {
232287
- "type": "string"
232804
+ "type": "string",
232805
+ "enum": [
232806
+ "dir",
232807
+ "file",
232808
+ "submodule",
232809
+ "symlink"
232810
+ ]
232288
232811
  },
232289
232812
  "size": {
232290
232813
  "type": "integer"
@@ -232365,7 +232888,10 @@
232365
232888
  "type": "object",
232366
232889
  "properties": {
232367
232890
  "type": {
232368
- "type": "string"
232891
+ "type": "string",
232892
+ "enum": [
232893
+ "file"
232894
+ ]
232369
232895
  },
232370
232896
  "encoding": {
232371
232897
  "type": "string"
@@ -232458,7 +232984,10 @@
232458
232984
  "type": "object",
232459
232985
  "properties": {
232460
232986
  "type": {
232461
- "type": "string"
232987
+ "type": "string",
232988
+ "enum": [
232989
+ "symlink"
232990
+ ]
232462
232991
  },
232463
232992
  "target": {
232464
232993
  "type": "string"
@@ -232534,12 +233063,15 @@
232534
233063
  ]
232535
233064
  },
232536
233065
  {
232537
- "title": "Symlink Content",
232538
- "description": "An object describing a symlink",
233066
+ "title": "Submodule Content",
233067
+ "description": "An object describing a submodule",
232539
233068
  "type": "object",
232540
233069
  "properties": {
232541
233070
  "type": {
232542
- "type": "string"
233071
+ "type": "string",
233072
+ "enum": [
233073
+ "submodule"
233074
+ ]
232543
233075
  },
232544
233076
  "submodule_git_url": {
232545
233077
  "type": "string",
@@ -235059,10 +235591,8 @@
235059
235591
  },
235060
235592
  "manifests": {
235061
235593
  "type": "object",
235062
- "description": "A collection of package manifests",
235594
+ "description": "A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.",
235063
235595
  "additionalProperties": {
235064
- "title": "manifest",
235065
- "description": "A collection of related dependencies declared in a file or representing a logical group of dependencies.",
235066
235596
  "type": "object",
235067
235597
  "properties": {
235068
235598
  "name": {
@@ -235102,9 +235632,9 @@
235102
235632
  }
235103
235633
  },
235104
235634
  "resolved": {
235635
+ "type": "object",
235636
+ "description": "A collection of resolved package dependencies.",
235105
235637
  "additionalProperties": {
235106
- "title": "Dependency",
235107
- "description": "A single package dependency.",
235108
235638
  "type": "object",
235109
235639
  "properties": {
235110
235640
  "package_url": {
@@ -239469,15 +239999,15 @@
239469
239999
  },
239470
240000
  "/repos/{owner}/{repo}/environments": {
239471
240001
  "get": {
239472
- "summary": "Get all environments",
239473
- "description": "Get all environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
240002
+ "summary": "List environments",
240003
+ "description": "Lists the environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
239474
240004
  "tags": [
239475
240005
  "repos"
239476
240006
  ],
239477
240007
  "operationId": "repos/get-all-environments",
239478
240008
  "externalDocs": {
239479
240009
  "description": "API method documentation",
239480
- "url": "https://docs.github.com/rest/reference/repos#get-all-environments"
240010
+ "url": "https://docs.github.com/rest/deployments/environments#list-environments"
239481
240011
  },
239482
240012
  "parameters": [
239483
240013
  {
@@ -240076,7 +240606,7 @@
240076
240606
  "x-github": {
240077
240607
  "githubCloudOnly": false,
240078
240608
  "enabledForGitHubApps": true,
240079
- "category": "repos",
240609
+ "category": "deployments",
240080
240610
  "subcategory": "environments"
240081
240611
  },
240082
240612
  "x-octokit": {}
@@ -240085,7 +240615,7 @@
240085
240615
  "/repos/{owner}/{repo}/environments/{environment_name}": {
240086
240616
  "get": {
240087
240617
  "summary": "Get an environment",
240088
- "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
240618
+ "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint. If the\nrepository is private, you must use an access token with the `repo` scope. GitHub\nApps must have the `actions:read` permission to use this endpoint.",
240089
240619
  "tags": [
240090
240620
  "repos"
240091
240621
  ],
@@ -240117,7 +240647,7 @@
240117
240647
  "name": "environment_name",
240118
240648
  "in": "path",
240119
240649
  "required": true,
240120
- "description": "The name of the environment",
240650
+ "description": "The name of the environment.",
240121
240651
  "schema": {
240122
240652
  "type": "string"
240123
240653
  }
@@ -240671,7 +241201,7 @@
240671
241201
  },
240672
241202
  "put": {
240673
241203
  "summary": "Create or update an environment",
240674
- "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.",
241204
+ "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
240675
241205
  "tags": [
240676
241206
  "repos"
240677
241207
  ],
@@ -240703,7 +241233,7 @@
240703
241233
  "name": "environment_name",
240704
241234
  "in": "path",
240705
241235
  "required": true,
240706
- "description": "The name of the environment",
241236
+ "description": "The name of the environment.",
240707
241237
  "schema": {
240708
241238
  "type": "string"
240709
241239
  }
@@ -240767,6 +241297,27 @@
240767
241297
  }
240768
241298
  },
240769
241299
  "additionalProperties": false
241300
+ },
241301
+ "examples": {
241302
+ "default": {
241303
+ "value": {
241304
+ "wait_timer": 30,
241305
+ "reviewers": [
241306
+ {
241307
+ "type": "User",
241308
+ "id": 1
241309
+ },
241310
+ {
241311
+ "type": "Team",
241312
+ "id": 1
241313
+ }
241314
+ ],
241315
+ "deployment_branch_policy": {
241316
+ "protected_branches": false,
241317
+ "custom_branch_policies": true
241318
+ }
241319
+ }
241320
+ }
240770
241321
  }
240771
241322
  }
240772
241323
  }
@@ -241377,7 +241928,7 @@
241377
241928
  "name": "environment_name",
241378
241929
  "in": "path",
241379
241930
  "required": true,
241380
- "description": "The name of the environment",
241931
+ "description": "The name of the environment.",
241381
241932
  "schema": {
241382
241933
  "type": "string"
241383
241934
  }
@@ -241397,6 +241948,559 @@
241397
241948
  "x-octokit": {}
241398
241949
  }
241399
241950
  },
241951
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
241952
+ "get": {
241953
+ "summary": "List deployment branch policies",
241954
+ "description": "Lists the deployment branch policies for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
241955
+ "tags": [
241956
+ "repos"
241957
+ ],
241958
+ "operationId": "repos/list-deployment-branch-policies",
241959
+ "externalDocs": {
241960
+ "description": "API method documentation",
241961
+ "url": "https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies"
241962
+ },
241963
+ "parameters": [
241964
+ {
241965
+ "name": "owner",
241966
+ "description": "The account owner of the repository. The name is not case sensitive.",
241967
+ "in": "path",
241968
+ "required": true,
241969
+ "schema": {
241970
+ "type": "string"
241971
+ }
241972
+ },
241973
+ {
241974
+ "name": "repo",
241975
+ "description": "The name of the repository. The name is not case sensitive.",
241976
+ "in": "path",
241977
+ "required": true,
241978
+ "schema": {
241979
+ "type": "string"
241980
+ }
241981
+ },
241982
+ {
241983
+ "name": "environment_name",
241984
+ "in": "path",
241985
+ "required": true,
241986
+ "description": "The name of the environment.",
241987
+ "schema": {
241988
+ "type": "string"
241989
+ }
241990
+ },
241991
+ {
241992
+ "name": "per_page",
241993
+ "description": "The number of results per page (max 100).",
241994
+ "in": "query",
241995
+ "schema": {
241996
+ "type": "integer",
241997
+ "default": 30
241998
+ }
241999
+ },
242000
+ {
242001
+ "name": "page",
242002
+ "description": "Page number of the results to fetch.",
242003
+ "in": "query",
242004
+ "schema": {
242005
+ "type": "integer",
242006
+ "default": 1
242007
+ }
242008
+ }
242009
+ ],
242010
+ "responses": {
242011
+ "200": {
242012
+ "description": "Response",
242013
+ "content": {
242014
+ "application/json": {
242015
+ "schema": {
242016
+ "type": "object",
242017
+ "properties": {
242018
+ "total_count": {
242019
+ "description": "The number of deployment branch policies for the environment.",
242020
+ "type": "integer",
242021
+ "example": 2
242022
+ },
242023
+ "branch_policies": {
242024
+ "type": "array",
242025
+ "items": {
242026
+ "title": "Deployment branch policy",
242027
+ "description": "Details of a deployment branch policy.",
242028
+ "type": "object",
242029
+ "properties": {
242030
+ "id": {
242031
+ "description": "The unique identifier of the branch policy.",
242032
+ "type": "integer",
242033
+ "example": 361471
242034
+ },
242035
+ "node_id": {
242036
+ "type": "string",
242037
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
242038
+ },
242039
+ "name": {
242040
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
242041
+ "type": "string",
242042
+ "example": "release/*"
242043
+ }
242044
+ }
242045
+ }
242046
+ }
242047
+ },
242048
+ "required": [
242049
+ "total_count",
242050
+ "branch_policies"
242051
+ ]
242052
+ },
242053
+ "examples": {
242054
+ "default": {
242055
+ "value": {
242056
+ "total_count": 2,
242057
+ "branch_policies": [
242058
+ {
242059
+ "id": 361471,
242060
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
242061
+ "name": "release/*"
242062
+ },
242063
+ {
242064
+ "id": 361472,
242065
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
242066
+ "name": "main"
242067
+ }
242068
+ ]
242069
+ }
242070
+ }
242071
+ }
242072
+ }
242073
+ }
242074
+ }
242075
+ },
242076
+ "x-github": {
242077
+ "githubCloudOnly": false,
242078
+ "enabledForGitHubApps": true,
242079
+ "category": "deployments",
242080
+ "subcategory": "branch-policies"
242081
+ },
242082
+ "x-octokit": {}
242083
+ },
242084
+ "post": {
242085
+ "summary": "Create a deployment branch policy",
242086
+ "description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
242087
+ "tags": [
242088
+ "repos"
242089
+ ],
242090
+ "operationId": "repos/create-deployment-branch-policy",
242091
+ "externalDocs": {
242092
+ "description": "API method documentation",
242093
+ "url": "https://docs.github.com/rest/deployments/branch-policies#create-deployment-branch-policy"
242094
+ },
242095
+ "parameters": [
242096
+ {
242097
+ "name": "owner",
242098
+ "description": "The account owner of the repository. The name is not case sensitive.",
242099
+ "in": "path",
242100
+ "required": true,
242101
+ "schema": {
242102
+ "type": "string"
242103
+ }
242104
+ },
242105
+ {
242106
+ "name": "repo",
242107
+ "description": "The name of the repository. The name is not case sensitive.",
242108
+ "in": "path",
242109
+ "required": true,
242110
+ "schema": {
242111
+ "type": "string"
242112
+ }
242113
+ },
242114
+ {
242115
+ "name": "environment_name",
242116
+ "in": "path",
242117
+ "required": true,
242118
+ "description": "The name of the environment.",
242119
+ "schema": {
242120
+ "type": "string"
242121
+ }
242122
+ }
242123
+ ],
242124
+ "requestBody": {
242125
+ "required": true,
242126
+ "content": {
242127
+ "application/json": {
242128
+ "schema": {
242129
+ "title": "Deployment branch policy name pattern",
242130
+ "type": "object",
242131
+ "properties": {
242132
+ "name": {
242133
+ "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
242134
+ "type": "string",
242135
+ "example": "release/*"
242136
+ }
242137
+ },
242138
+ "required": [
242139
+ "name"
242140
+ ]
242141
+ },
242142
+ "examples": {
242143
+ "example-wildcard": {
242144
+ "summary": "Example of a wildcard name pattern",
242145
+ "value": {
242146
+ "name": "release/*"
242147
+ }
242148
+ },
242149
+ "example-single-branch": {
242150
+ "summary": "Example of a single branch name pattern",
242151
+ "value": {
242152
+ "name": "main"
242153
+ }
242154
+ }
242155
+ }
242156
+ }
242157
+ }
242158
+ },
242159
+ "responses": {
242160
+ "200": {
242161
+ "description": "Response",
242162
+ "content": {
242163
+ "application/json": {
242164
+ "schema": {
242165
+ "title": "Deployment branch policy",
242166
+ "description": "Details of a deployment branch policy.",
242167
+ "type": "object",
242168
+ "properties": {
242169
+ "id": {
242170
+ "description": "The unique identifier of the branch policy.",
242171
+ "type": "integer",
242172
+ "example": 361471
242173
+ },
242174
+ "node_id": {
242175
+ "type": "string",
242176
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
242177
+ },
242178
+ "name": {
242179
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
242180
+ "type": "string",
242181
+ "example": "release/*"
242182
+ }
242183
+ }
242184
+ },
242185
+ "examples": {
242186
+ "example-wildcard": {
242187
+ "value": {
242188
+ "id": 364662,
242189
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
242190
+ "name": "release/*"
242191
+ }
242192
+ },
242193
+ "example-single-branch": {
242194
+ "value": {
242195
+ "id": 364663,
242196
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
242197
+ "name": "main"
242198
+ }
242199
+ }
242200
+ }
242201
+ }
242202
+ }
242203
+ },
242204
+ "303": {
242205
+ "description": "Response if the same branch name pattern already exists"
242206
+ },
242207
+ "404": {
242208
+ "description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false"
242209
+ }
242210
+ },
242211
+ "x-github": {
242212
+ "githubCloudOnly": false,
242213
+ "enabledForGitHubApps": true,
242214
+ "category": "deployments",
242215
+ "subcategory": "branch-policies"
242216
+ },
242217
+ "x-octokit": {}
242218
+ }
242219
+ },
242220
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
242221
+ "get": {
242222
+ "summary": "Get a deployment branch policy",
242223
+ "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
242224
+ "tags": [
242225
+ "repos"
242226
+ ],
242227
+ "operationId": "repos/get-deployment-branch-policy",
242228
+ "externalDocs": {
242229
+ "description": "API method documentation",
242230
+ "url": "https://docs.github.com/rest/deployments/branch-policies#get-deployment-branch-policy"
242231
+ },
242232
+ "parameters": [
242233
+ {
242234
+ "name": "owner",
242235
+ "description": "The account owner of the repository. The name is not case sensitive.",
242236
+ "in": "path",
242237
+ "required": true,
242238
+ "schema": {
242239
+ "type": "string"
242240
+ }
242241
+ },
242242
+ {
242243
+ "name": "repo",
242244
+ "description": "The name of the repository. The name is not case sensitive.",
242245
+ "in": "path",
242246
+ "required": true,
242247
+ "schema": {
242248
+ "type": "string"
242249
+ }
242250
+ },
242251
+ {
242252
+ "name": "environment_name",
242253
+ "in": "path",
242254
+ "required": true,
242255
+ "description": "The name of the environment.",
242256
+ "schema": {
242257
+ "type": "string"
242258
+ }
242259
+ },
242260
+ {
242261
+ "name": "branch_policy_id",
242262
+ "in": "path",
242263
+ "required": true,
242264
+ "description": "The unique identifier of the branch policy.",
242265
+ "schema": {
242266
+ "type": "integer"
242267
+ }
242268
+ }
242269
+ ],
242270
+ "responses": {
242271
+ "200": {
242272
+ "description": "Response",
242273
+ "content": {
242274
+ "application/json": {
242275
+ "schema": {
242276
+ "title": "Deployment branch policy",
242277
+ "description": "Details of a deployment branch policy.",
242278
+ "type": "object",
242279
+ "properties": {
242280
+ "id": {
242281
+ "description": "The unique identifier of the branch policy.",
242282
+ "type": "integer",
242283
+ "example": 361471
242284
+ },
242285
+ "node_id": {
242286
+ "type": "string",
242287
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
242288
+ },
242289
+ "name": {
242290
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
242291
+ "type": "string",
242292
+ "example": "release/*"
242293
+ }
242294
+ }
242295
+ },
242296
+ "examples": {
242297
+ "default": {
242298
+ "value": {
242299
+ "id": 364662,
242300
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
242301
+ "name": "release/*"
242302
+ }
242303
+ }
242304
+ }
242305
+ }
242306
+ }
242307
+ }
242308
+ },
242309
+ "x-github": {
242310
+ "githubCloudOnly": false,
242311
+ "enabledForGitHubApps": true,
242312
+ "category": "deployments",
242313
+ "subcategory": "branch-policies"
242314
+ },
242315
+ "x-octokit": {}
242316
+ },
242317
+ "put": {
242318
+ "summary": "Update a deployment branch policy",
242319
+ "description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
242320
+ "tags": [
242321
+ "repos"
242322
+ ],
242323
+ "operationId": "repos/update-deployment-branch-policy",
242324
+ "externalDocs": {
242325
+ "description": "API method documentation",
242326
+ "url": "https://docs.github.com/rest/deployments/branch-policies#update-deployment-branch-policy"
242327
+ },
242328
+ "parameters": [
242329
+ {
242330
+ "name": "owner",
242331
+ "description": "The account owner of the repository. The name is not case sensitive.",
242332
+ "in": "path",
242333
+ "required": true,
242334
+ "schema": {
242335
+ "type": "string"
242336
+ }
242337
+ },
242338
+ {
242339
+ "name": "repo",
242340
+ "description": "The name of the repository. The name is not case sensitive.",
242341
+ "in": "path",
242342
+ "required": true,
242343
+ "schema": {
242344
+ "type": "string"
242345
+ }
242346
+ },
242347
+ {
242348
+ "name": "environment_name",
242349
+ "in": "path",
242350
+ "required": true,
242351
+ "description": "The name of the environment.",
242352
+ "schema": {
242353
+ "type": "string"
242354
+ }
242355
+ },
242356
+ {
242357
+ "name": "branch_policy_id",
242358
+ "in": "path",
242359
+ "required": true,
242360
+ "description": "The unique identifier of the branch policy.",
242361
+ "schema": {
242362
+ "type": "integer"
242363
+ }
242364
+ }
242365
+ ],
242366
+ "requestBody": {
242367
+ "required": true,
242368
+ "content": {
242369
+ "application/json": {
242370
+ "schema": {
242371
+ "title": "Deployment branch policy name pattern",
242372
+ "type": "object",
242373
+ "properties": {
242374
+ "name": {
242375
+ "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
242376
+ "type": "string",
242377
+ "example": "release/*"
242378
+ }
242379
+ },
242380
+ "required": [
242381
+ "name"
242382
+ ]
242383
+ },
242384
+ "examples": {
242385
+ "default": {
242386
+ "value": {
242387
+ "name": "release/*"
242388
+ }
242389
+ }
242390
+ }
242391
+ }
242392
+ }
242393
+ },
242394
+ "responses": {
242395
+ "200": {
242396
+ "description": "Response",
242397
+ "content": {
242398
+ "application/json": {
242399
+ "schema": {
242400
+ "title": "Deployment branch policy",
242401
+ "description": "Details of a deployment branch policy.",
242402
+ "type": "object",
242403
+ "properties": {
242404
+ "id": {
242405
+ "description": "The unique identifier of the branch policy.",
242406
+ "type": "integer",
242407
+ "example": 361471
242408
+ },
242409
+ "node_id": {
242410
+ "type": "string",
242411
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
242412
+ },
242413
+ "name": {
242414
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
242415
+ "type": "string",
242416
+ "example": "release/*"
242417
+ }
242418
+ }
242419
+ },
242420
+ "examples": {
242421
+ "default": {
242422
+ "value": {
242423
+ "id": 364662,
242424
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
242425
+ "name": "release/*"
242426
+ }
242427
+ }
242428
+ }
242429
+ }
242430
+ }
242431
+ }
242432
+ },
242433
+ "x-github": {
242434
+ "githubCloudOnly": false,
242435
+ "enabledForGitHubApps": true,
242436
+ "category": "deployments",
242437
+ "subcategory": "branch-policies"
242438
+ },
242439
+ "x-octokit": {}
242440
+ },
242441
+ "delete": {
242442
+ "summary": "Delete a deployment branch policy",
242443
+ "description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
242444
+ "tags": [
242445
+ "repos"
242446
+ ],
242447
+ "operationId": "repos/delete-deployment-branch-policy",
242448
+ "externalDocs": {
242449
+ "description": "API method documentation",
242450
+ "url": "https://docs.github.com/rest/deployments/branch-policies#delete-deployment-branch-policy"
242451
+ },
242452
+ "parameters": [
242453
+ {
242454
+ "name": "owner",
242455
+ "description": "The account owner of the repository. The name is not case sensitive.",
242456
+ "in": "path",
242457
+ "required": true,
242458
+ "schema": {
242459
+ "type": "string"
242460
+ }
242461
+ },
242462
+ {
242463
+ "name": "repo",
242464
+ "description": "The name of the repository. The name is not case sensitive.",
242465
+ "in": "path",
242466
+ "required": true,
242467
+ "schema": {
242468
+ "type": "string"
242469
+ }
242470
+ },
242471
+ {
242472
+ "name": "environment_name",
242473
+ "in": "path",
242474
+ "required": true,
242475
+ "description": "The name of the environment.",
242476
+ "schema": {
242477
+ "type": "string"
242478
+ }
242479
+ },
242480
+ {
242481
+ "name": "branch_policy_id",
242482
+ "in": "path",
242483
+ "required": true,
242484
+ "description": "The unique identifier of the branch policy.",
242485
+ "schema": {
242486
+ "type": "integer"
242487
+ }
242488
+ }
242489
+ ],
242490
+ "responses": {
242491
+ "204": {
242492
+ "description": "Response"
242493
+ }
242494
+ },
242495
+ "x-github": {
242496
+ "githubCloudOnly": false,
242497
+ "enabledForGitHubApps": true,
242498
+ "category": "deployments",
242499
+ "subcategory": "branch-policies"
242500
+ },
242501
+ "x-octokit": {}
242502
+ }
242503
+ },
241400
242504
  "/repos/{owner}/{repo}/events": {
241401
242505
  "get": {
241402
242506
  "summary": "List repository events",
@@ -259617,6 +260721,14 @@
259617
260721
  "write"
259618
260722
  ]
259619
260723
  },
260724
+ "organization_custom_roles": {
260725
+ "type": "string",
260726
+ "description": "The level of permission to grant the access token for custom roles management.",
260727
+ "enum": [
260728
+ "read",
260729
+ "write"
260730
+ ]
260731
+ },
259620
260732
  "deployments": {
259621
260733
  "type": "string",
259622
260734
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -345421,6 +346533,19 @@
345421
346533
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
345422
346534
  "type": "string",
345423
346535
  "nullable": true
346536
+ },
346537
+ "retention_period_minutes": {
346538
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
346539
+ "type": "integer",
346540
+ "example": 60,
346541
+ "nullable": true
346542
+ },
346543
+ "retention_expires_at": {
346544
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
346545
+ "type": "string",
346546
+ "format": "date-time",
346547
+ "example": "2011-01-26T20:01:12Z",
346548
+ "nullable": true
345424
346549
  }
345425
346550
  },
345426
346551
  "required": [
@@ -345587,6 +346712,8 @@
345587
346712
  },
345588
346713
  "location": "WestUs2",
345589
346714
  "idle_timeout_minutes": 60,
346715
+ "retention_period_minutes": "43200,",
346716
+ "retention_expires_at": "null,",
345590
346717
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
345591
346718
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
345592
346719
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -347772,6 +348899,19 @@
347772
348899
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
347773
348900
  "type": "string",
347774
348901
  "nullable": true
348902
+ },
348903
+ "retention_period_minutes": {
348904
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
348905
+ "type": "integer",
348906
+ "example": 60,
348907
+ "nullable": true
348908
+ },
348909
+ "retention_expires_at": {
348910
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
348911
+ "type": "string",
348912
+ "format": "date-time",
348913
+ "example": "2011-01-26T20:01:12Z",
348914
+ "nullable": true
347775
348915
  }
347776
348916
  },
347777
348917
  "required": [
@@ -347938,6 +349078,8 @@
347938
349078
  },
347939
349079
  "location": "WestUs2",
347940
349080
  "idle_timeout_minutes": 60,
349081
+ "retention_period_minutes": "43200,",
349082
+ "retention_expires_at": "null,",
347941
349083
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
347942
349084
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
347943
349085
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -364427,7 +365569,10 @@
364427
365569
  "type": "object",
364428
365570
  "properties": {
364429
365571
  "type": {
364430
- "type": "string"
365572
+ "type": "string",
365573
+ "enum": [
365574
+ "file"
365575
+ ]
364431
365576
  },
364432
365577
  "encoding": {
364433
365578
  "type": "string"
@@ -364706,7 +365851,10 @@
364706
365851
  "type": "object",
364707
365852
  "properties": {
364708
365853
  "type": {
364709
- "type": "string"
365854
+ "type": "string",
365855
+ "enum": [
365856
+ "file"
365857
+ ]
364710
365858
  },
364711
365859
  "encoding": {
364712
365860
  "type": "string"
@@ -382569,7 +383717,7 @@
382569
383717
  "name": "environment_name",
382570
383718
  "in": "path",
382571
383719
  "required": true,
382572
- "description": "The name of the environment",
383720
+ "description": "The name of the environment.",
382573
383721
  "schema": {
382574
383722
  "type": "string"
382575
383723
  }
@@ -382704,7 +383852,7 @@
382704
383852
  "name": "environment_name",
382705
383853
  "in": "path",
382706
383854
  "required": true,
382707
- "description": "The name of the environment",
383855
+ "description": "The name of the environment.",
382708
383856
  "schema": {
382709
383857
  "type": "string"
382710
383858
  }
@@ -382799,7 +383947,7 @@
382799
383947
  "name": "environment_name",
382800
383948
  "in": "path",
382801
383949
  "required": true,
382802
- "description": "The name of the environment",
383950
+ "description": "The name of the environment.",
382803
383951
  "schema": {
382804
383952
  "type": "string"
382805
383953
  }
@@ -382890,7 +384038,7 @@
382890
384038
  "name": "environment_name",
382891
384039
  "in": "path",
382892
384040
  "required": true,
382893
- "description": "The name of the environment",
384041
+ "description": "The name of the environment.",
382894
384042
  "schema": {
382895
384043
  "type": "string"
382896
384044
  }
@@ -382995,7 +384143,7 @@
382995
384143
  "name": "environment_name",
382996
384144
  "in": "path",
382997
384145
  "required": true,
382998
- "description": "The name of the environment",
384146
+ "description": "The name of the environment.",
382999
384147
  "schema": {
383000
384148
  "type": "string"
383001
384149
  }
@@ -414864,6 +416012,19 @@
414864
416012
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
414865
416013
  "type": "string",
414866
416014
  "nullable": true
416015
+ },
416016
+ "retention_period_minutes": {
416017
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
416018
+ "type": "integer",
416019
+ "example": 60,
416020
+ "nullable": true
416021
+ },
416022
+ "retention_expires_at": {
416023
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
416024
+ "type": "string",
416025
+ "format": "date-time",
416026
+ "example": "2011-01-26T20:01:12Z",
416027
+ "nullable": true
414867
416028
  }
414868
416029
  },
414869
416030
  "required": [
@@ -417754,6 +418915,19 @@
417754
418915
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
417755
418916
  "type": "string",
417756
418917
  "nullable": true
418918
+ },
418919
+ "retention_period_minutes": {
418920
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
418921
+ "type": "integer",
418922
+ "example": 60,
418923
+ "nullable": true
418924
+ },
418925
+ "retention_expires_at": {
418926
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
418927
+ "type": "string",
418928
+ "format": "date-time",
418929
+ "example": "2011-01-26T20:01:12Z",
418930
+ "nullable": true
417757
418931
  }
417758
418932
  },
417759
418933
  "required": [
@@ -417920,6 +419094,8 @@
417920
419094
  },
417921
419095
  "location": "WestUs2",
417922
419096
  "idle_timeout_minutes": 60,
419097
+ "retention_period_minutes": "43200,",
419098
+ "retention_expires_at": "null,",
417923
419099
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
417924
419100
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
417925
419101
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -420105,6 +421281,19 @@
420105
421281
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
420106
421282
  "type": "string",
420107
421283
  "nullable": true
421284
+ },
421285
+ "retention_period_minutes": {
421286
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
421287
+ "type": "integer",
421288
+ "example": 60,
421289
+ "nullable": true
421290
+ },
421291
+ "retention_expires_at": {
421292
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
421293
+ "type": "string",
421294
+ "format": "date-time",
421295
+ "example": "2011-01-26T20:01:12Z",
421296
+ "nullable": true
420108
421297
  }
420109
421298
  },
420110
421299
  "required": [
@@ -420271,6 +421460,8 @@
420271
421460
  },
420272
421461
  "location": "WestUs2",
420273
421462
  "idle_timeout_minutes": 60,
421463
+ "retention_period_minutes": "43200,",
421464
+ "retention_expires_at": "null,",
420274
421465
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
420275
421466
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
420276
421467
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -425643,6 +426834,19 @@
425643
426834
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
425644
426835
  "type": "string",
425645
426836
  "nullable": true
426837
+ },
426838
+ "retention_period_minutes": {
426839
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
426840
+ "type": "integer",
426841
+ "example": 60,
426842
+ "nullable": true
426843
+ },
426844
+ "retention_expires_at": {
426845
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
426846
+ "type": "string",
426847
+ "format": "date-time",
426848
+ "example": "2011-01-26T20:01:12Z",
426849
+ "nullable": true
425646
426850
  }
425647
426851
  },
425648
426852
  "required": [
@@ -425809,6 +427013,8 @@
425809
427013
  },
425810
427014
  "location": "WestUs2",
425811
427015
  "idle_timeout_minutes": 60,
427016
+ "retention_period_minutes": "43200,",
427017
+ "retention_expires_at": "null,",
425812
427018
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
425813
427019
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
425814
427020
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -428167,6 +429373,19 @@
428167
429373
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
428168
429374
  "type": "string",
428169
429375
  "nullable": true
429376
+ },
429377
+ "retention_period_minutes": {
429378
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
429379
+ "type": "integer",
429380
+ "example": 60,
429381
+ "nullable": true
429382
+ },
429383
+ "retention_expires_at": {
429384
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
429385
+ "type": "string",
429386
+ "format": "date-time",
429387
+ "example": "2011-01-26T20:01:12Z",
429388
+ "nullable": true
428170
429389
  }
428171
429390
  },
428172
429391
  "required": [
@@ -428333,6 +429552,8 @@
428333
429552
  },
428334
429553
  "location": "WestUs2",
428335
429554
  "idle_timeout_minutes": 60,
429555
+ "retention_period_minutes": "43200,",
429556
+ "retention_expires_at": "null,",
428336
429557
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
428337
429558
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
428338
429559
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -431426,6 +432647,19 @@
431426
432647
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
431427
432648
  "type": "string",
431428
432649
  "nullable": true
432650
+ },
432651
+ "retention_period_minutes": {
432652
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
432653
+ "type": "integer",
432654
+ "example": 60,
432655
+ "nullable": true
432656
+ },
432657
+ "retention_expires_at": {
432658
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
432659
+ "type": "string",
432660
+ "format": "date-time",
432661
+ "example": "2011-01-26T20:01:12Z",
432662
+ "nullable": true
431429
432663
  }
431430
432664
  },
431431
432665
  "required": [
@@ -431592,6 +432826,8 @@
431592
432826
  },
431593
432827
  "location": "WestUs2",
431594
432828
  "idle_timeout_minutes": 60,
432829
+ "retention_period_minutes": "43200,",
432830
+ "retention_expires_at": "null,",
431595
432831
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
431596
432832
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
431597
432833
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -434030,6 +435266,19 @@
434030
435266
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
434031
435267
  "type": "string",
434032
435268
  "nullable": true
435269
+ },
435270
+ "retention_period_minutes": {
435271
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
435272
+ "type": "integer",
435273
+ "example": 60,
435274
+ "nullable": true
435275
+ },
435276
+ "retention_expires_at": {
435277
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
435278
+ "type": "string",
435279
+ "format": "date-time",
435280
+ "example": "2011-01-26T20:01:12Z",
435281
+ "nullable": true
434033
435282
  }
434034
435283
  },
434035
435284
  "required": [
@@ -434196,6 +435445,8 @@
434196
435445
  },
434197
435446
  "location": "WestUs2",
434198
435447
  "idle_timeout_minutes": 60,
435448
+ "retention_period_minutes": "43200,",
435449
+ "retention_expires_at": "null,",
434199
435450
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
434200
435451
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
434201
435452
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -437834,6 +439085,14 @@
437834
439085
  "write"
437835
439086
  ]
437836
439087
  },
439088
+ "organization_custom_roles": {
439089
+ "type": "string",
439090
+ "description": "The level of permission to grant the access token for custom roles management.",
439091
+ "enum": [
439092
+ "read",
439093
+ "write"
439094
+ ]
439095
+ },
437837
439096
  "deployments": {
437838
439097
  "type": "string",
437839
439098
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -482236,6 +483495,14 @@
482236
483495
  "write"
482237
483496
  ]
482238
483497
  },
483498
+ "organization_custom_roles": {
483499
+ "type": "string",
483500
+ "description": "The level of permission to grant the access token for custom roles management.",
483501
+ "enum": [
483502
+ "read",
483503
+ "write"
483504
+ ]
483505
+ },
482239
483506
  "deployments": {
482240
483507
  "type": "string",
482241
483508
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -501393,6 +502660,12 @@
501393
502660
  "text/plain": {
501394
502661
  "schema": {
501395
502662
  "type": "string"
502663
+ },
502664
+ "examples": {
502665
+ "default": {
502666
+ "summary": "Example response",
502667
+ "value": "Responsive is better than fast"
502668
+ }
501396
502669
  }
501397
502670
  }
501398
502671
  }