@octokit/openapi 7.3.0 → 7.6.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 +9963 -140
  2. package/generated/api.github.com.json +1055 -110
  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 +133 -25
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +127 -14
  7. package/generated/ghes-3.2.deref.json +458 -242
  8. package/generated/ghes-3.2.json +694 -35
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +0 -16
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +187 -223
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +432 -10
  12. package/generated/ghes-3.3.deref.json +458 -244
  13. package/generated/ghes-3.3.json +694 -36
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +9 -1
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +9 -1
  16. package/generated/ghes-3.4.deref.json +462 -230
  17. package/generated/ghes-3.4.json +703 -38
  18. package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +1548 -135
  19. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  20. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  21. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +48182 -31728
  22. package/generated/ghes-3.5-diff-to-ghes-3.6.json +9496 -4686
  23. package/generated/ghes-3.5.deref.json +556 -242
  24. package/generated/ghes-3.5.json +797 -50
  25. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +433 -88
  26. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +17473 -6079
  27. package/generated/ghes-3.6-diff-to-api.github.com.json +4604 -2146
  28. package/generated/ghes-3.6.deref.json +8136 -240
  29. package/generated/ghes-3.6.json +1109 -133
  30. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +1018 -34
  31. package/generated/github.ae-diff-to-api.github.com.deref.json +24735 -16611
  32. package/generated/github.ae-diff-to-api.github.com.json +1390 -126
  33. package/generated/github.ae.deref.json +1214 -163
  34. package/generated/github.ae.json +821 -44
  35. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.3.0",
4
+ "version": "7.6.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": {
@@ -13897,6 +13897,40 @@
13897
13897
  "type": "boolean",
13898
13898
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
13899
13899
  "default": false
13900
+ },
13901
+ "squash_merge_commit_title": {
13902
+ "type": "string",
13903
+ "enum": [
13904
+ "PR_TITLE",
13905
+ "COMMIT_OR_PR_TITLE"
13906
+ ],
13907
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
13908
+ },
13909
+ "squash_merge_commit_message": {
13910
+ "type": "string",
13911
+ "enum": [
13912
+ "PR_BODY",
13913
+ "COMMIT_MESSAGES",
13914
+ "BLANK"
13915
+ ],
13916
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
13917
+ },
13918
+ "merge_commit_title": {
13919
+ "type": "string",
13920
+ "enum": [
13921
+ "PR_TITLE",
13922
+ "MERGE_MESSAGE"
13923
+ ],
13924
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
13925
+ },
13926
+ "merge_commit_message": {
13927
+ "type": "string",
13928
+ "enum": [
13929
+ "PR_BODY",
13930
+ "PR_TITLE",
13931
+ "BLANK"
13932
+ ],
13933
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
13900
13934
  }
13901
13935
  },
13902
13936
  "required": [
@@ -18278,6 +18312,40 @@
18278
18312
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
18279
18313
  "default": false
18280
18314
  },
18315
+ "squash_merge_commit_title": {
18316
+ "type": "string",
18317
+ "enum": [
18318
+ "PR_TITLE",
18319
+ "COMMIT_OR_PR_TITLE"
18320
+ ],
18321
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
18322
+ },
18323
+ "squash_merge_commit_message": {
18324
+ "type": "string",
18325
+ "enum": [
18326
+ "PR_BODY",
18327
+ "COMMIT_MESSAGES",
18328
+ "BLANK"
18329
+ ],
18330
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
18331
+ },
18332
+ "merge_commit_title": {
18333
+ "type": "string",
18334
+ "enum": [
18335
+ "PR_TITLE",
18336
+ "MERGE_MESSAGE"
18337
+ ],
18338
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
18339
+ },
18340
+ "merge_commit_message": {
18341
+ "type": "string",
18342
+ "enum": [
18343
+ "PR_BODY",
18344
+ "PR_TITLE",
18345
+ "BLANK"
18346
+ ],
18347
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
18348
+ },
18281
18349
  "archived": {
18282
18350
  "type": "boolean",
18283
18351
  "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
@@ -19598,9 +19666,12 @@
19598
19666
  "content": {
19599
19667
  "application/json": {
19600
19668
  "schema": {
19601
- "type": "object",
19602
- "properties": {},
19603
- "additionalProperties": false
19669
+ "$ref": "#/components/schemas/empty-object"
19670
+ },
19671
+ "examples": {
19672
+ "default": {
19673
+ "value": null
19674
+ }
19604
19675
  }
19605
19676
  }
19606
19677
  }
@@ -19911,6 +19982,17 @@
19911
19982
  "state",
19912
19983
  "comment"
19913
19984
  ]
19985
+ },
19986
+ "examples": {
19987
+ "default": {
19988
+ "value": {
19989
+ "environment_ids": [
19990
+ 161171787
19991
+ ],
19992
+ "state": "approved",
19993
+ "comment": "Ship it!"
19994
+ }
19995
+ }
19914
19996
  }
19915
19997
  }
19916
19998
  }
@@ -19974,6 +20056,11 @@
19974
20056
  "schema": {
19975
20057
  "type": "object",
19976
20058
  "nullable": true
20059
+ },
20060
+ "examples": {
20061
+ "default": {
20062
+ "value": null
20063
+ }
19977
20064
  }
19978
20065
  }
19979
20066
  }
@@ -19984,9 +20071,12 @@
19984
20071
  "content": {
19985
20072
  "application/json": {
19986
20073
  "schema": {
19987
- "type": "object",
19988
- "properties": {},
19989
- "additionalProperties": false
20074
+ "$ref": "#/components/schemas/empty-object"
20075
+ },
20076
+ "examples": {
20077
+ "default": {
20078
+ "value": null
20079
+ }
19990
20080
  }
19991
20081
  }
19992
20082
  }
@@ -20224,9 +20314,12 @@
20224
20314
  "content": {
20225
20315
  "application/json": {
20226
20316
  "schema": {
20227
- "type": "object",
20228
- "properties": {},
20229
- "additionalProperties": false
20317
+ "$ref": "#/components/schemas/empty-object"
20318
+ },
20319
+ "examples": {
20320
+ "default": {
20321
+ "value": null
20322
+ }
20230
20323
  }
20231
20324
  }
20232
20325
  }
@@ -20865,6 +20958,11 @@
20865
20958
  "application/json": {
20866
20959
  "schema": {
20867
20960
  "$ref": "#/components/schemas/branch-with-protection"
20961
+ },
20962
+ "examples": {
20963
+ "default": {
20964
+ "$ref": "#/components/examples/branch-get"
20965
+ }
20868
20966
  }
20869
20967
  }
20870
20968
  }
@@ -21194,6 +21292,11 @@
21194
21292
  "application/json": {
21195
21293
  "schema": {
21196
21294
  "$ref": "#/components/schemas/protected-branch"
21295
+ },
21296
+ "examples": {
21297
+ "default": {
21298
+ "$ref": "#/components/examples/branch-protection-update"
21299
+ }
21197
21300
  }
21198
21301
  }
21199
21302
  }
@@ -22063,7 +22166,7 @@
22063
22166
  "properties": {
22064
22167
  "contexts": {
22065
22168
  "type": "array",
22066
- "description": "contexts parameter",
22169
+ "description": "The name of the status checks",
22067
22170
  "items": {
22068
22171
  "type": "string"
22069
22172
  }
@@ -22079,6 +22182,17 @@
22079
22182
  }
22080
22183
  }
22081
22184
  ]
22185
+ },
22186
+ "examples": {
22187
+ "default": {
22188
+ "summary": "Example adding status checks to a branch protection rule",
22189
+ "value": {
22190
+ "contexts": [
22191
+ "continuous-integration/travis-ci",
22192
+ "continuous-integration/jenkins"
22193
+ ]
22194
+ }
22195
+ }
22082
22196
  }
22083
22197
  }
22084
22198
  }
@@ -22157,7 +22271,7 @@
22157
22271
  "properties": {
22158
22272
  "contexts": {
22159
22273
  "type": "array",
22160
- "description": "contexts parameter",
22274
+ "description": "The name of the status checks",
22161
22275
  "items": {
22162
22276
  "type": "string"
22163
22277
  }
@@ -22173,6 +22287,16 @@
22173
22287
  }
22174
22288
  }
22175
22289
  ]
22290
+ },
22291
+ "examples": {
22292
+ "default": {
22293
+ "summary": "Example updating status checks for a branch protection rule",
22294
+ "value": {
22295
+ "contexts": [
22296
+ "continuous-integration/travis-ci"
22297
+ ]
22298
+ }
22299
+ }
22176
22300
  }
22177
22301
  }
22178
22302
  }
@@ -22246,7 +22370,7 @@
22246
22370
  "properties": {
22247
22371
  "contexts": {
22248
22372
  "type": "array",
22249
- "description": "contexts parameter",
22373
+ "description": "The name of the status checks",
22250
22374
  "items": {
22251
22375
  "type": "string"
22252
22376
  }
@@ -22262,6 +22386,16 @@
22262
22386
  }
22263
22387
  }
22264
22388
  ]
22389
+ },
22390
+ "examples": {
22391
+ "default": {
22392
+ "summary": "Example removing status checks from a branch protection rule",
22393
+ "value": {
22394
+ "contexts": [
22395
+ "continuous-integration/travis-ci"
22396
+ ]
22397
+ }
22398
+ }
22265
22399
  }
22266
22400
  }
22267
22401
  }
@@ -22787,7 +22921,7 @@
22787
22921
  "properties": {
22788
22922
  "teams": {
22789
22923
  "type": "array",
22790
- "description": "teams parameter",
22924
+ "description": "The slug values for teams",
22791
22925
  "items": {
22792
22926
  "type": "string"
22793
22927
  }
@@ -22803,6 +22937,16 @@
22803
22937
  }
22804
22938
  }
22805
22939
  ]
22940
+ },
22941
+ "examples": {
22942
+ "default": {
22943
+ "summary": "Example adding a team in a branch protection rule",
22944
+ "value": {
22945
+ "teams": [
22946
+ "justice-league"
22947
+ ]
22948
+ }
22949
+ }
22806
22950
  }
22807
22951
  }
22808
22952
  }
@@ -22872,7 +23016,7 @@
22872
23016
  "properties": {
22873
23017
  "teams": {
22874
23018
  "type": "array",
22875
- "description": "teams parameter",
23019
+ "description": "The slug values for teams",
22876
23020
  "items": {
22877
23021
  "type": "string"
22878
23022
  }
@@ -22883,11 +23027,21 @@
22883
23027
  ],
22884
23028
  "example": {
22885
23029
  "teams": [
22886
- "my-team"
23030
+ "justice-league"
22887
23031
  ]
22888
23032
  }
22889
23033
  }
22890
23034
  ]
23035
+ },
23036
+ "examples": {
23037
+ "default": {
23038
+ "summary": "Example replacing a team in a branch protection rule",
23039
+ "value": {
23040
+ "teams": [
23041
+ "justice-league"
23042
+ ]
23043
+ }
23044
+ }
22891
23045
  }
22892
23046
  }
22893
23047
  }
@@ -22956,7 +23110,7 @@
22956
23110
  "properties": {
22957
23111
  "teams": {
22958
23112
  "type": "array",
22959
- "description": "teams parameter",
23113
+ "description": "The slug values for teams",
22960
23114
  "items": {
22961
23115
  "type": "string"
22962
23116
  }
@@ -22972,6 +23126,16 @@
22972
23126
  }
22973
23127
  }
22974
23128
  ]
23129
+ },
23130
+ "examples": {
23131
+ "default": {
23132
+ "summary": "Example removing a team in a branch protection rule",
23133
+ "value": {
23134
+ "teams": [
23135
+ "justice-league"
23136
+ ]
23137
+ }
23138
+ }
22975
23139
  }
22976
23140
  }
22977
23141
  }
@@ -23096,7 +23260,7 @@
23096
23260
  "properties": {
23097
23261
  "users": {
23098
23262
  "type": "array",
23099
- "description": "users parameter",
23263
+ "description": "The username for users",
23100
23264
  "items": {
23101
23265
  "type": "string"
23102
23266
  }
@@ -23112,6 +23276,16 @@
23112
23276
  }
23113
23277
  }
23114
23278
  ]
23279
+ },
23280
+ "examples": {
23281
+ "default": {
23282
+ "summary": "Example adding a user in a branch protection rule",
23283
+ "value": {
23284
+ "users": [
23285
+ "octocat"
23286
+ ]
23287
+ }
23288
+ }
23115
23289
  }
23116
23290
  }
23117
23291
  }
@@ -23181,7 +23355,7 @@
23181
23355
  "properties": {
23182
23356
  "users": {
23183
23357
  "type": "array",
23184
- "description": "users parameter",
23358
+ "description": "The username for users",
23185
23359
  "items": {
23186
23360
  "type": "string"
23187
23361
  }
@@ -23197,6 +23371,16 @@
23197
23371
  }
23198
23372
  }
23199
23373
  ]
23374
+ },
23375
+ "examples": {
23376
+ "default": {
23377
+ "summary": "Example replacing a user in a branch protection rule",
23378
+ "value": {
23379
+ "users": [
23380
+ "octocat"
23381
+ ]
23382
+ }
23383
+ }
23200
23384
  }
23201
23385
  }
23202
23386
  }
@@ -23265,7 +23449,7 @@
23265
23449
  "properties": {
23266
23450
  "users": {
23267
23451
  "type": "array",
23268
- "description": "users parameter",
23452
+ "description": "The username for users",
23269
23453
  "items": {
23270
23454
  "type": "string"
23271
23455
  }
@@ -23281,6 +23465,16 @@
23281
23465
  }
23282
23466
  }
23283
23467
  ]
23468
+ },
23469
+ "examples": {
23470
+ "default": {
23471
+ "summary": "Example removing a user in a branch protection rule",
23472
+ "value": {
23473
+ "users": [
23474
+ "octocat"
23475
+ ]
23476
+ }
23477
+ }
23284
23478
  }
23285
23479
  }
23286
23480
  }
@@ -27116,7 +27310,7 @@
27116
27310
  "/repos/{owner}/{repo}/contents/{path}": {
27117
27311
  "get": {
27118
27312
  "summary": "Get repository content",
27119
- "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.2/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
27313
+ "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.2/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. \n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
27120
27314
  "tags": [
27121
27315
  "repos"
27122
27316
  ],
@@ -31235,6 +31429,14 @@
31235
31429
  ]
31236
31430
  }
31237
31431
  }
31432
+ },
31433
+ "examples": {
31434
+ "default": {
31435
+ "summary": "Example request body",
31436
+ "value": {
31437
+ "permissions": "write"
31438
+ }
31439
+ }
31238
31440
  }
31239
31441
  }
31240
31442
  }
@@ -32434,6 +32636,12 @@
32434
32636
  "closed"
32435
32637
  ]
32436
32638
  },
32639
+ "state_reason": {
32640
+ "type": "string",
32641
+ "nullable": true,
32642
+ "description": "The reason for the current state",
32643
+ "example": "not_planned"
32644
+ },
32437
32645
  "milestone": {
32438
32646
  "oneOf": [
32439
32647
  {
@@ -47756,6 +47964,40 @@
47756
47964
  "type": "boolean",
47757
47965
  "example": false
47758
47966
  },
47967
+ "squash_merge_commit_title": {
47968
+ "type": "string",
47969
+ "enum": [
47970
+ "PR_TITLE",
47971
+ "COMMIT_OR_PR_TITLE"
47972
+ ],
47973
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
47974
+ },
47975
+ "squash_merge_commit_message": {
47976
+ "type": "string",
47977
+ "enum": [
47978
+ "PR_BODY",
47979
+ "COMMIT_MESSAGES",
47980
+ "BLANK"
47981
+ ],
47982
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
47983
+ },
47984
+ "merge_commit_title": {
47985
+ "type": "string",
47986
+ "enum": [
47987
+ "PR_TITLE",
47988
+ "MERGE_MESSAGE"
47989
+ ],
47990
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
47991
+ },
47992
+ "merge_commit_message": {
47993
+ "type": "string",
47994
+ "enum": [
47995
+ "PR_BODY",
47996
+ "PR_TITLE",
47997
+ "BLANK"
47998
+ ],
47999
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
48000
+ },
47759
48001
  "has_downloads": {
47760
48002
  "description": "Whether downloads are enabled.",
47761
48003
  "default": true,
@@ -51313,14 +51555,6 @@
51313
51555
  "write"
51314
51556
  ]
51315
51557
  },
51316
- "organization_custom_roles": {
51317
- "type": "string",
51318
- "description": "The level of permission to grant the access token for custom roles management.",
51319
- "enum": [
51320
- "read",
51321
- "write"
51322
- ]
51323
- },
51324
51558
  "deployments": {
51325
51559
  "type": "string",
51326
51560
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -58161,6 +58395,258 @@
58161
58395
  "parent"
58162
58396
  ]
58163
58397
  },
58398
+ "team-organization": {
58399
+ "title": "Team Organization",
58400
+ "description": "Team Organization",
58401
+ "type": "object",
58402
+ "properties": {
58403
+ "login": {
58404
+ "type": "string",
58405
+ "example": "github"
58406
+ },
58407
+ "id": {
58408
+ "type": "integer",
58409
+ "example": 1
58410
+ },
58411
+ "node_id": {
58412
+ "type": "string",
58413
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
58414
+ },
58415
+ "url": {
58416
+ "type": "string",
58417
+ "format": "uri",
58418
+ "example": "https://api.github.com/orgs/github"
58419
+ },
58420
+ "repos_url": {
58421
+ "type": "string",
58422
+ "format": "uri",
58423
+ "example": "https://api.github.com/orgs/github/repos"
58424
+ },
58425
+ "events_url": {
58426
+ "type": "string",
58427
+ "format": "uri",
58428
+ "example": "https://api.github.com/orgs/github/events"
58429
+ },
58430
+ "hooks_url": {
58431
+ "type": "string",
58432
+ "example": "https://api.github.com/orgs/github/hooks"
58433
+ },
58434
+ "issues_url": {
58435
+ "type": "string",
58436
+ "example": "https://api.github.com/orgs/github/issues"
58437
+ },
58438
+ "members_url": {
58439
+ "type": "string",
58440
+ "example": "https://api.github.com/orgs/github/members{/member}"
58441
+ },
58442
+ "public_members_url": {
58443
+ "type": "string",
58444
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
58445
+ },
58446
+ "avatar_url": {
58447
+ "type": "string",
58448
+ "example": "https://github.com/images/error/octocat_happy.gif"
58449
+ },
58450
+ "description": {
58451
+ "type": "string",
58452
+ "example": "A great organization",
58453
+ "nullable": true
58454
+ },
58455
+ "name": {
58456
+ "type": "string",
58457
+ "example": "github"
58458
+ },
58459
+ "company": {
58460
+ "type": "string",
58461
+ "example": "GitHub"
58462
+ },
58463
+ "blog": {
58464
+ "type": "string",
58465
+ "format": "uri",
58466
+ "example": "https://github.com/blog"
58467
+ },
58468
+ "location": {
58469
+ "type": "string",
58470
+ "example": "San Francisco"
58471
+ },
58472
+ "email": {
58473
+ "type": "string",
58474
+ "format": "email",
58475
+ "example": "octocat@github.com"
58476
+ },
58477
+ "twitter_username": {
58478
+ "type": "string",
58479
+ "example": "github",
58480
+ "nullable": true
58481
+ },
58482
+ "is_verified": {
58483
+ "type": "boolean",
58484
+ "example": true
58485
+ },
58486
+ "has_organization_projects": {
58487
+ "type": "boolean",
58488
+ "example": true
58489
+ },
58490
+ "has_repository_projects": {
58491
+ "type": "boolean",
58492
+ "example": true
58493
+ },
58494
+ "public_repos": {
58495
+ "type": "integer",
58496
+ "example": 2
58497
+ },
58498
+ "public_gists": {
58499
+ "type": "integer",
58500
+ "example": 1
58501
+ },
58502
+ "followers": {
58503
+ "type": "integer",
58504
+ "example": 20
58505
+ },
58506
+ "following": {
58507
+ "type": "integer",
58508
+ "example": 0
58509
+ },
58510
+ "html_url": {
58511
+ "type": "string",
58512
+ "format": "uri",
58513
+ "example": "https://github.com/octocat"
58514
+ },
58515
+ "created_at": {
58516
+ "type": "string",
58517
+ "format": "date-time",
58518
+ "example": "2008-01-14T04:33:35Z"
58519
+ },
58520
+ "type": {
58521
+ "type": "string",
58522
+ "example": "Organization"
58523
+ },
58524
+ "total_private_repos": {
58525
+ "type": "integer",
58526
+ "example": 100
58527
+ },
58528
+ "owned_private_repos": {
58529
+ "type": "integer",
58530
+ "example": 100
58531
+ },
58532
+ "private_gists": {
58533
+ "type": "integer",
58534
+ "example": 81,
58535
+ "nullable": true
58536
+ },
58537
+ "disk_usage": {
58538
+ "type": "integer",
58539
+ "example": 10000,
58540
+ "nullable": true
58541
+ },
58542
+ "collaborators": {
58543
+ "type": "integer",
58544
+ "example": 8,
58545
+ "nullable": true
58546
+ },
58547
+ "billing_email": {
58548
+ "type": "string",
58549
+ "format": "email",
58550
+ "example": "org@example.com",
58551
+ "nullable": true
58552
+ },
58553
+ "plan": {
58554
+ "type": "object",
58555
+ "properties": {
58556
+ "name": {
58557
+ "type": "string"
58558
+ },
58559
+ "space": {
58560
+ "type": "integer"
58561
+ },
58562
+ "private_repos": {
58563
+ "type": "integer"
58564
+ },
58565
+ "filled_seats": {
58566
+ "type": "integer"
58567
+ },
58568
+ "seats": {
58569
+ "type": "integer"
58570
+ }
58571
+ },
58572
+ "required": [
58573
+ "name",
58574
+ "space",
58575
+ "private_repos"
58576
+ ]
58577
+ },
58578
+ "default_repository_permission": {
58579
+ "type": "string",
58580
+ "nullable": true
58581
+ },
58582
+ "members_can_create_repositories": {
58583
+ "type": "boolean",
58584
+ "example": true,
58585
+ "nullable": true
58586
+ },
58587
+ "two_factor_requirement_enabled": {
58588
+ "type": "boolean",
58589
+ "example": true,
58590
+ "nullable": true
58591
+ },
58592
+ "members_allowed_repository_creation_type": {
58593
+ "type": "string",
58594
+ "example": "all"
58595
+ },
58596
+ "members_can_create_public_repositories": {
58597
+ "type": "boolean",
58598
+ "example": true
58599
+ },
58600
+ "members_can_create_private_repositories": {
58601
+ "type": "boolean",
58602
+ "example": true
58603
+ },
58604
+ "members_can_create_internal_repositories": {
58605
+ "type": "boolean",
58606
+ "example": true
58607
+ },
58608
+ "members_can_create_pages": {
58609
+ "type": "boolean",
58610
+ "example": true
58611
+ },
58612
+ "members_can_create_public_pages": {
58613
+ "type": "boolean",
58614
+ "example": true
58615
+ },
58616
+ "members_can_create_private_pages": {
58617
+ "type": "boolean",
58618
+ "example": true
58619
+ },
58620
+ "updated_at": {
58621
+ "type": "string",
58622
+ "format": "date-time"
58623
+ }
58624
+ },
58625
+ "required": [
58626
+ "login",
58627
+ "url",
58628
+ "id",
58629
+ "node_id",
58630
+ "repos_url",
58631
+ "events_url",
58632
+ "hooks_url",
58633
+ "issues_url",
58634
+ "members_url",
58635
+ "public_members_url",
58636
+ "avatar_url",
58637
+ "description",
58638
+ "html_url",
58639
+ "has_organization_projects",
58640
+ "has_repository_projects",
58641
+ "public_repos",
58642
+ "public_gists",
58643
+ "followers",
58644
+ "following",
58645
+ "type",
58646
+ "created_at",
58647
+ "updated_at"
58648
+ ]
58649
+ },
58164
58650
  "team-full": {
58165
58651
  "title": "Full Team",
58166
58652
  "description": "Groups of organization members that gives permissions on specified repositories.",
@@ -58245,7 +58731,7 @@
58245
58731
  "example": "2017-08-17T12:37:15Z"
58246
58732
  },
58247
58733
  "organization": {
58248
- "$ref": "#/components/schemas/organization-full"
58734
+ "$ref": "#/components/schemas/team-organization"
58249
58735
  },
58250
58736
  "ldap_dn": {
58251
58737
  "description": "Distinguished Name (DN) that team maps to within LDAP environment",
@@ -82427,6 +82913,109 @@
82427
82913
  }
82428
82914
  ]
82429
82915
  },
82916
+ "branch-get": {
82917
+ "value": {
82918
+ "name": "main",
82919
+ "commit": {
82920
+ "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
82921
+ "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
82922
+ "commit": {
82923
+ "author": {
82924
+ "name": "The Octocat",
82925
+ "email": "octocat@nowhere.com",
82926
+ "date": "2012-03-06T23:06:50Z"
82927
+ },
82928
+ "committer": {
82929
+ "name": "The Octocat",
82930
+ "email": "octocat@nowhere.com",
82931
+ "date": "2012-03-06T23:06:50Z"
82932
+ },
82933
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
82934
+ "tree": {
82935
+ "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
82936
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
82937
+ },
82938
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
82939
+ "comment_count": 77,
82940
+ "verification": {
82941
+ "verified": false,
82942
+ "reason": "unsigned",
82943
+ "signature": null,
82944
+ "payload": null
82945
+ }
82946
+ },
82947
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
82948
+ "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
82949
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
82950
+ "author": {
82951
+ "login": "octocat",
82952
+ "id": 583231,
82953
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
82954
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
82955
+ "gravatar_id": "",
82956
+ "url": "https://api.github.com/users/octocat",
82957
+ "html_url": "https://github.com/octocat",
82958
+ "followers_url": "https://api.github.com/users/octocat/followers",
82959
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
82960
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
82961
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
82962
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
82963
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
82964
+ "repos_url": "https://api.github.com/users/octocat/repos",
82965
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
82966
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
82967
+ "type": "User",
82968
+ "site_admin": false
82969
+ },
82970
+ "committer": {
82971
+ "login": "octocat",
82972
+ "id": 583231,
82973
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
82974
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
82975
+ "gravatar_id": "",
82976
+ "url": "https://api.github.com/users/octocat",
82977
+ "html_url": "https://github.com/octocat",
82978
+ "followers_url": "https://api.github.com/users/octocat/followers",
82979
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
82980
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
82981
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
82982
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
82983
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
82984
+ "repos_url": "https://api.github.com/users/octocat/repos",
82985
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
82986
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
82987
+ "type": "User",
82988
+ "site_admin": false
82989
+ },
82990
+ "parents": [
82991
+ {
82992
+ "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
82993
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
82994
+ "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
82995
+ },
82996
+ {
82997
+ "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
82998
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
82999
+ "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
83000
+ }
83001
+ ]
83002
+ },
83003
+ "_links": {
83004
+ "self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
83005
+ "html": "https://github.com/octocat/Hello-World/tree/main"
83006
+ },
83007
+ "protected": false,
83008
+ "protection": {
83009
+ "enabled": false,
83010
+ "required_status_checks": {
83011
+ "enforcement_level": "off",
83012
+ "contexts": [],
83013
+ "checks": []
83014
+ }
83015
+ },
83016
+ "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
83017
+ }
83018
+ },
82430
83019
  "branch-protection": {
82431
83020
  "value": {
82432
83021
  "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection",
@@ -82623,6 +83212,71 @@
82623
83212
  }
82624
83213
  }
82625
83214
  },
83215
+ "branch-protection-update": {
83216
+ "value": {
83217
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
83218
+ "required_status_checks": {
83219
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
83220
+ "strict": true,
83221
+ "contexts": [
83222
+ "continuous-integration/travis-ci"
83223
+ ],
83224
+ "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
83225
+ "checks": [
83226
+ {
83227
+ "context": "continuous-integration/travis-ci",
83228
+ "app_id": null
83229
+ }
83230
+ ]
83231
+ },
83232
+ "restrictions": {
83233
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
83234
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
83235
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
83236
+ "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
83237
+ "users": [],
83238
+ "teams": [],
83239
+ "apps": []
83240
+ },
83241
+ "required_pull_request_reviews": {
83242
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
83243
+ "dismiss_stale_reviews": true,
83244
+ "require_code_owner_reviews": true,
83245
+ "required_approving_review_count": 2,
83246
+ "dismissal_restrictions": {
83247
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
83248
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
83249
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
83250
+ "users": [],
83251
+ "teams": [],
83252
+ "apps": []
83253
+ }
83254
+ },
83255
+ "required_signatures": {
83256
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
83257
+ "enabled": false
83258
+ },
83259
+ "enforce_admins": {
83260
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
83261
+ "enabled": true
83262
+ },
83263
+ "required_linear_history": {
83264
+ "enabled": true
83265
+ },
83266
+ "allow_force_pushes": {
83267
+ "enabled": true
83268
+ },
83269
+ "allow_deletions": {
83270
+ "enabled": true
83271
+ },
83272
+ "block_creations": {
83273
+ "enabled": true
83274
+ },
83275
+ "required_conversation_resolution": {
83276
+ "enabled": true
83277
+ }
83278
+ }
83279
+ },
82626
83280
  "protected-branch-admin-enforced-2": {
82627
83281
  "value": {
82628
83282
  "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins",
@@ -87387,7 +88041,8 @@
87387
88041
  "type": "User",
87388
88042
  "site_admin": false
87389
88043
  },
87390
- "author_association": "COLLABORATOR"
88044
+ "author_association": "COLLABORATOR",
88045
+ "state_reason": "completed"
87391
88046
  }
87392
88047
  ]
87393
88048
  },
@@ -87547,7 +88202,8 @@
87547
88202
  "type": "User",
87548
88203
  "site_admin": false
87549
88204
  },
87550
- "author_association": "COLLABORATOR"
88205
+ "author_association": "COLLABORATOR",
88206
+ "state_reason": "completed"
87551
88207
  }
87552
88208
  },
87553
88209
  "issue-comment-items": {
@@ -87783,7 +88439,8 @@
87783
88439
  "closed_at": null,
87784
88440
  "created_at": "2011-04-22T13:33:48Z",
87785
88441
  "updated_at": "2011-04-22T13:33:48Z",
87786
- "author_association": "COLLABORATOR"
88442
+ "author_association": "COLLABORATOR",
88443
+ "state_reason": "completed"
87787
88444
  }
87788
88445
  }
87789
88446
  ]
@@ -87992,7 +88649,8 @@
87992
88649
  "closed_at": null,
87993
88650
  "created_at": "2011-04-22T13:33:48Z",
87994
88651
  "updated_at": "2011-04-22T13:33:48Z",
87995
- "author_association": "COLLABORATOR"
88652
+ "author_association": "COLLABORATOR",
88653
+ "state_reason": "completed"
87996
88654
  }
87997
88655
  }
87998
88656
  },
@@ -92153,7 +92811,8 @@
92153
92811
  "body": "...",
92154
92812
  "score": 1,
92155
92813
  "locked": true,
92156
- "author_association": "COLLABORATOR"
92814
+ "author_association": "COLLABORATOR",
92815
+ "state_reason": "completed"
92157
92816
  }
92158
92817
  ]
92159
92818
  }