Skip to content

Commit 7f43788

Browse files
timrogerstimrogers
authored
Merge pull request #1611 from github/openapi-update-c9fd6fe205a7971824ddd175c445573347287ed7a3e73d9522191baa9993c3ad
Update OpenAPI 3.0 Descriptions
2 parents e99dcf8 + bef7026 commit 7f43788

32 files changed

Lines changed: 180 additions & 212 deletions

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25665,12 +25665,12 @@
2566525665
"summary": {
2566625666
"type": "string",
2566725667
"maxLength": 65535,
25668-
"description": "The summary of the check run. This parameter supports Markdown."
25668+
"description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
2566925669
},
2567025670
"text": {
2567125671
"type": "string",
2567225672
"maxLength": 65535,
25673-
"description": "The details of the check run. This parameter supports Markdown."
25673+
"description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
2567425674
},
2567525675
"annotations": {
2567625676
"type": "array",
@@ -39510,7 +39510,7 @@
3951039510
},
3951139511
"post": {
3951239512
"summary": "Create a GitHub Pages site",
39513-
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
39513+
"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.",
3951439514
"tags": [
3951539515
"repos"
3951639516
],
@@ -39618,7 +39618,6 @@
3961839618
},
3961939619
"x-github": {
3962039620
"githubCloudOnly": false,
39621-
"enabledForGitHubApps": true,
3962239621
"category": "pages"
3962339622
}
3962439623
},
@@ -39769,7 +39768,7 @@
3976939768
},
3977039769
"delete": {
3977139770
"summary": "Delete a GitHub Pages site",
39772-
"description": "",
39771+
"description": "Deletes a GitHub Pages site. You must be an admin of the repository in order to use this operation.",
3977339772
"tags": [
3977439773
"repos"
3977539774
],
@@ -39802,7 +39801,6 @@
3980239801
},
3980339802
"x-github": {
3980439803
"githubCloudOnly": false,
39805-
"enabledForGitHubApps": true,
3980639804
"category": "pages"
3980739805
}
3980839806
}

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18455,13 +18455,13 @@ paths:
1845518455
summary:
1845618456
type: string
1845718457
maxLength: 65535
18458-
description: The summary of the check run. This parameter supports
18459-
Markdown.
18458+
description: 'The summary of the check run. This parameter supports
18459+
Markdown. **Maximum length**: 65535 characters.'
1846018460
text:
1846118461
type: string
1846218462
maxLength: 65535
18463-
description: The details of the check run. This parameter supports
18464-
Markdown.
18463+
description: 'The details of the check run. This parameter supports
18464+
Markdown. **Maximum length**: 65535 characters.'
1846518465
annotations:
1846618466
type: array
1846718467
description: Adds information from your analysis to specific
@@ -28568,7 +28568,8 @@ paths:
2856828568
post:
2856928569
summary: Create a GitHub Pages site
2857028570
description: Configures a GitHub Pages site. For more information, see "[About
28571-
GitHub Pages](/github/working-with-github-pages/about-github-pages)."
28571+
GitHub Pages](/github/working-with-github-pages/about-github-pages)." You
28572+
must be an admin of the repository in order to use this operation.
2857228573
tags:
2857328574
- repos
2857428575
operationId: repos/create-pages-site
@@ -28642,7 +28643,6 @@ paths:
2864228643
"$ref": "#/components/responses/conflict"
2864328644
x-github:
2864428645
githubCloudOnly: false
28645-
enabledForGitHubApps: true
2864628646
category: pages
2864728647
put:
2864828648
summary: Update information about a GitHub Pages site
@@ -28754,7 +28754,8 @@ paths:
2875428754
category: pages
2875528755
delete:
2875628756
summary: Delete a GitHub Pages site
28757-
description: ''
28757+
description: Deletes a GitHub Pages site. You must be an admin of the repository
28758+
in order to use this operation.
2875828759
tags:
2875928760
- repos
2876028761
operationId: repos/delete-pages-site
@@ -28775,7 +28776,6 @@ paths:
2877528776
"$ref": "#/components/responses/conflict"
2877628777
x-github:
2877728778
githubCloudOnly: false
28778-
enabledForGitHubApps: true
2877928779
category: pages
2878028780
"/repos/{owner}/{repo}/pages/builds":
2878128781
get:

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190922,12 +190922,12 @@
190922190922
"summary": {
190923190923
"type": "string",
190924190924
"maxLength": 65535,
190925-
"description": "The summary of the check run. This parameter supports Markdown."
190925+
"description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
190926190926
},
190927190927
"text": {
190928190928
"type": "string",
190929190929
"maxLength": 65535,
190930-
"description": "The details of the check run. This parameter supports Markdown."
190930+
"description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
190931190931
},
190932190932
"annotations": {
190933190933
"type": "array",
@@ -335902,7 +335902,7 @@
335902335902
},
335903335903
"post": {
335904335904
"summary": "Create a GitHub Pages site",
335905-
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
335905+
"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.",
335906335906
"tags": [
335907335907
"repos"
335908335908
],
@@ -336278,7 +336278,6 @@
336278336278
},
336279336279
"x-github": {
336280336280
"githubCloudOnly": false,
336281-
"enabledForGitHubApps": true,
336282336281
"category": "pages"
336283336282
}
336284336283
},
@@ -336587,7 +336586,7 @@
336587336586
},
336588336587
"delete": {
336589336588
"summary": "Delete a GitHub Pages site",
336590-
"description": "",
336589+
"description": "Deletes a GitHub Pages site. You must be an admin of the repository in order to use this operation.",
336591336590
"tags": [
336592336591
"repos"
336593336592
],
@@ -336744,7 +336743,6 @@
336744336743
},
336745336744
"x-github": {
336746336745
"githubCloudOnly": false,
336747-
"enabledForGitHubApps": true,
336748336746
"category": "pages"
336749336747
}
336750336748
}

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38481,13 +38481,13 @@ paths:
3848138481
summary:
3848238482
type: string
3848338483
maxLength: 65535
38484-
description: The summary of the check run. This parameter supports
38485-
Markdown.
38484+
description: 'The summary of the check run. This parameter supports
38485+
Markdown. **Maximum length**: 65535 characters.'
3848638486
text:
3848738487
type: string
3848838488
maxLength: 65535
38489-
description: The details of the check run. This parameter supports
38490-
Markdown.
38489+
description: 'The details of the check run. This parameter supports
38490+
Markdown. **Maximum length**: 65535 characters.'
3849138491
annotations:
3849238492
type: array
3849338493
description: Adds information from your analysis to specific
@@ -59257,7 +59257,8 @@ paths:
5925759257
post:
5925859258
summary: Create a GitHub Pages site
5925959259
description: Configures a GitHub Pages site. For more information, see "[About
59260-
GitHub Pages](/github/working-with-github-pages/about-github-pages)."
59260+
GitHub Pages](/github/working-with-github-pages/about-github-pages)." You
59261+
must be an admin of the repository in order to use this operation.
5926159262
tags:
5926259263
- repos
5926359264
operationId: repos/create-pages-site
@@ -59327,7 +59328,6 @@ paths:
5932759328
'409': *228
5932859329
x-github:
5932959330
githubCloudOnly: false
59330-
enabledForGitHubApps: true
5933159331
category: pages
5933259332
put:
5933359333
summary: Update information about a GitHub Pages site
@@ -59436,7 +59436,8 @@ paths:
5943659436
category: pages
5943759437
delete:
5943859438
summary: Delete a GitHub Pages site
59439-
description: ''
59439+
description: Deletes a GitHub Pages site. You must be an admin of the repository
59440+
in order to use this operation.
5944059441
tags:
5944159442
- repos
5944259443
operationId: repos/delete-pages-site
@@ -59454,7 +59455,6 @@ paths:
5945459455
'409': *228
5945559456
x-github:
5945659457
githubCloudOnly: false
59457-
enabledForGitHubApps: true
5945859458
category: pages
5945959459
"/repos/{owner}/{repo}/pages/builds":
5946059460
get:

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -194235,12 +194235,12 @@
194235194235
"summary": {
194236194236
"type": "string",
194237194237
"maxLength": 65535,
194238-
"description": "The summary of the check run. This parameter supports Markdown."
194238+
"description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
194239194239
},
194240194240
"text": {
194241194241
"type": "string",
194242194242
"maxLength": 65535,
194243-
"description": "The details of the check run. This parameter supports Markdown."
194243+
"description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
194244194244
},
194245194245
"annotations": {
194246194246
"type": "array",
@@ -339215,7 +339215,7 @@
339215339215
},
339216339216
"post": {
339217339217
"summary": "Create a GitHub Enterprise Cloud Pages site",
339218-
"description": "Configures a GitHub Enterprise Cloud Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
339218+
"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.",
339219339219
"tags": [
339220339220
"repos"
339221339221
],
@@ -339591,7 +339591,6 @@
339591339591
},
339592339592
"x-github": {
339593339593
"githubCloudOnly": false,
339594-
"enabledForGitHubApps": true,
339595339594
"category": "pages"
339596339595
}
339597339596
},
@@ -339900,7 +339899,7 @@
339900339899
},
339901339900
"delete": {
339902339901
"summary": "Delete a GitHub Enterprise Cloud Pages site",
339903-
"description": "",
339902+
"description": "Deletes a GitHub Pages site. You must be an admin of the repository in order to use this operation.",
339904339903
"tags": [
339905339904
"repos"
339906339905
],
@@ -340057,7 +340056,6 @@
340057340056
},
340058340057
"x-github": {
340059340058
"githubCloudOnly": false,
340060-
"enabledForGitHubApps": true,
340061340059
"category": "pages"
340062340060
}
340063340061
}

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39962,13 +39962,13 @@ paths:
3996239962
summary:
3996339963
type: string
3996439964
maxLength: 65535
39965-
description: The summary of the check run. This parameter supports
39966-
Markdown.
39965+
description: 'The summary of the check run. This parameter supports
39966+
Markdown. **Maximum length**: 65535 characters.'
3996739967
text:
3996839968
type: string
3996939969
maxLength: 65535
39970-
description: The details of the check run. This parameter supports
39971-
Markdown.
39970+
description: 'The details of the check run. This parameter supports
39971+
Markdown. **Maximum length**: 65535 characters.'
3997239972
annotations:
3997339973
type: array
3997439974
description: Adds information from your analysis to specific
@@ -60740,6 +60740,7 @@ paths:
6074060740
summary: Create a GitHub Enterprise Cloud Pages site
6074160741
description: Configures a GitHub Enterprise Cloud Pages site. For more information,
6074260742
see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
60743+
You must be an admin of the repository in order to use this operation.
6074360744
tags:
6074460745
- repos
6074560746
operationId: repos/create-pages-site
@@ -60809,7 +60810,6 @@ paths:
6080960810
'409': *251
6081060811
x-github:
6081160812
githubCloudOnly: false
60812-
enabledForGitHubApps: true
6081360813
category: pages
6081460814
put:
6081560815
summary: Update information about a GitHub Enterprise Cloud Pages site
@@ -60918,7 +60918,8 @@ paths:
6091860918
category: pages
6091960919
delete:
6092060920
summary: Delete a GitHub Enterprise Cloud Pages site
60921-
description: ''
60921+
description: Deletes a GitHub Pages site. You must be an admin of the repository
60922+
in order to use this operation.
6092260923
tags:
6092360924
- repos
6092460925
operationId: repos/delete-pages-site
@@ -60936,7 +60937,6 @@ paths:
6093660937
'409': *251
6093760938
x-github:
6093860939
githubCloudOnly: false
60939-
enabledForGitHubApps: true
6094060940
category: pages
6094160941
"/repos/{owner}/{repo}/pages/builds":
6094260942
get:

0 commit comments

Comments
 (0)