@octokit/openapi 7.0.0 → 7.1.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 (33) hide show
  1. package/generated/api.github.com.deref.json +831 -48
  2. package/generated/api.github.com.json +456 -36
  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 +1 -8
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +1 -8
  7. package/generated/ghes-3.2.deref.json +618 -37
  8. package/generated/ghes-3.2.json +437 -31
  9. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
  11. package/generated/ghes-3.3.deref.json +618 -37
  12. package/generated/ghes-3.3.json +437 -31
  13. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -8
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -8
  15. package/generated/ghes-3.4.deref.json +618 -37
  16. package/generated/ghes-3.4.json +437 -31
  17. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  18. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  19. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +1 -8
  20. package/generated/ghes-3.5-diff-to-ghes-3.6.json +1 -8
  21. package/generated/ghes-3.5.deref.json +620 -39
  22. package/generated/ghes-3.5.json +439 -33
  23. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +0 -56
  24. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +1 -164
  25. package/generated/ghes-3.6-diff-to-api.github.com.json +1 -130
  26. package/generated/ghes-3.6.deref.json +622 -53
  27. package/generated/ghes-3.6.json +441 -47
  28. package/generated/github.ae-diff-to-api.github.com.deref.json +1 -8
  29. package/generated/github.ae-diff-to-api.github.com.json +1 -8
  30. package/generated/github.ae.deref.json +613 -32
  31. package/generated/github.ae.json +437 -31
  32. package/index.js +2 -0
  33. 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.1.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."
@@ -4150,7 +4150,7 @@
4150
4150
  "examples": {
4151
4151
  "default": {
4152
4152
  "value": {
4153
- "respoitory": "Hello-World",
4153
+ "repository": "Hello-World",
4154
4154
  "permissions": {
4155
4155
  "issues": "write",
4156
4156
  "contents": "read"
@@ -67482,6 +67482,19 @@
67482
67482
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
67483
67483
  "type": "string",
67484
67484
  "nullable": true
67485
+ },
67486
+ "retention_period_minutes": {
67487
+ "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).",
67488
+ "type": "integer",
67489
+ "example": 60,
67490
+ "nullable": true
67491
+ },
67492
+ "retention_expires_at": {
67493
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
67494
+ "type": "string",
67495
+ "format": "date-time",
67496
+ "example": "2011-01-26T20:01:12Z",
67497
+ "nullable": true
67485
67498
  }
67486
67499
  },
67487
67500
  "required": [
@@ -85596,6 +85609,19 @@
85596
85609
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
85597
85610
  "type": "string",
85598
85611
  "nullable": true
85612
+ },
85613
+ "retention_period_minutes": {
85614
+ "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).",
85615
+ "type": "integer",
85616
+ "example": 60,
85617
+ "nullable": true
85618
+ },
85619
+ "retention_expires_at": {
85620
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
85621
+ "type": "string",
85622
+ "format": "date-time",
85623
+ "example": "2011-01-26T20:01:12Z",
85624
+ "nullable": true
85599
85625
  }
85600
85626
  },
85601
85627
  "required": [
@@ -85762,6 +85788,8 @@
85762
85788
  },
85763
85789
  "location": "WestUs2",
85764
85790
  "idle_timeout_minutes": 60,
85791
+ "retention_period_minutes": "43200,",
85792
+ "retention_expires_at": "null,",
85765
85793
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
85766
85794
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
85767
85795
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -119239,14 +119267,7 @@
119239
119267
  "properties": {
119240
119268
  "permission": {
119241
119269
  "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
- ],
119270
+ "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
119271
  "default": "push"
119251
119272
  }
119252
119273
  }
@@ -137576,7 +137597,7 @@
137576
137597
  "/repos/{owner}/{repo}/actions/permissions/access": {
137577
137598
  "get": {
137578
137599
  "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.",
137600
+ "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
137601
  "tags": [
137581
137602
  "actions"
137582
137603
  ],
@@ -137618,7 +137639,6 @@
137618
137639
  "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
137640
  "enum": [
137620
137641
  "none",
137621
- "user",
137622
137642
  "organization",
137623
137643
  "enterprise"
137624
137644
  ]
@@ -137650,7 +137670,7 @@
137650
137670
  },
137651
137671
  "put": {
137652
137672
  "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.",
137673
+ "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
137674
  "tags": [
137655
137675
  "actions"
137656
137676
  ],
@@ -137691,7 +137711,6 @@
137691
137711
  "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
137712
  "enum": [
137693
137713
  "none",
137694
- "user",
137695
137714
  "organization",
137696
137715
  "enterprise"
137697
137716
  ]
@@ -204834,6 +204853,19 @@
204834
204853
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
204835
204854
  "type": "string",
204836
204855
  "nullable": true
204856
+ },
204857
+ "retention_period_minutes": {
204858
+ "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).",
204859
+ "type": "integer",
204860
+ "example": 60,
204861
+ "nullable": true
204862
+ },
204863
+ "retention_expires_at": {
204864
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
204865
+ "type": "string",
204866
+ "format": "date-time",
204867
+ "example": "2011-01-26T20:01:12Z",
204868
+ "nullable": true
204837
204869
  }
204838
204870
  },
204839
204871
  "required": [
@@ -207541,6 +207573,19 @@
207541
207573
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
207542
207574
  "type": "string",
207543
207575
  "nullable": true
207576
+ },
207577
+ "retention_period_minutes": {
207578
+ "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).",
207579
+ "type": "integer",
207580
+ "example": 60,
207581
+ "nullable": true
207582
+ },
207583
+ "retention_expires_at": {
207584
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
207585
+ "type": "string",
207586
+ "format": "date-time",
207587
+ "example": "2011-01-26T20:01:12Z",
207588
+ "nullable": true
207544
207589
  }
207545
207590
  },
207546
207591
  "required": [
@@ -207707,6 +207752,8 @@
207707
207752
  },
207708
207753
  "location": "WestUs2",
207709
207754
  "idle_timeout_minutes": 60,
207755
+ "retention_period_minutes": "43200,",
207756
+ "retention_expires_at": "null,",
207710
207757
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
207711
207758
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
207712
207759
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -209892,6 +209939,19 @@
209892
209939
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
209893
209940
  "type": "string",
209894
209941
  "nullable": true
209942
+ },
209943
+ "retention_period_minutes": {
209944
+ "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).",
209945
+ "type": "integer",
209946
+ "example": 60,
209947
+ "nullable": true
209948
+ },
209949
+ "retention_expires_at": {
209950
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
209951
+ "type": "string",
209952
+ "format": "date-time",
209953
+ "example": "2011-01-26T20:01:12Z",
209954
+ "nullable": true
209895
209955
  }
209896
209956
  },
209897
209957
  "required": [
@@ -210058,6 +210118,8 @@
210058
210118
  },
210059
210119
  "location": "WestUs2",
210060
210120
  "idle_timeout_minutes": 60,
210121
+ "retention_period_minutes": "43200,",
210122
+ "retention_expires_at": "null,",
210061
210123
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
210062
210124
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
210063
210125
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -211892,14 +211954,7 @@
211892
211954
  "properties": {
211893
211955
  "permission": {
211894
211956
  "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
- ],
211957
+ "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
211958
  "default": "push"
211904
211959
  }
211905
211960
  }
@@ -232284,7 +232339,13 @@
232284
232339
  "type": "object",
232285
232340
  "properties": {
232286
232341
  "type": {
232287
- "type": "string"
232342
+ "type": "string",
232343
+ "enum": [
232344
+ "dir",
232345
+ "file",
232346
+ "submodule",
232347
+ "symlink"
232348
+ ]
232288
232349
  },
232289
232350
  "size": {
232290
232351
  "type": "integer"
@@ -232365,7 +232426,10 @@
232365
232426
  "type": "object",
232366
232427
  "properties": {
232367
232428
  "type": {
232368
- "type": "string"
232429
+ "type": "string",
232430
+ "enum": [
232431
+ "file"
232432
+ ]
232369
232433
  },
232370
232434
  "encoding": {
232371
232435
  "type": "string"
@@ -232458,7 +232522,10 @@
232458
232522
  "type": "object",
232459
232523
  "properties": {
232460
232524
  "type": {
232461
- "type": "string"
232525
+ "type": "string",
232526
+ "enum": [
232527
+ "symlink"
232528
+ ]
232462
232529
  },
232463
232530
  "target": {
232464
232531
  "type": "string"
@@ -232534,12 +232601,15 @@
232534
232601
  ]
232535
232602
  },
232536
232603
  {
232537
- "title": "Symlink Content",
232538
- "description": "An object describing a symlink",
232604
+ "title": "Submodule Content",
232605
+ "description": "An object describing a submodule",
232539
232606
  "type": "object",
232540
232607
  "properties": {
232541
232608
  "type": {
232542
- "type": "string"
232609
+ "type": "string",
232610
+ "enum": [
232611
+ "submodule"
232612
+ ]
232543
232613
  },
232544
232614
  "submodule_git_url": {
232545
232615
  "type": "string",
@@ -239469,15 +239539,15 @@
239469
239539
  },
239470
239540
  "/repos/{owner}/{repo}/environments": {
239471
239541
  "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.",
239542
+ "summary": "List environments",
239543
+ "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
239544
  "tags": [
239475
239545
  "repos"
239476
239546
  ],
239477
239547
  "operationId": "repos/get-all-environments",
239478
239548
  "externalDocs": {
239479
239549
  "description": "API method documentation",
239480
- "url": "https://docs.github.com/rest/reference/repos#get-all-environments"
239550
+ "url": "https://docs.github.com/rest/deployments/environments#list-environments"
239481
239551
  },
239482
239552
  "parameters": [
239483
239553
  {
@@ -240076,7 +240146,7 @@
240076
240146
  "x-github": {
240077
240147
  "githubCloudOnly": false,
240078
240148
  "enabledForGitHubApps": true,
240079
- "category": "repos",
240149
+ "category": "deployments",
240080
240150
  "subcategory": "environments"
240081
240151
  },
240082
240152
  "x-octokit": {}
@@ -240085,7 +240155,7 @@
240085
240155
  "/repos/{owner}/{repo}/environments/{environment_name}": {
240086
240156
  "get": {
240087
240157
  "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.",
240158
+ "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
240159
  "tags": [
240090
240160
  "repos"
240091
240161
  ],
@@ -240117,7 +240187,7 @@
240117
240187
  "name": "environment_name",
240118
240188
  "in": "path",
240119
240189
  "required": true,
240120
- "description": "The name of the environment",
240190
+ "description": "The name of the environment.",
240121
240191
  "schema": {
240122
240192
  "type": "string"
240123
240193
  }
@@ -240671,7 +240741,7 @@
240671
240741
  },
240672
240742
  "put": {
240673
240743
  "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.",
240744
+ "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
240745
  "tags": [
240676
240746
  "repos"
240677
240747
  ],
@@ -240703,7 +240773,7 @@
240703
240773
  "name": "environment_name",
240704
240774
  "in": "path",
240705
240775
  "required": true,
240706
- "description": "The name of the environment",
240776
+ "description": "The name of the environment.",
240707
240777
  "schema": {
240708
240778
  "type": "string"
240709
240779
  }
@@ -240767,6 +240837,27 @@
240767
240837
  }
240768
240838
  },
240769
240839
  "additionalProperties": false
240840
+ },
240841
+ "examples": {
240842
+ "default": {
240843
+ "value": {
240844
+ "wait_timer": 30,
240845
+ "reviewers": [
240846
+ {
240847
+ "type": "User",
240848
+ "id": 1
240849
+ },
240850
+ {
240851
+ "type": "Team",
240852
+ "id": 1
240853
+ }
240854
+ ],
240855
+ "deployment_branch_policy": {
240856
+ "protected_branches": false,
240857
+ "custom_branch_policies": true
240858
+ }
240859
+ }
240860
+ }
240770
240861
  }
240771
240862
  }
240772
240863
  }
@@ -241377,7 +241468,7 @@
241377
241468
  "name": "environment_name",
241378
241469
  "in": "path",
241379
241470
  "required": true,
241380
- "description": "The name of the environment",
241471
+ "description": "The name of the environment.",
241381
241472
  "schema": {
241382
241473
  "type": "string"
241383
241474
  }
@@ -241397,6 +241488,559 @@
241397
241488
  "x-octokit": {}
241398
241489
  }
241399
241490
  },
241491
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
241492
+ "get": {
241493
+ "summary": "List deployment branch policies",
241494
+ "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.",
241495
+ "tags": [
241496
+ "repos"
241497
+ ],
241498
+ "operationId": "repos/list-deployment-branch-policies",
241499
+ "externalDocs": {
241500
+ "description": "API method documentation",
241501
+ "url": "https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies"
241502
+ },
241503
+ "parameters": [
241504
+ {
241505
+ "name": "owner",
241506
+ "description": "The account owner of the repository. The name is not case sensitive.",
241507
+ "in": "path",
241508
+ "required": true,
241509
+ "schema": {
241510
+ "type": "string"
241511
+ }
241512
+ },
241513
+ {
241514
+ "name": "repo",
241515
+ "description": "The name of the repository. The name is not case sensitive.",
241516
+ "in": "path",
241517
+ "required": true,
241518
+ "schema": {
241519
+ "type": "string"
241520
+ }
241521
+ },
241522
+ {
241523
+ "name": "environment_name",
241524
+ "in": "path",
241525
+ "required": true,
241526
+ "description": "The name of the environment.",
241527
+ "schema": {
241528
+ "type": "string"
241529
+ }
241530
+ },
241531
+ {
241532
+ "name": "per_page",
241533
+ "description": "The number of results per page (max 100).",
241534
+ "in": "query",
241535
+ "schema": {
241536
+ "type": "integer",
241537
+ "default": 30
241538
+ }
241539
+ },
241540
+ {
241541
+ "name": "page",
241542
+ "description": "Page number of the results to fetch.",
241543
+ "in": "query",
241544
+ "schema": {
241545
+ "type": "integer",
241546
+ "default": 1
241547
+ }
241548
+ }
241549
+ ],
241550
+ "responses": {
241551
+ "200": {
241552
+ "description": "Response",
241553
+ "content": {
241554
+ "application/json": {
241555
+ "schema": {
241556
+ "type": "object",
241557
+ "properties": {
241558
+ "total_count": {
241559
+ "description": "The number of deployment branch policies for the environment.",
241560
+ "type": "integer",
241561
+ "example": 2
241562
+ },
241563
+ "branch_policies": {
241564
+ "type": "array",
241565
+ "items": {
241566
+ "title": "Deployment branch policy",
241567
+ "description": "Details of a deployment branch policy.",
241568
+ "type": "object",
241569
+ "properties": {
241570
+ "id": {
241571
+ "description": "The unique identifier of the branch policy.",
241572
+ "type": "integer",
241573
+ "example": 361471
241574
+ },
241575
+ "node_id": {
241576
+ "type": "string",
241577
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
241578
+ },
241579
+ "name": {
241580
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
241581
+ "type": "string",
241582
+ "example": "release/*"
241583
+ }
241584
+ }
241585
+ }
241586
+ }
241587
+ },
241588
+ "required": [
241589
+ "total_count",
241590
+ "branch_policies"
241591
+ ]
241592
+ },
241593
+ "examples": {
241594
+ "default": {
241595
+ "value": {
241596
+ "total_count": 2,
241597
+ "branch_policies": [
241598
+ {
241599
+ "id": 361471,
241600
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
241601
+ "name": "release/*"
241602
+ },
241603
+ {
241604
+ "id": 361472,
241605
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
241606
+ "name": "main"
241607
+ }
241608
+ ]
241609
+ }
241610
+ }
241611
+ }
241612
+ }
241613
+ }
241614
+ }
241615
+ },
241616
+ "x-github": {
241617
+ "githubCloudOnly": false,
241618
+ "enabledForGitHubApps": true,
241619
+ "category": "deployments",
241620
+ "subcategory": "branch-policies"
241621
+ },
241622
+ "x-octokit": {}
241623
+ },
241624
+ "post": {
241625
+ "summary": "Create a deployment branch policy",
241626
+ "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.",
241627
+ "tags": [
241628
+ "repos"
241629
+ ],
241630
+ "operationId": "repos/create-deployment-branch-policy",
241631
+ "externalDocs": {
241632
+ "description": "API method documentation",
241633
+ "url": "https://docs.github.com/rest/deployments/branch-policies#create-deployment-branch-policy"
241634
+ },
241635
+ "parameters": [
241636
+ {
241637
+ "name": "owner",
241638
+ "description": "The account owner of the repository. The name is not case sensitive.",
241639
+ "in": "path",
241640
+ "required": true,
241641
+ "schema": {
241642
+ "type": "string"
241643
+ }
241644
+ },
241645
+ {
241646
+ "name": "repo",
241647
+ "description": "The name of the repository. The name is not case sensitive.",
241648
+ "in": "path",
241649
+ "required": true,
241650
+ "schema": {
241651
+ "type": "string"
241652
+ }
241653
+ },
241654
+ {
241655
+ "name": "environment_name",
241656
+ "in": "path",
241657
+ "required": true,
241658
+ "description": "The name of the environment.",
241659
+ "schema": {
241660
+ "type": "string"
241661
+ }
241662
+ }
241663
+ ],
241664
+ "requestBody": {
241665
+ "required": true,
241666
+ "content": {
241667
+ "application/json": {
241668
+ "schema": {
241669
+ "title": "Deployment branch policy name pattern",
241670
+ "type": "object",
241671
+ "properties": {
241672
+ "name": {
241673
+ "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).",
241674
+ "type": "string",
241675
+ "example": "release/*"
241676
+ }
241677
+ },
241678
+ "required": [
241679
+ "name"
241680
+ ]
241681
+ },
241682
+ "examples": {
241683
+ "example-wildcard": {
241684
+ "summary": "Example of a wildcard name pattern",
241685
+ "value": {
241686
+ "name": "release/*"
241687
+ }
241688
+ },
241689
+ "example-single-branch": {
241690
+ "summary": "Example of a single branch name pattern",
241691
+ "value": {
241692
+ "name": "main"
241693
+ }
241694
+ }
241695
+ }
241696
+ }
241697
+ }
241698
+ },
241699
+ "responses": {
241700
+ "200": {
241701
+ "description": "Response",
241702
+ "content": {
241703
+ "application/json": {
241704
+ "schema": {
241705
+ "title": "Deployment branch policy",
241706
+ "description": "Details of a deployment branch policy.",
241707
+ "type": "object",
241708
+ "properties": {
241709
+ "id": {
241710
+ "description": "The unique identifier of the branch policy.",
241711
+ "type": "integer",
241712
+ "example": 361471
241713
+ },
241714
+ "node_id": {
241715
+ "type": "string",
241716
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
241717
+ },
241718
+ "name": {
241719
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
241720
+ "type": "string",
241721
+ "example": "release/*"
241722
+ }
241723
+ }
241724
+ },
241725
+ "examples": {
241726
+ "example-wildcard": {
241727
+ "value": {
241728
+ "id": 364662,
241729
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
241730
+ "name": "release/*"
241731
+ }
241732
+ },
241733
+ "example-single-branch": {
241734
+ "value": {
241735
+ "id": 364663,
241736
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
241737
+ "name": "main"
241738
+ }
241739
+ }
241740
+ }
241741
+ }
241742
+ }
241743
+ },
241744
+ "303": {
241745
+ "description": "Response if the same branch name pattern already exists"
241746
+ },
241747
+ "404": {
241748
+ "description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false"
241749
+ }
241750
+ },
241751
+ "x-github": {
241752
+ "githubCloudOnly": false,
241753
+ "enabledForGitHubApps": true,
241754
+ "category": "deployments",
241755
+ "subcategory": "branch-policies"
241756
+ },
241757
+ "x-octokit": {}
241758
+ }
241759
+ },
241760
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
241761
+ "get": {
241762
+ "summary": "Get a deployment branch policy",
241763
+ "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.",
241764
+ "tags": [
241765
+ "repos"
241766
+ ],
241767
+ "operationId": "repos/get-deployment-branch-policy",
241768
+ "externalDocs": {
241769
+ "description": "API method documentation",
241770
+ "url": "https://docs.github.com/rest/deployments/branch-policies#get-deployment-branch-policy"
241771
+ },
241772
+ "parameters": [
241773
+ {
241774
+ "name": "owner",
241775
+ "description": "The account owner of the repository. The name is not case sensitive.",
241776
+ "in": "path",
241777
+ "required": true,
241778
+ "schema": {
241779
+ "type": "string"
241780
+ }
241781
+ },
241782
+ {
241783
+ "name": "repo",
241784
+ "description": "The name of the repository. The name is not case sensitive.",
241785
+ "in": "path",
241786
+ "required": true,
241787
+ "schema": {
241788
+ "type": "string"
241789
+ }
241790
+ },
241791
+ {
241792
+ "name": "environment_name",
241793
+ "in": "path",
241794
+ "required": true,
241795
+ "description": "The name of the environment.",
241796
+ "schema": {
241797
+ "type": "string"
241798
+ }
241799
+ },
241800
+ {
241801
+ "name": "branch_policy_id",
241802
+ "in": "path",
241803
+ "required": true,
241804
+ "description": "The unique identifier of the branch policy.",
241805
+ "schema": {
241806
+ "type": "integer"
241807
+ }
241808
+ }
241809
+ ],
241810
+ "responses": {
241811
+ "200": {
241812
+ "description": "Response",
241813
+ "content": {
241814
+ "application/json": {
241815
+ "schema": {
241816
+ "title": "Deployment branch policy",
241817
+ "description": "Details of a deployment branch policy.",
241818
+ "type": "object",
241819
+ "properties": {
241820
+ "id": {
241821
+ "description": "The unique identifier of the branch policy.",
241822
+ "type": "integer",
241823
+ "example": 361471
241824
+ },
241825
+ "node_id": {
241826
+ "type": "string",
241827
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
241828
+ },
241829
+ "name": {
241830
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
241831
+ "type": "string",
241832
+ "example": "release/*"
241833
+ }
241834
+ }
241835
+ },
241836
+ "examples": {
241837
+ "default": {
241838
+ "value": {
241839
+ "id": 364662,
241840
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
241841
+ "name": "release/*"
241842
+ }
241843
+ }
241844
+ }
241845
+ }
241846
+ }
241847
+ }
241848
+ },
241849
+ "x-github": {
241850
+ "githubCloudOnly": false,
241851
+ "enabledForGitHubApps": true,
241852
+ "category": "deployments",
241853
+ "subcategory": "branch-policies"
241854
+ },
241855
+ "x-octokit": {}
241856
+ },
241857
+ "put": {
241858
+ "summary": "Update a deployment branch policy",
241859
+ "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.",
241860
+ "tags": [
241861
+ "repos"
241862
+ ],
241863
+ "operationId": "repos/update-deployment-branch-policy",
241864
+ "externalDocs": {
241865
+ "description": "API method documentation",
241866
+ "url": "https://docs.github.com/rest/deployments/branch-policies#update-deployment-branch-policy"
241867
+ },
241868
+ "parameters": [
241869
+ {
241870
+ "name": "owner",
241871
+ "description": "The account owner of the repository. The name is not case sensitive.",
241872
+ "in": "path",
241873
+ "required": true,
241874
+ "schema": {
241875
+ "type": "string"
241876
+ }
241877
+ },
241878
+ {
241879
+ "name": "repo",
241880
+ "description": "The name of the repository. The name is not case sensitive.",
241881
+ "in": "path",
241882
+ "required": true,
241883
+ "schema": {
241884
+ "type": "string"
241885
+ }
241886
+ },
241887
+ {
241888
+ "name": "environment_name",
241889
+ "in": "path",
241890
+ "required": true,
241891
+ "description": "The name of the environment.",
241892
+ "schema": {
241893
+ "type": "string"
241894
+ }
241895
+ },
241896
+ {
241897
+ "name": "branch_policy_id",
241898
+ "in": "path",
241899
+ "required": true,
241900
+ "description": "The unique identifier of the branch policy.",
241901
+ "schema": {
241902
+ "type": "integer"
241903
+ }
241904
+ }
241905
+ ],
241906
+ "requestBody": {
241907
+ "required": true,
241908
+ "content": {
241909
+ "application/json": {
241910
+ "schema": {
241911
+ "title": "Deployment branch policy name pattern",
241912
+ "type": "object",
241913
+ "properties": {
241914
+ "name": {
241915
+ "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).",
241916
+ "type": "string",
241917
+ "example": "release/*"
241918
+ }
241919
+ },
241920
+ "required": [
241921
+ "name"
241922
+ ]
241923
+ },
241924
+ "examples": {
241925
+ "default": {
241926
+ "value": {
241927
+ "name": "release/*"
241928
+ }
241929
+ }
241930
+ }
241931
+ }
241932
+ }
241933
+ },
241934
+ "responses": {
241935
+ "200": {
241936
+ "description": "Response",
241937
+ "content": {
241938
+ "application/json": {
241939
+ "schema": {
241940
+ "title": "Deployment branch policy",
241941
+ "description": "Details of a deployment branch policy.",
241942
+ "type": "object",
241943
+ "properties": {
241944
+ "id": {
241945
+ "description": "The unique identifier of the branch policy.",
241946
+ "type": "integer",
241947
+ "example": 361471
241948
+ },
241949
+ "node_id": {
241950
+ "type": "string",
241951
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
241952
+ },
241953
+ "name": {
241954
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
241955
+ "type": "string",
241956
+ "example": "release/*"
241957
+ }
241958
+ }
241959
+ },
241960
+ "examples": {
241961
+ "default": {
241962
+ "value": {
241963
+ "id": 364662,
241964
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
241965
+ "name": "release/*"
241966
+ }
241967
+ }
241968
+ }
241969
+ }
241970
+ }
241971
+ }
241972
+ },
241973
+ "x-github": {
241974
+ "githubCloudOnly": false,
241975
+ "enabledForGitHubApps": true,
241976
+ "category": "deployments",
241977
+ "subcategory": "branch-policies"
241978
+ },
241979
+ "x-octokit": {}
241980
+ },
241981
+ "delete": {
241982
+ "summary": "Delete a deployment branch policy",
241983
+ "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.",
241984
+ "tags": [
241985
+ "repos"
241986
+ ],
241987
+ "operationId": "repos/delete-deployment-branch-policy",
241988
+ "externalDocs": {
241989
+ "description": "API method documentation",
241990
+ "url": "https://docs.github.com/rest/deployments/branch-policies#delete-deployment-branch-policy"
241991
+ },
241992
+ "parameters": [
241993
+ {
241994
+ "name": "owner",
241995
+ "description": "The account owner of the repository. The name is not case sensitive.",
241996
+ "in": "path",
241997
+ "required": true,
241998
+ "schema": {
241999
+ "type": "string"
242000
+ }
242001
+ },
242002
+ {
242003
+ "name": "repo",
242004
+ "description": "The name of the repository. The name is not case sensitive.",
242005
+ "in": "path",
242006
+ "required": true,
242007
+ "schema": {
242008
+ "type": "string"
242009
+ }
242010
+ },
242011
+ {
242012
+ "name": "environment_name",
242013
+ "in": "path",
242014
+ "required": true,
242015
+ "description": "The name of the environment.",
242016
+ "schema": {
242017
+ "type": "string"
242018
+ }
242019
+ },
242020
+ {
242021
+ "name": "branch_policy_id",
242022
+ "in": "path",
242023
+ "required": true,
242024
+ "description": "The unique identifier of the branch policy.",
242025
+ "schema": {
242026
+ "type": "integer"
242027
+ }
242028
+ }
242029
+ ],
242030
+ "responses": {
242031
+ "204": {
242032
+ "description": "Response"
242033
+ }
242034
+ },
242035
+ "x-github": {
242036
+ "githubCloudOnly": false,
242037
+ "enabledForGitHubApps": true,
242038
+ "category": "deployments",
242039
+ "subcategory": "branch-policies"
242040
+ },
242041
+ "x-octokit": {}
242042
+ }
242043
+ },
241400
242044
  "/repos/{owner}/{repo}/events": {
241401
242045
  "get": {
241402
242046
  "summary": "List repository events",
@@ -345421,6 +346065,19 @@
345421
346065
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
345422
346066
  "type": "string",
345423
346067
  "nullable": true
346068
+ },
346069
+ "retention_period_minutes": {
346070
+ "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).",
346071
+ "type": "integer",
346072
+ "example": 60,
346073
+ "nullable": true
346074
+ },
346075
+ "retention_expires_at": {
346076
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
346077
+ "type": "string",
346078
+ "format": "date-time",
346079
+ "example": "2011-01-26T20:01:12Z",
346080
+ "nullable": true
345424
346081
  }
345425
346082
  },
345426
346083
  "required": [
@@ -345587,6 +346244,8 @@
345587
346244
  },
345588
346245
  "location": "WestUs2",
345589
346246
  "idle_timeout_minutes": 60,
346247
+ "retention_period_minutes": "43200,",
346248
+ "retention_expires_at": "null,",
345590
346249
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
345591
346250
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
345592
346251
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -347772,6 +348431,19 @@
347772
348431
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
347773
348432
  "type": "string",
347774
348433
  "nullable": true
348434
+ },
348435
+ "retention_period_minutes": {
348436
+ "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).",
348437
+ "type": "integer",
348438
+ "example": 60,
348439
+ "nullable": true
348440
+ },
348441
+ "retention_expires_at": {
348442
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
348443
+ "type": "string",
348444
+ "format": "date-time",
348445
+ "example": "2011-01-26T20:01:12Z",
348446
+ "nullable": true
347775
348447
  }
347776
348448
  },
347777
348449
  "required": [
@@ -347938,6 +348610,8 @@
347938
348610
  },
347939
348611
  "location": "WestUs2",
347940
348612
  "idle_timeout_minutes": 60,
348613
+ "retention_period_minutes": "43200,",
348614
+ "retention_expires_at": "null,",
347941
348615
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
347942
348616
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
347943
348617
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -364427,7 +365101,10 @@
364427
365101
  "type": "object",
364428
365102
  "properties": {
364429
365103
  "type": {
364430
- "type": "string"
365104
+ "type": "string",
365105
+ "enum": [
365106
+ "file"
365107
+ ]
364431
365108
  },
364432
365109
  "encoding": {
364433
365110
  "type": "string"
@@ -364706,7 +365383,10 @@
364706
365383
  "type": "object",
364707
365384
  "properties": {
364708
365385
  "type": {
364709
- "type": "string"
365386
+ "type": "string",
365387
+ "enum": [
365388
+ "file"
365389
+ ]
364710
365390
  },
364711
365391
  "encoding": {
364712
365392
  "type": "string"
@@ -382569,7 +383249,7 @@
382569
383249
  "name": "environment_name",
382570
383250
  "in": "path",
382571
383251
  "required": true,
382572
- "description": "The name of the environment",
383252
+ "description": "The name of the environment.",
382573
383253
  "schema": {
382574
383254
  "type": "string"
382575
383255
  }
@@ -382704,7 +383384,7 @@
382704
383384
  "name": "environment_name",
382705
383385
  "in": "path",
382706
383386
  "required": true,
382707
- "description": "The name of the environment",
383387
+ "description": "The name of the environment.",
382708
383388
  "schema": {
382709
383389
  "type": "string"
382710
383390
  }
@@ -382799,7 +383479,7 @@
382799
383479
  "name": "environment_name",
382800
383480
  "in": "path",
382801
383481
  "required": true,
382802
- "description": "The name of the environment",
383482
+ "description": "The name of the environment.",
382803
383483
  "schema": {
382804
383484
  "type": "string"
382805
383485
  }
@@ -382890,7 +383570,7 @@
382890
383570
  "name": "environment_name",
382891
383571
  "in": "path",
382892
383572
  "required": true,
382893
- "description": "The name of the environment",
383573
+ "description": "The name of the environment.",
382894
383574
  "schema": {
382895
383575
  "type": "string"
382896
383576
  }
@@ -382995,7 +383675,7 @@
382995
383675
  "name": "environment_name",
382996
383676
  "in": "path",
382997
383677
  "required": true,
382998
- "description": "The name of the environment",
383678
+ "description": "The name of the environment.",
382999
383679
  "schema": {
383000
383680
  "type": "string"
383001
383681
  }
@@ -414864,6 +415544,19 @@
414864
415544
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
414865
415545
  "type": "string",
414866
415546
  "nullable": true
415547
+ },
415548
+ "retention_period_minutes": {
415549
+ "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).",
415550
+ "type": "integer",
415551
+ "example": 60,
415552
+ "nullable": true
415553
+ },
415554
+ "retention_expires_at": {
415555
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
415556
+ "type": "string",
415557
+ "format": "date-time",
415558
+ "example": "2011-01-26T20:01:12Z",
415559
+ "nullable": true
414867
415560
  }
414868
415561
  },
414869
415562
  "required": [
@@ -417754,6 +418447,19 @@
417754
418447
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
417755
418448
  "type": "string",
417756
418449
  "nullable": true
418450
+ },
418451
+ "retention_period_minutes": {
418452
+ "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).",
418453
+ "type": "integer",
418454
+ "example": 60,
418455
+ "nullable": true
418456
+ },
418457
+ "retention_expires_at": {
418458
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
418459
+ "type": "string",
418460
+ "format": "date-time",
418461
+ "example": "2011-01-26T20:01:12Z",
418462
+ "nullable": true
417757
418463
  }
417758
418464
  },
417759
418465
  "required": [
@@ -417920,6 +418626,8 @@
417920
418626
  },
417921
418627
  "location": "WestUs2",
417922
418628
  "idle_timeout_minutes": 60,
418629
+ "retention_period_minutes": "43200,",
418630
+ "retention_expires_at": "null,",
417923
418631
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
417924
418632
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
417925
418633
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -420105,6 +420813,19 @@
420105
420813
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
420106
420814
  "type": "string",
420107
420815
  "nullable": true
420816
+ },
420817
+ "retention_period_minutes": {
420818
+ "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).",
420819
+ "type": "integer",
420820
+ "example": 60,
420821
+ "nullable": true
420822
+ },
420823
+ "retention_expires_at": {
420824
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
420825
+ "type": "string",
420826
+ "format": "date-time",
420827
+ "example": "2011-01-26T20:01:12Z",
420828
+ "nullable": true
420108
420829
  }
420109
420830
  },
420110
420831
  "required": [
@@ -420271,6 +420992,8 @@
420271
420992
  },
420272
420993
  "location": "WestUs2",
420273
420994
  "idle_timeout_minutes": 60,
420995
+ "retention_period_minutes": "43200,",
420996
+ "retention_expires_at": "null,",
420274
420997
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
420275
420998
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
420276
420999
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -425643,6 +426366,19 @@
425643
426366
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
425644
426367
  "type": "string",
425645
426368
  "nullable": true
426369
+ },
426370
+ "retention_period_minutes": {
426371
+ "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).",
426372
+ "type": "integer",
426373
+ "example": 60,
426374
+ "nullable": true
426375
+ },
426376
+ "retention_expires_at": {
426377
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
426378
+ "type": "string",
426379
+ "format": "date-time",
426380
+ "example": "2011-01-26T20:01:12Z",
426381
+ "nullable": true
425646
426382
  }
425647
426383
  },
425648
426384
  "required": [
@@ -425809,6 +426545,8 @@
425809
426545
  },
425810
426546
  "location": "WestUs2",
425811
426547
  "idle_timeout_minutes": 60,
426548
+ "retention_period_minutes": "43200,",
426549
+ "retention_expires_at": "null,",
425812
426550
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
425813
426551
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
425814
426552
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -428167,6 +428905,19 @@
428167
428905
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
428168
428906
  "type": "string",
428169
428907
  "nullable": true
428908
+ },
428909
+ "retention_period_minutes": {
428910
+ "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).",
428911
+ "type": "integer",
428912
+ "example": 60,
428913
+ "nullable": true
428914
+ },
428915
+ "retention_expires_at": {
428916
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
428917
+ "type": "string",
428918
+ "format": "date-time",
428919
+ "example": "2011-01-26T20:01:12Z",
428920
+ "nullable": true
428170
428921
  }
428171
428922
  },
428172
428923
  "required": [
@@ -428333,6 +429084,8 @@
428333
429084
  },
428334
429085
  "location": "WestUs2",
428335
429086
  "idle_timeout_minutes": 60,
429087
+ "retention_period_minutes": "43200,",
429088
+ "retention_expires_at": "null,",
428336
429089
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
428337
429090
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
428338
429091
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -431426,6 +432179,19 @@
431426
432179
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
431427
432180
  "type": "string",
431428
432181
  "nullable": true
432182
+ },
432183
+ "retention_period_minutes": {
432184
+ "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).",
432185
+ "type": "integer",
432186
+ "example": 60,
432187
+ "nullable": true
432188
+ },
432189
+ "retention_expires_at": {
432190
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
432191
+ "type": "string",
432192
+ "format": "date-time",
432193
+ "example": "2011-01-26T20:01:12Z",
432194
+ "nullable": true
431429
432195
  }
431430
432196
  },
431431
432197
  "required": [
@@ -431592,6 +432358,8 @@
431592
432358
  },
431593
432359
  "location": "WestUs2",
431594
432360
  "idle_timeout_minutes": 60,
432361
+ "retention_period_minutes": "43200,",
432362
+ "retention_expires_at": "null,",
431595
432363
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
431596
432364
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
431597
432365
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
@@ -434030,6 +434798,19 @@
434030
434798
  "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
434031
434799
  "type": "string",
434032
434800
  "nullable": true
434801
+ },
434802
+ "retention_period_minutes": {
434803
+ "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).",
434804
+ "type": "integer",
434805
+ "example": 60,
434806
+ "nullable": true
434807
+ },
434808
+ "retention_expires_at": {
434809
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
434810
+ "type": "string",
434811
+ "format": "date-time",
434812
+ "example": "2011-01-26T20:01:12Z",
434813
+ "nullable": true
434033
434814
  }
434034
434815
  },
434035
434816
  "required": [
@@ -434196,6 +434977,8 @@
434196
434977
  },
434197
434978
  "location": "WestUs2",
434198
434979
  "idle_timeout_minutes": 60,
434980
+ "retention_period_minutes": "43200,",
434981
+ "retention_expires_at": "null,",
434199
434982
  "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
434200
434983
  "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
434201
434984
  "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",