1
0
mirror of synced 2026-01-05 21:04:17 -05:00

Update OpenAPI Descriptions (#32374)

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
This commit is contained in:
github-openapi-bot
2022-11-04 18:19:50 -07:00
committed by GitHub
parent 738c16f6fc
commit 263e3ab271
16 changed files with 4520 additions and 88 deletions

View File

@@ -142432,6 +142432,8 @@
"skipped",
"timed_out",
"action_required",
"startup_failure",
"stale",
null
],
"examples": [
@@ -144130,6 +144132,8 @@
"skipped",
"timed_out",
"action_required",
"startup_failure",
"stale",
null
],
"examples": [
@@ -146981,6 +146985,8 @@
"skipped",
"timed_out",
"action_required",
"startup_failure",
"stale",
null
],
"examples": [
@@ -148732,6 +148738,8 @@
"skipped",
"timed_out",
"action_required",
"startup_failure",
"stale",
null
],
"examples": [
@@ -448653,6 +448661,468 @@
"path": "PATH"
}
},
"response": {
"statusCode": "200",
"contentType": "application/vnd.github.object",
"description": "<p>Response if content is a file</p>",
"example": {
"type": "file",
"encoding": "base64",
"size": 5362,
"name": "README.md",
"path": "README.md",
"content": "IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\nIHdvcmtmbG93Lgo=\\n",
"sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
"url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
"git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
"html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
"download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
"_links": {
"git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
"self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
"html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
}
},
"schema": {
"title": "Content Tree",
"description": "Content Tree",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"size": {
"type": "integer"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"sha": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"git_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"html_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"download_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"size": {
"type": "integer"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"content": {
"type": "string"
},
"sha": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"git_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"html_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"download_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"_links": {
"type": "object",
"properties": {
"git": {
"type": [
"string",
"null"
],
"format": "uri"
},
"html": {
"type": [
"string",
"null"
],
"format": "uri"
},
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"git",
"html",
"self"
]
}
},
"required": [
"_links",
"git_url",
"html_url",
"download_url",
"name",
"path",
"sha",
"size",
"type",
"url"
]
}
},
"_links": {
"type": "object",
"properties": {
"git": {
"type": [
"string",
"null"
],
"format": "uri"
},
"html": {
"type": [
"string",
"null"
],
"format": "uri"
},
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"git",
"html",
"self"
]
}
},
"required": [
"_links",
"git_url",
"html_url",
"download_url",
"name",
"path",
"sha",
"size",
"type",
"url",
"content",
"encoding"
]
}
}
},
{
"key": "response-if-content-is-a-directory",
"request": {
"description": "Example 2: Status Code 200",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"owner": "OWNER",
"repo": "REPO",
"path": "PATH"
}
},
"response": {
"statusCode": "200",
"contentType": "application/vnd.github.object",
"description": "<p>Response if content is a directory and the application/vnd.github.v3.object media type is requested</p>",
"example": {
"type": "dir",
"size": 0,
"name": "src",
"path": "src",
"sha": "2962be1c94eaae9794b3080790ec9d74b2fa8358",
"url": "https://api.github.com/repos/octocat/octorepo/contents/src?ref=main",
"git_url": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
"html_url": "https://github.com/octocat/octorepo/blob/main/src",
"download_url": "https://raw.githubusercontent.com/octocat/octorepo/main/src",
"_links": {
"self": "https://api.github.com/repos/octocat/octorepo/contents/src",
"git": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
"html": "https://github.com/octocat/octorepo/blob/main/src"
},
"entries": [
{
"type": "file",
"size": 625,
"name": "app.js",
"path": "src/app.js",
"sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
"url": "https://api.github.com/repos/octocat/octorepo/contents/src/app.js",
"git_url": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
"html_url": "https://github.com/octocat/octorepo/blob/main/src/app.js",
"download_url": "https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js",
"_links": {
"self": "https://api.github.com/repos/octocat/octorepo/contents/src/app.js",
"git": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
"html": "https://github.com/octocat/octorepo/blob/main/src/app.js"
}
},
{
"type": "dir",
"size": 0,
"name": "images",
"path": "src/images",
"sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
"url": "https://api.github.com/repos/octocat/octorepo/contents/src/images",
"git_url": "https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
"html_url": "https://github.com/octocat/octorepo/tree/main/src/images",
"download_url": null,
"_links": {
"self": "https://api.github.com/repos/octocat/octorepo/contents/src/images",
"git": "https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
"html": "https://github.com/octocat/octorepo/tree/main/src/images"
}
}
]
},
"schema": {
"title": "Content Tree",
"description": "Content Tree",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"size": {
"type": "integer"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"sha": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"git_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"html_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"download_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"size": {
"type": "integer"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"content": {
"type": "string"
},
"sha": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"git_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"html_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"download_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"_links": {
"type": "object",
"properties": {
"git": {
"type": [
"string",
"null"
],
"format": "uri"
},
"html": {
"type": [
"string",
"null"
],
"format": "uri"
},
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"git",
"html",
"self"
]
}
},
"required": [
"_links",
"git_url",
"html_url",
"download_url",
"name",
"path",
"sha",
"size",
"type",
"url"
]
}
},
"_links": {
"type": "object",
"properties": {
"git": {
"type": [
"string",
"null"
],
"format": "uri"
},
"html": {
"type": [
"string",
"null"
],
"format": "uri"
},
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"git",
"html",
"self"
]
}
},
"required": [
"_links",
"git_url",
"html_url",
"download_url",
"name",
"path",
"sha",
"size",
"type",
"url",
"content",
"encoding"
]
}
}
},
{
"key": "response-if-content-is-a-file",
"request": {
"description": "Example 3: Status Code 200",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"owner": "OWNER",
"repo": "REPO",
"path": "PATH"
}
},
"response": {
"statusCode": "200",
"contentType": "application/json",
@@ -448663,7 +449133,7 @@
"size": 5362,
"name": "README.md",
"path": "README.md",
"content": "encoded content ...",
"content": "IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\nIHdvcmtmbG93Lgo=\\n",
"sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
"url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
"git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
@@ -449082,7 +449552,7 @@
{
"key": "response-if-content-is-a-directory",
"request": {
"description": "Example 2: Status Code 200",
"description": "Example 4: Status Code 200",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"owner": "OWNER",
@@ -449093,7 +449563,7 @@
"response": {
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response if content is a directory</p>",
"description": "<p>Response if content is a directory and the application/json media type is requested</p>",
"example": [
{
"type": "file",
@@ -449535,7 +450005,7 @@
{
"key": "response-if-content-is-a-symlink",
"request": {
"description": "Example 3: Status Code 200",
"description": "Example 5: Status Code 200",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"owner": "OWNER",
@@ -449546,7 +450016,7 @@
"response": {
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response if content is a symlink</p>",
"description": "<p>Response if content is a symlink and the application/json media type is requested</p>",
"example": {
"type": "symlink",
"target": "/path/to/symlink/target",
@@ -449971,7 +450441,7 @@
{
"key": "response-if-content-is-a-submodule",
"request": {
"description": "Example 4: Status Code 200",
"description": "Example 6: Status Code 200",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"owner": "OWNER",
@@ -449982,7 +450452,7 @@
"response": {
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response if content is a submodule</p>",
"description": "<p>Response if content is a submodule and the application/json media type is requested</p>",
"example": {
"type": "submodule",
"submodule_git_url": "git://github.com/jquery/qunit.git",