Skip to content

Commit 26a7e84

Browse files
github-openapi-botgithub-openapi-bot
authored
Update OpenAPI Descriptions (#18369)
1 parent 4d310e7 commit 26a7e84

16 files changed

+83
-83
lines changed

‎lib/rest/static/decorated/api.github.com.json‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46735,13 +46735,13 @@
4673546735
{
4673646736
"name": "confirm_delete",
4673746737
"in": "query",
46738-
"description": "Allow deletion if the specified analysis is the last in a set. The parameter can be used without a value as the parameter value is not considered. If you attempt to delete the final analysis in a set without using this parameter you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`",
46738+
"description": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`",
4673946739
"required": false,
4674046740
"schema": {
4674146741
"type": "string",
4674246742
"nullable": true
4674346743
},
46744-
"descriptionHTML": "<p>Allow deletion if the specified analysis is the last in a set. The parameter can be used without a value as the parameter value is not considered. If you attempt to delete the final analysis in a set without using this parameter you'll get a 400 response with the message: <code>Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.</code></p>"
46744+
"descriptionHTML": "<p>Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to <code>true</code>, you'll get a 400 response with the message: <code>Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.</code></p>"
4674546745
}
4674646746
],
4674746747
"x-codeSamples": [
@@ -71052,15 +71052,15 @@
7105271052
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/readme/{dir}'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">dir</span>: <span class=\"hljs-string\">'dir'</span>\n})\n</code></pre>"
7105371053
}
7105471054
],
71055-
"summary": "Get a repository README",
71056-
"description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
71055+
"summary": "Get a repository README for a directory",
71056+
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
7105771057
"tags": [
7105871058
"repos"
7105971059
],
71060-
"operationId": "repos/get-readme-from-alt-path",
71060+
"operationId": "repos/get-readme-in-directory",
7106171061
"externalDocs": {
7106271062
"description": "API method documentation",
71063-
"url": "https://docs.github.com/rest/reference/repos#get-a-repository-readme"
71063+
"url": "https://docs.github.com/rest/reference/repos#get-a-repository-directory-readme"
7106471064
},
7106571065
"x-github": {
7106671066
"githubCloudOnly": false,
@@ -71069,14 +71069,14 @@
7106971069
"category": "repos",
7107071070
"subcategory": "contents"
7107171071
},
71072-
"slug": "get-a-repository-readme",
71072+
"slug": "get-a-repository-readme-for-a-directory",
7107371073
"category": "repos",
7107471074
"categoryLabel": "Repos",
7107571075
"subcategory": "contents",
7107671076
"subcategoryLabel": "Contents",
7107771077
"notes": [],
7107871078
"bodyParameters": [],
71079-
"descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
71079+
"descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
7108071080
"responses": [
7108171081
{
7108271082
"httpStatusCode": "200",

‎lib/rest/static/decorated/ghes-2.18.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50109,15 +50109,15 @@
5010950109
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/readme/{dir}'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">dir</span>: <span class=\"hljs-string\">'dir'</span>\n})\n</code></pre>"
5011050110
}
5011150111
],
50112-
"summary": "Get a repository README",
50113-
"description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
50112+
"summary": "Get a repository README for a directory",
50113+
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
5011450114
"tags": [
5011550115
"repos"
5011650116
],
50117-
"operationId": "repos/get-readme-from-alt-path",
50117+
"operationId": "repos/get-readme-in-directory",
5011850118
"externalDocs": {
5011950119
"description": "API method documentation",
50120-
"url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-readme"
50120+
"url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-directory-readme"
5012150121
},
5012250122
"x-github": {
5012350123
"githubCloudOnly": false,
@@ -50126,14 +50126,14 @@
5012650126
"category": "repos",
5012750127
"subcategory": "contents"
5012850128
},
50129-
"slug": "get-a-repository-readme",
50129+
"slug": "get-a-repository-readme-for-a-directory",
5013050130
"category": "repos",
5013150131
"categoryLabel": "Repos",
5013250132
"subcategory": "contents",
5013350133
"subcategoryLabel": "Contents",
5013450134
"notes": [],
5013550135
"bodyParameters": [],
50136-
"descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
50136+
"descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
5013750137
"responses": [
5013850138
{
5013950139
"httpStatusCode": "200",

‎lib/rest/static/decorated/ghes-2.19.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50911,15 +50911,15 @@
5091150911
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/readme/{dir}'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">dir</span>: <span class=\"hljs-string\">'dir'</span>\n})\n</code></pre>"
5091250912
}
5091350913
],
50914-
"summary": "Get a repository README",
50915-
"description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
50914+
"summary": "Get a repository README for a directory",
50915+
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
5091650916
"tags": [
5091750917
"repos"
5091850918
],
50919-
"operationId": "repos/get-readme-from-alt-path",
50919+
"operationId": "repos/get-readme-in-directory",
5092050920
"externalDocs": {
5092150921
"description": "API method documentation",
50922-
"url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository-readme"
50922+
"url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository-directory-readme"
5092350923
},
5092450924
"x-github": {
5092550925
"githubCloudOnly": false,
@@ -50928,14 +50928,14 @@
5092850928
"category": "repos",
5092950929
"subcategory": "contents"
5093050930
},
50931-
"slug": "get-a-repository-readme",
50931+
"slug": "get-a-repository-readme-for-a-directory",
5093250932
"category": "repos",
5093350933
"categoryLabel": "Repos",
5093450934
"subcategory": "contents",
5093550935
"subcategoryLabel": "Contents",
5093650936
"notes": [],
5093750937
"bodyParameters": [],
50938-
"descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
50938+
"descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
5093950939
"responses": [
5094050940
{
5094150941
"httpStatusCode": "200",

‎lib/rest/static/decorated/ghes-2.20.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51567,15 +51567,15 @@
5156751567
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/readme/{dir}'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">dir</span>: <span class=\"hljs-string\">'dir'</span>\n})\n</code></pre>"
5156851568
}
5156951569
],
51570-
"summary": "Get a repository README",
51571-
"description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
51570+
"summary": "Get a repository README for a directory",
51571+
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
5157251572
"tags": [
5157351573
"repos"
5157451574
],
51575-
"operationId": "repos/get-readme-from-alt-path",
51575+
"operationId": "repos/get-readme-in-directory",
5157651576
"externalDocs": {
5157751577
"description": "API method documentation",
51578-
"url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository-readme"
51578+
"url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository-directory-readme"
5157951579
},
5158051580
"x-github": {
5158151581
"githubCloudOnly": false,
@@ -51584,14 +51584,14 @@
5158451584
"category": "repos",
5158551585
"subcategory": "contents"
5158651586
},
51587-
"slug": "get-a-repository-readme",
51587+
"slug": "get-a-repository-readme-for-a-directory",
5158851588
"category": "repos",
5158951589
"categoryLabel": "Repos",
5159051590
"subcategory": "contents",
5159151591
"subcategoryLabel": "Contents",
5159251592
"notes": [],
5159351593
"bodyParameters": [],
51594-
"descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
51594+
"descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
5159551595
"responses": [
5159651596
{
5159751597
"httpStatusCode": "200",

‎lib/rest/static/decorated/ghes-2.21.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55602,15 +55602,15 @@
5560255602
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/readme/{dir}'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">dir</span>: <span class=\"hljs-string\">'dir'</span>\n})\n</code></pre>"
5560355603
}
5560455604
],
55605-
"summary": "Get a repository README",
55606-
"description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
55605+
"summary": "Get a repository README for a directory",
55606+
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
5560755607
"tags": [
5560855608
"repos"
5560955609
],
55610-
"operationId": "repos/get-readme-from-alt-path",
55610+
"operationId": "repos/get-readme-in-directory",
5561155611
"externalDocs": {
5561255612
"description": "API method documentation",
55613-
"url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository-readme"
55613+
"url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository-directory-readme"
5561455614
},
5561555615
"x-github": {
5561655616
"githubCloudOnly": false,
@@ -55619,14 +55619,14 @@
5561955619
"category": "repos",
5562055620
"subcategory": "contents"
5562155621
},
55622-
"slug": "get-a-repository-readme",
55622+
"slug": "get-a-repository-readme-for-a-directory",
5562355623
"category": "repos",
5562455624
"categoryLabel": "Repos",
5562555625
"subcategory": "contents",
5562655626
"subcategoryLabel": "Contents",
5562755627
"notes": [],
5562855628
"bodyParameters": [],
55629-
"descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
55629+
"descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
5563055630
"responses": [
5563155631
{
5563255632
"httpStatusCode": "200",

‎lib/rest/static/decorated/ghes-2.22.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63320,15 +63320,15 @@
6332063320
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/readme/{dir}'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">dir</span>: <span class=\"hljs-string\">'dir'</span>\n})\n</code></pre>"
6332163321
}
6332263322
],
63323-
"summary": "Get a repository README",
63324-
"description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
63323+
"summary": "Get a repository README for a directory",
63324+
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
6332563325
"tags": [
6332663326
"repos"
6332763327
],
63328-
"operationId": "repos/get-readme-from-alt-path",
63328+
"operationId": "repos/get-readme-in-directory",
6332963329
"externalDocs": {
6333063330
"description": "API method documentation",
63331-
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository-readme"
63331+
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository-directory-readme"
6333263332
},
6333363333
"x-github": {
6333463334
"githubCloudOnly": false,
@@ -63337,14 +63337,14 @@
6333763337
"category": "repos",
6333863338
"subcategory": "contents"
6333963339
},
63340-
"slug": "get-a-repository-readme",
63340+
"slug": "get-a-repository-readme-for-a-directory",
6334163341
"category": "repos",
6334263342
"categoryLabel": "Repos",
6334363343
"subcategory": "contents",
6334463344
"subcategoryLabel": "Contents",
6334563345
"notes": [],
6334663346
"bodyParameters": [],
63347-
"descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
63347+
"descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
6334863348
"responses": [
6334963349
{
6335063350
"httpStatusCode": "200",

‎lib/rest/static/decorated/ghes-3.0.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68016,15 +68016,15 @@
6801668016
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/readme/{dir}'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">dir</span>: <span class=\"hljs-string\">'dir'</span>\n})\n</code></pre>"
6801768017
}
6801868018
],
68019-
"summary": "Get a repository README",
68020-
"description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
68019+
"summary": "Get a repository README for a directory",
68020+
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
6802168021
"tags": [
6802268022
"repos"
6802368023
],
68024-
"operationId": "repos/get-readme-from-alt-path",
68024+
"operationId": "repos/get-readme-in-directory",
6802568025
"externalDocs": {
6802668026
"description": "API method documentation",
68027-
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-readme"
68027+
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-directory-readme"
6802868028
},
6802968029
"x-github": {
6803068030
"githubCloudOnly": false,
@@ -68033,14 +68033,14 @@
6803368033
"category": "repos",
6803468034
"subcategory": "contents"
6803568035
},
68036-
"slug": "get-a-repository-readme",
68036+
"slug": "get-a-repository-readme-for-a-directory",
6803768037
"category": "repos",
6803868038
"categoryLabel": "Repos",
6803968039
"subcategory": "contents",
6804068040
"subcategoryLabel": "Contents",
6804168041
"notes": [],
6804268042
"bodyParameters": [],
68043-
"descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
68043+
"descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
6804468044
"responses": [
6804568045
{
6804668046
"httpStatusCode": "200",

0 commit comments

Comments
 (0)