Skip to content

Commit 516bd01

Browse files
authored
Merge pull request #1527 from github/openapi-update-87c34f7c1d0e16b20ad6823e3489e3b2652ad854fa226236e8138b99677bdecc
Update OpenAPI 3.1 Descriptions
2 parents a70de7e + 06b2d3c commit 516bd01

28 files changed

+62
-18
lines changed

descriptions-next/api.github.com/api.github.com.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34201,7 +34201,7 @@
3420134201
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
3420234202
"get": {
3420334203
"summary": "Get a tree",
34204-
"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.",
34204+
"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.",
3420534205
"tags": [
3420634206
"git"
3420734207
],
@@ -56803,7 +56803,7 @@
5680356803
"key": {
5680456804
"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).\"",
5680556805
"type": "string",
56806-
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
56806+
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
5680756807
}
5680856808
},
5680956809
"required": [

descriptions-next/api.github.com/api.github.com.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24921,6 +24921,9 @@ paths:
2492124921
Returns a single tree using the SHA1 value for that tree.
2492224922

2492324923
If `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.
24924+
24925+
24926+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
2492424927
tags:
2492524928
- git
2492624929
operationId: git/get-tree
@@ -40861,7 +40864,8 @@ paths:
4086140864
description: The public SSH key to add to your GitHub account. For
4086240865
more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)."
4086340866
type: string
40864-
pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
40867+
pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521)
40868+
|^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
4086540869
required:
4086640870
- key
4086740871
type: object

descriptions-next/api.github.com/dereferenced/api.github.com.deref.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309485,7 +309485,7 @@
309485309485
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
309486309486
"get": {
309487309487
"summary": "Get a tree",
309488-
"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.",
309488+
"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.",
309489309489
"tags": [
309490309490
"git"
309491309491
],
@@ -566243,7 +566243,7 @@
566243566243
"key": {
566244566244
"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).\"",
566245566245
"type": "string",
566246-
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
566246+
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
566247566247
}
566248566248
},
566249566249
"required": [

descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53061,6 +53061,9 @@ paths:
5306153061
Returns a single tree using the SHA1 value for that tree.
5306253062

5306353063
If `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.
53064+
53065+
53066+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
5306453067
tags:
5306553068
- git
5306653069
operationId: git/get-tree
@@ -81702,7 +81705,8 @@ paths:
8170281705
description: The public SSH key to add to your GitHub account. For
8170381706
more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)."
8170481707
type: string
81705-
pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
81708+
pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521)
81709+
|^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
8170681710
required:
8170781711
- key
8170881712
type: object

descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250146,7 +250146,7 @@
250146250146
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
250147250147
"get": {
250148250148
"summary": "Get a tree",
250149-
"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.",
250149+
"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.",
250150250150
"tags": [
250151250151
"git"
250152250152
],

descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45000,6 +45000,9 @@ paths:
4500045000
Returns a single tree using the SHA1 value for that tree.
4500145001

4500245002
If `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.
45003+
45004+
45005+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
4500345006
tags:
4500445007
- git
4500545008
operationId: git/get-tree

descriptions-next/ghes-3.2/ghes-3.2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29910,7 +29910,7 @@
2991029910
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
2991129911
"get": {
2991229912
"summary": "Get a tree",
29913-
"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.",
29913+
"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.",
2991429914
"tags": [
2991529915
"git"
2991629916
],

descriptions-next/ghes-3.2/ghes-3.2.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22015,6 +22015,9 @@ paths:
2201522015
Returns a single tree using the SHA1 value for that tree.
2201622016

2201722017
If `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.
22018+
22019+
22020+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
2201822021
tags:
2201922022
- git
2202022023
operationId: git/get-tree

descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252312,7 +252312,7 @@
252312252312
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
252313252313
"get": {
252314252314
"summary": "Get a tree",
252315-
"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.",
252315+
"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.",
252316252316
"tags": [
252317252317
"git"
252318252318
],

descriptions-next/ghes-3.3/dereferenced/ghes-3.3.deref.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45497,6 +45497,9 @@ paths:
4549745497
Returns a single tree using the SHA1 value for that tree.
4549845498

4549945499
If `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.
45500+
45501+
45502+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
4550045503
tags:
4550145504
- git
4550245505
operationId: git/get-tree

descriptions-next/ghes-3.3/ghes-3.3.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29718,7 +29718,7 @@
2971829718
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
2971929719
"get": {
2972029720
"summary": "Get a tree",
29721-
"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.",
29721+
"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.",
2972229722
"tags": [
2972329723
"git"
2972429724
],

descriptions-next/ghes-3.3/ghes-3.3.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21382,6 +21382,9 @@ paths:
2138221382
Returns a single tree using the SHA1 value for that tree.
2138321383

2138421384
If `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.
21385+
21386+
21387+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
2138521388
tags:
2138621389
- git
2138721390
operationId: git/get-tree

0 commit comments

Comments
 (0)