Skip to content

Commit e99dcf8

Browse files
timrogerstimrogers
authored
Merge pull request #1612 from github/openapi-update-4ba13e776fd9630cc9e9dee106f39c786de557376107b15d09848579eb53c567
Update OpenAPI 3.1 Descriptions
2 parents 7ae918c + 03c0f7f commit e99dcf8

32 files changed

Lines changed: 180 additions & 212 deletions

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25799,12 +25799,12 @@
2579925799
"summary": {
2580025800
"type": "string",
2580125801
"maxLength": 65535,
25802-
"description": "The summary of the check run. This parameter supports Markdown."
25802+
"description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
2580325803
},
2580425804
"text": {
2580525805
"type": "string",
2580625806
"maxLength": 65535,
25807-
"description": "The details of the check run. This parameter supports Markdown."
25807+
"description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
2580825808
},
2580925809
"annotations": {
2581025810
"type": "array",
@@ -39731,7 +39731,7 @@
3973139731
},
3973239732
"post": {
3973339733
"summary": "Create a GitHub Pages site",
39734-
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
39734+
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\" You must be an admin of the repository in order to use this operation.",
3973539735
"tags": [
3973639736
"repos"
3973739737
],
@@ -39841,7 +39841,6 @@
3984139841
},
3984239842
"x-github": {
3984339843
"githubCloudOnly": false,
39844-
"enabledForGitHubApps": true,
3984539844
"category": "pages"
3984639845
}
3984739846
},
@@ -39994,7 +39993,7 @@
3999439993
},
3999539994
"delete": {
3999639995
"summary": "Delete a GitHub Pages site",
39997-
"description": "",
39996+
"description": "Deletes a GitHub Pages site. You must be an admin of the repository in order to use this operation.",
3999839997
"tags": [
3999939998
"repos"
4000039999
],
@@ -40027,7 +40026,6 @@
4002740026
},
4002840027
"x-github": {
4002940028
"githubCloudOnly": false,
40030-
"enabledForGitHubApps": true,
4003140029
"category": "pages"
4003240030
}
4003340031
}

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18519,13 +18519,13 @@ paths:
1851918519
summary:
1852018520
type: string
1852118521
maxLength: 65535
18522-
description: The summary of the check run. This parameter supports
18523-
Markdown.
18522+
description: 'The summary of the check run. This parameter supports
18523+
Markdown. **Maximum length**: 65535 characters.'
1852418524
text:
1852518525
type: string
1852618526
maxLength: 65535
18527-
description: The details of the check run. This parameter supports
18528-
Markdown.
18527+
description: 'The details of the check run. This parameter supports
18528+
Markdown. **Maximum length**: 65535 characters.'
1852918529
annotations:
1853018530
type: array
1853118531
description: Adds information from your analysis to specific
@@ -28679,7 +28679,8 @@ paths:
2867928679
post:
2868028680
summary: Create a GitHub Pages site
2868128681
description: Configures a GitHub Pages site. For more information, see "[About
28682-
GitHub Pages](/github/working-with-github-pages/about-github-pages)."
28682+
GitHub Pages](/github/working-with-github-pages/about-github-pages)." You
28683+
must be an admin of the repository in order to use this operation.
2868328684
tags:
2868428685
- repos
2868528686
operationId: repos/create-pages-site
@@ -28754,7 +28755,6 @@ paths:
2875428755
"$ref": "#/components/responses/conflict"
2875528756
x-github:
2875628757
githubCloudOnly: false
28757-
enabledForGitHubApps: true
2875828758
category: pages
2875928759
put:
2876028760
summary: Update information about a GitHub Pages site
@@ -28867,7 +28867,8 @@ paths:
2886728867
category: pages
2886828868
delete:
2886928869
summary: Delete a GitHub Pages site
28870-
description: ''
28870+
description: Deletes a GitHub Pages site. You must be an admin of the repository
28871+
in order to use this operation.
2887128872
tags:
2887228873
- repos
2887328874
operationId: repos/delete-pages-site
@@ -28888,7 +28889,6 @@ paths:
2888828889
"$ref": "#/components/responses/conflict"
2888928890
x-github:
2889028891
githubCloudOnly: false
28891-
enabledForGitHubApps: true
2889228892
category: pages
2889328893
"/repos/{owner}/{repo}/pages/builds":
2889428894
get:

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -224820,12 +224820,12 @@
224820224820
"summary": {
224821224821
"type": "string",
224822224822
"maxLength": 65535,
224823-
"description": "The summary of the check run. This parameter supports Markdown."
224823+
"description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
224824224824
},
224825224825
"text": {
224826224826
"type": "string",
224827224827
"maxLength": 65535,
224828-
"description": "The details of the check run. This parameter supports Markdown."
224828+
"description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
224829224829
},
224830224830
"annotations": {
224831224831
"type": "array",
@@ -400231,7 +400231,7 @@
400231400231
},
400232400232
"post": {
400233400233
"summary": "Create a GitHub Pages site",
400234-
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
400234+
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\" You must be an admin of the repository in order to use this operation.",
400235400235
"tags": [
400236400236
"repos"
400237400237
],
@@ -400650,7 +400650,6 @@
400650400650
},
400651400651
"x-github": {
400652400652
"githubCloudOnly": false,
400653-
"enabledForGitHubApps": true,
400654400653
"category": "pages"
400655400654
}
400656400655
},
@@ -400975,7 +400974,7 @@
400975400974
},
400976400975
"delete": {
400977400976
"summary": "Delete a GitHub Pages site",
400978-
"description": "",
400977+
"description": "Deletes a GitHub Pages site. You must be an admin of the repository in order to use this operation.",
400979400978
"tags": [
400980400979
"repos"
400981400980
],
@@ -401138,7 +401137,6 @@
401138401137
},
401139401138
"x-github": {
401140401139
"githubCloudOnly": false,
401141-
"enabledForGitHubApps": true,
401142401140
"category": "pages"
401143401141
}
401144401142
}

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39599,13 +39599,13 @@ paths:
3959939599
summary:
3960039600
type: string
3960139601
maxLength: 65535
39602-
description: The summary of the check run. This parameter supports
39603-
Markdown.
39602+
description: 'The summary of the check run. This parameter supports
39603+
Markdown. **Maximum length**: 65535 characters.'
3960439604
text:
3960539605
type: string
3960639606
maxLength: 65535
39607-
description: The details of the check run. This parameter supports
39608-
Markdown.
39607+
description: 'The details of the check run. This parameter supports
39608+
Markdown. **Maximum length**: 65535 characters.'
3960939609
annotations:
3961039610
type: array
3961139611
description: Adds information from your analysis to specific
@@ -60663,7 +60663,8 @@ paths:
6066360663
post:
6066460664
summary: Create a GitHub Pages site
6066560665
description: Configures a GitHub Pages site. For more information, see "[About
60666-
GitHub Pages](/github/working-with-github-pages/about-github-pages)."
60666+
GitHub Pages](/github/working-with-github-pages/about-github-pages)." You
60667+
must be an admin of the repository in order to use this operation.
6066760668
tags:
6066860669
- repos
6066960670
operationId: repos/create-pages-site
@@ -60734,7 +60735,6 @@ paths:
6073460735
'409': *219
6073560736
x-github:
6073660737
githubCloudOnly: false
60737-
enabledForGitHubApps: true
6073860738
category: pages
6073960739
put:
6074060740
summary: Update information about a GitHub Pages site
@@ -60844,7 +60844,8 @@ paths:
6084460844
category: pages
6084560845
delete:
6084660846
summary: Delete a GitHub Pages site
60847-
description: ''
60847+
description: Deletes a GitHub Pages site. You must be an admin of the repository
60848+
in order to use this operation.
6084860849
tags:
6084960850
- repos
6085060851
operationId: repos/delete-pages-site
@@ -60862,7 +60863,6 @@ paths:
6086260863
'409': *219
6086360864
x-github:
6086460865
githubCloudOnly: false
60865-
enabledForGitHubApps: true
6086660866
category: pages
6086760867
"/repos/{owner}/{repo}/pages/builds":
6086860868
get:

‎descriptions-next/ghec/dereferenced/ghec.deref.json‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -228279,12 +228279,12 @@
228279228279
"summary": {
228280228280
"type": "string",
228281228281
"maxLength": 65535,
228282-
"description": "The summary of the check run. This parameter supports Markdown."
228282+
"description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
228283228283
},
228284228284
"text": {
228285228285
"type": "string",
228286228286
"maxLength": 65535,
228287-
"description": "The details of the check run. This parameter supports Markdown."
228287+
"description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
228288228288
},
228289228289
"annotations": {
228290228290
"type": "array",
@@ -403690,7 +403690,7 @@
403690403690
},
403691403691
"post": {
403692403692
"summary": "Create a GitHub Enterprise Cloud Pages site",
403693-
"description": "Configures a GitHub Enterprise Cloud Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
403693+
"description": "Configures a GitHub Enterprise Cloud Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\" You must be an admin of the repository in order to use this operation.",
403694403694
"tags": [
403695403695
"repos"
403696403696
],
@@ -404109,7 +404109,6 @@
404109404109
},
404110404110
"x-github": {
404111404111
"githubCloudOnly": false,
404112-
"enabledForGitHubApps": true,
404113404112
"category": "pages"
404114404113
}
404115404114
},
@@ -404434,7 +404433,7 @@
404434404433
},
404435404434
"delete": {
404436404435
"summary": "Delete a GitHub Enterprise Cloud Pages site",
404437-
"description": "",
404436+
"description": "Deletes a GitHub Pages site. You must be an admin of the repository in order to use this operation.",
404438404437
"tags": [
404439404438
"repos"
404440404439
],
@@ -404597,7 +404596,6 @@
404597404596
},
404598404597
"x-github": {
404599404598
"githubCloudOnly": false,
404600-
"enabledForGitHubApps": true,
404601404599
"category": "pages"
404602404600
}
404603404601
}

‎descriptions-next/ghec/dereferenced/ghec.deref.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41121,13 +41121,13 @@ paths:
4112141121
summary:
4112241122
type: string
4112341123
maxLength: 65535
41124-
description: The summary of the check run. This parameter supports
41125-
Markdown.
41124+
description: 'The summary of the check run. This parameter supports
41125+
Markdown. **Maximum length**: 65535 characters.'
4112641126
text:
4112741127
type: string
4112841128
maxLength: 65535
41129-
description: The details of the check run. This parameter supports
41130-
Markdown.
41129+
description: 'The details of the check run. This parameter supports
41130+
Markdown. **Maximum length**: 65535 characters.'
4113141131
annotations:
4113241132
type: array
4113341133
description: Adds information from your analysis to specific
@@ -62187,6 +62187,7 @@ paths:
6218762187
summary: Create a GitHub Enterprise Cloud Pages site
6218862188
description: Configures a GitHub Enterprise Cloud Pages site. For more information,
6218962189
see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
62190+
You must be an admin of the repository in order to use this operation.
6219062191
tags:
6219162192
- repos
6219262193
operationId: repos/create-pages-site
@@ -62257,7 +62258,6 @@ paths:
6225762258
'409': *242
6225862259
x-github:
6225962260
githubCloudOnly: false
62260-
enabledForGitHubApps: true
6226162261
category: pages
6226262262
put:
6226362263
summary: Update information about a GitHub Enterprise Cloud Pages site
@@ -62367,7 +62367,8 @@ paths:
6236762367
category: pages
6236862368
delete:
6236962369
summary: Delete a GitHub Enterprise Cloud Pages site
62370-
description: ''
62370+
description: Deletes a GitHub Pages site. You must be an admin of the repository
62371+
in order to use this operation.
6237162372
tags:
6237262373
- repos
6237362374
operationId: repos/delete-pages-site
@@ -62385,7 +62386,6 @@ paths:
6238562386
'409': *242
6238662387
x-github:
6238762388
githubCloudOnly: false
62388-
enabledForGitHubApps: true
6238962389
category: pages
6239062390
"/repos/{owner}/{repo}/pages/builds":
6239162391
get:

0 commit comments

Comments
 (0)