Skip to content

Commit 11d4f33

Browse files
octokitbotoctokitbot
authored
fix: tweak description for "Get a tree" API (GET /repos/{owner}/{repo}/git/trees/{tree_sha}) to clarify maximum limits on size and number of entries and document allowed response statuses for the "Update a team" API (PATCH /orgs/{org}/teams/{team_slug}) (#242)
WIP
1 parent 1452402 commit 11d4f33

File tree

21 files changed

+302
-22
lines changed

21 files changed

+302
-22
lines changed

‎cache/api.github.com.json‎

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.10.0",
4+
"version": "7.11.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -15669,6 +15669,21 @@
1566915669
}
1567015670
},
1567115671
"responses": {
15672+
"200": {
15673+
"description": "Response when the updated information already exists",
15674+
"content": {
15675+
"application/json": {
15676+
"schema": {
15677+
"$ref": "#/components/schemas/team-full"
15678+
},
15679+
"examples": {
15680+
"default": {
15681+
"$ref": "#/components/examples/team-full"
15682+
}
15683+
}
15684+
}
15685+
}
15686+
},
1567215687
"201": {
1567315688
"description": "Response",
1567415689
"content": {
@@ -15683,6 +15698,15 @@
1568315698
}
1568415699
}
1568515700
}
15701+
},
15702+
"403": {
15703+
"$ref": "#/components/responses/forbidden"
15704+
},
15705+
"404": {
15706+
"$ref": "#/components/responses/not_found"
15707+
},
15708+
"422": {
15709+
"$ref": "#/components/responses/validation_failed"
1568615710
}
1568715711
},
1568815712
"x-github": {
@@ -31000,6 +31024,7 @@
3100031024
"description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
3100131025
"in": "path",
3100231026
"required": true,
31027+
"x-multi-segment": true,
3100331028
"schema": {
3100431029
"type": "string"
3100531030
}
@@ -34495,7 +34520,7 @@
3449534520
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
3449634521
"get": {
3449734522
"summary": "Get a tree",
34498-
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
34523+
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
3449934524
"tags": [
3450034525
"git"
3450134526
],
@@ -57395,7 +57420,7 @@
5739557420
"key": {
5739657421
"description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"",
5739757422
"type": "string",
57398-
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
57423+
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
5739957424
}
5740057425
},
5740157426
"required": [

‎cache/ghes-3.2.json‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.10.0",
4+
"version": "7.11.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -14299,6 +14299,21 @@
1429914299
}
1430014300
},
1430114301
"responses": {
14302+
"200": {
14303+
"description": "Response when the updated information already exists",
14304+
"content": {
14305+
"application/json": {
14306+
"schema": {
14307+
"$ref": "#/components/schemas/team-full"
14308+
},
14309+
"examples": {
14310+
"default": {
14311+
"$ref": "#/components/examples/team-full"
14312+
}
14313+
}
14314+
}
14315+
}
14316+
},
1430214317
"201": {
1430314318
"description": "Response",
1430414319
"content": {
@@ -14313,6 +14328,15 @@
1431314328
}
1431414329
}
1431514330
}
14331+
},
14332+
"403": {
14333+
"$ref": "#/components/responses/forbidden"
14334+
},
14335+
"404": {
14336+
"$ref": "#/components/responses/not_found"
14337+
},
14338+
"422": {
14339+
"$ref": "#/components/responses/validation_failed"
1431614340
}
1431714341
},
1431814342
"x-github": {
@@ -27145,6 +27169,7 @@
2714527169
"description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
2714627170
"in": "path",
2714727171
"required": true,
27172+
"x-multi-segment": true,
2714827173
"schema": {
2714927174
"type": "string"
2715027175
}
@@ -30398,7 +30423,7 @@
3039830423
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
3039930424
"get": {
3040030425
"summary": "Get a tree",
30401-
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
30426+
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
3040230427
"tags": [
3040330428
"git"
3040430429
],

‎cache/ghes-3.3.json‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.10.0",
4+
"version": "7.11.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -14281,6 +14281,21 @@
1428114281
}
1428214282
},
1428314283
"responses": {
14284+
"200": {
14285+
"description": "Response when the updated information already exists",
14286+
"content": {
14287+
"application/json": {
14288+
"schema": {
14289+
"$ref": "#/components/schemas/team-full"
14290+
},
14291+
"examples": {
14292+
"default": {
14293+
"$ref": "#/components/examples/team-full"
14294+
}
14295+
}
14296+
}
14297+
}
14298+
},
1428414299
"201": {
1428514300
"description": "Response",
1428614301
"content": {
@@ -14295,6 +14310,15 @@
1429514310
}
1429614311
}
1429714312
}
14313+
},
14314+
"403": {
14315+
"$ref": "#/components/responses/forbidden"
14316+
},
14317+
"404": {
14318+
"$ref": "#/components/responses/not_found"
14319+
},
14320+
"422": {
14321+
"$ref": "#/components/responses/validation_failed"
1429814322
}
1429914323
},
1430014324
"x-github": {
@@ -27012,6 +27036,7 @@
2701227036
"description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
2701327037
"in": "path",
2701427038
"required": true,
27039+
"x-multi-segment": true,
2701527040
"schema": {
2701627041
"type": "string"
2701727042
}
@@ -30191,7 +30216,7 @@
3019130216
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
3019230217
"get": {
3019330218
"summary": "Get a tree",
30194-
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
30219+
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
3019530220
"tags": [
3019630221
"git"
3019730222
],

‎cache/ghes-3.4.json‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.10.0",
4+
"version": "7.11.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -15607,6 +15607,21 @@
1560715607
}
1560815608
},
1560915609
"responses": {
15610+
"200": {
15611+
"description": "Response when the updated information already exists",
15612+
"content": {
15613+
"application/json": {
15614+
"schema": {
15615+
"$ref": "#/components/schemas/team-full"
15616+
},
15617+
"examples": {
15618+
"default": {
15619+
"$ref": "#/components/examples/team-full"
15620+
}
15621+
}
15622+
}
15623+
}
15624+
},
1561015625
"201": {
1561115626
"description": "Response",
1561215627
"content": {
@@ -15621,6 +15636,15 @@
1562115636
}
1562215637
}
1562315638
}
15639+
},
15640+
"403": {
15641+
"$ref": "#/components/responses/forbidden"
15642+
},
15643+
"404": {
15644+
"$ref": "#/components/responses/not_found"
15645+
},
15646+
"422": {
15647+
"$ref": "#/components/responses/validation_failed"
1562415648
}
1562515649
},
1562615650
"x-github": {
@@ -28698,6 +28722,7 @@
2869828722
"description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
2869928723
"in": "path",
2870028724
"required": true,
28725+
"x-multi-segment": true,
2870128726
"schema": {
2870228727
"type": "string"
2870328728
}
@@ -32038,7 +32063,7 @@
3203832063
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
3203932064
"get": {
3204032065
"summary": "Get a tree",
32041-
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
32066+
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
3204232067
"tags": [
3204332068
"git"
3204432069
],

‎cache/ghes-3.5.json‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.10.0",
4+
"version": "7.11.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -16204,6 +16204,21 @@
1620416204
}
1620516205
},
1620616206
"responses": {
16207+
"200": {
16208+
"description": "Response when the updated information already exists",
16209+
"content": {
16210+
"application/json": {
16211+
"schema": {
16212+
"$ref": "#/components/schemas/team-full"
16213+
},
16214+
"examples": {
16215+
"default": {
16216+
"$ref": "#/components/examples/team-full"
16217+
}
16218+
}
16219+
}
16220+
}
16221+
},
1620716222
"201": {
1620816223
"description": "Response",
1620916224
"content": {
@@ -16218,6 +16233,15 @@
1621816233
}
1621916234
}
1622016235
}
16236+
},
16237+
"403": {
16238+
"$ref": "#/components/responses/forbidden"
16239+
},
16240+
"404": {
16241+
"$ref": "#/components/responses/not_found"
16242+
},
16243+
"422": {
16244+
"$ref": "#/components/responses/validation_failed"
1622116245
}
1622216246
},
1622316247
"x-github": {
@@ -29918,6 +29942,7 @@
2991829942
"description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
2991929943
"in": "path",
2992029944
"required": true,
29945+
"x-multi-segment": true,
2992129946
"schema": {
2992229947
"type": "string"
2992329948
}
@@ -33270,7 +33295,7 @@
3327033295
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
3327133296
"get": {
3327233297
"summary": "Get a tree",
33273-
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
33298+
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
3327433299
"tags": [
3327533300
"git"
3327633301
],

‎cache/ghes-3.6.json‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.10.0",
4+
"version": "7.11.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -16626,6 +16626,21 @@
1662616626
}
1662716627
},
1662816628
"responses": {
16629+
"200": {
16630+
"description": "Response when the updated information already exists",
16631+
"content": {
16632+
"application/json": {
16633+
"schema": {
16634+
"$ref": "#/components/schemas/team-full"
16635+
},
16636+
"examples": {
16637+
"default": {
16638+
"$ref": "#/components/examples/team-full"
16639+
}
16640+
}
16641+
}
16642+
}
16643+
},
1662916644
"201": {
1663016645
"description": "Response",
1663116646
"content": {
@@ -16640,6 +16655,15 @@
1664016655
}
1664116656
}
1664216657
}
16658+
},
16659+
"403": {
16660+
"$ref": "#/components/responses/forbidden"
16661+
},
16662+
"404": {
16663+
"$ref": "#/components/responses/not_found"
16664+
},
16665+
"422": {
16666+
"$ref": "#/components/responses/validation_failed"
1664316667
}
1664416668
},
1664516669
"x-github": {
@@ -30406,6 +30430,7 @@
3040630430
"description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
3040730431
"in": "path",
3040830432
"required": true,
30433+
"x-multi-segment": true,
3040930434
"schema": {
3041030435
"type": "string"
3041130436
}
@@ -33814,7 +33839,7 @@
3381433839
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
3381533840
"get": {
3381633841
"summary": "Get a tree",
33817-
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
33842+
"description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
3381833843
"tags": [
3381933844
"git"
3382033845
],

0 commit comments

Comments
 (0)