Skip to content

Commit a70de7e

Browse files
authored
Merge pull request #1526 from github/openapi-update-4e114dbefcafb1e75a1b519022e82438d0f996245b832974a210e91b38d3f269
Update OpenAPI 3.0 Descriptions
2 parents 318c7a1 + 23c3e9b commit a70de7e

28 files changed

+62
-18
lines changed

descriptions/api.github.com/api.github.com.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34027,7 +34027,7 @@
3402734027
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
3402834028
"get": {
3402934029
"summary": "Get a tree",
34030-
"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.",
34030+
"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.",
3403134031
"tags": [
3403234032
"git"
3403334033
],
@@ -56446,7 +56446,7 @@
5644656446
"key": {
5644756447
"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).\"",
5644856448
"type": "string",
56449-
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
56449+
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
5645056450
}
5645156451
},
5645256452
"required": [

descriptions/api.github.com/api.github.com.yaml

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

2483924839
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.
24840+
24841+
24842+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
2484024843
tags:
2484124844
- git
2484224845
operationId: git/get-tree
@@ -40683,7 +40686,8 @@ paths:
4068340686
description: The public SSH key to add to your GitHub account. For
4068440687
more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)."
4068540688
type: string
40686-
pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
40689+
pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521)
40690+
|^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
4068740691
required:
4068840692
- key
4068940693
type: object

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262150,7 +262150,7 @@
262150262150
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
262151262151
"get": {
262152262152
"summary": "Get a tree",
262153-
"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.",
262153+
"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.",
262154262154
"tags": [
262155262155
"git"
262156262156
],
@@ -476363,7 +476363,7 @@
476363476363
"key": {
476364476364
"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).\"",
476365476365
"type": "string",
476366-
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
476366+
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
476367476367
}
476368476368
},
476369476369
"required": [

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

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

5167051670
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.
51671+
51672+
51673+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
5167151674
tags:
5167251675
- git
5167351676
operationId: git/get-tree
@@ -79936,7 +79939,8 @@ paths:
7993679939
description: The public SSH key to add to your GitHub account. For
7993779940
more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)."
7993879941
type: string
79939-
pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
79942+
pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521)
79943+
|^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
7994079944
required:
7994179945
- key
7994279946
type: object

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211991,7 +211991,7 @@
211991211991
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
211992211992
"get": {
211993211993
"summary": "Get a tree",
211994-
"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.",
211994+
"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.",
211995211995
"tags": [
211996211996
"git"
211997211997
],

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

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

4382643826
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.
43827+
43828+
43829+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
4382743830
tags:
4382843831
- git
4382943832
operationId: git/get-tree

descriptions/ghes-3.2/ghes-3.2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29749,7 +29749,7 @@
2974929749
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
2975029750
"get": {
2975129751
"summary": "Get a tree",
29752-
"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.",
29752+
"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.",
2975329753
"tags": [
2975429754
"git"
2975529755
],

descriptions/ghes-3.2/ghes-3.2.yaml

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

2194121941
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.
21942+
21943+
21944+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
2194221945
tags:
2194321946
- git
2194421947
operationId: git/get-tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213807,7 +213807,7 @@
213807213807
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
213808213808
"get": {
213809213809
"summary": "Get a tree",
213810-
"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.",
213810+
"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.",
213811213811
"tags": [
213812213812
"git"
213813213813
],

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

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

4426444264
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.
44265+
44266+
44267+
**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
4426544268
tags:
4426644269
- git
4426744270
operationId: git/get-tree

0 commit comments

Comments
 (0)