Skip to content

Commit 29e66d2

Browse files
Update OpenAPI Descriptions (github#22260)
* Update OpenAPI Descriptions
1 parent 7294659 commit 29e66d2

12 files changed

+48
-78
lines changed

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

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39530,14 +39530,6 @@
3953039530
"x-github": {
3953139531
"githubCloudOnly": false,
3953239532
"enabledForGitHubApps": true,
39533-
"previews": [
39534-
{
39535-
"required": false,
39536-
"name": "luke-cage",
39537-
"note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
39538-
"html": "<p>The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews\">blog post</a> for full details. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.luke-cage-preview+json</code></pre>"
39539-
}
39540-
],
3954139533
"category": "repos",
3954239534
"subcategory": "branches"
3954339535
},

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1289,16 +1289,16 @@
12891289
"x-github": {
12901290
"githubCloudOnly": false,
12911291
"enabledForGitHubApps": false,
1292+
"category": "enterprise-admin",
1293+
"subcategory": "ldap",
12921294
"previews": [
12931295
{
12941296
"required": false,
12951297
"name": "hellcat",
12961298
"note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
12971299
"html": "<p>The Nested Teams API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2017-08-30-preview-nested-teams\">blog post</a> for full details. To access the API, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.hellcat-preview+json</code></pre>"
12981300
}
1299-
],
1300-
"category": "enterprise-admin",
1301-
"subcategory": "ldap"
1301+
]
13021302
},
13031303
"slug": "update-ldap-mapping-for-a-team",
13041304
"category": "enterprise-admin",
@@ -33077,16 +33077,16 @@
3307733077
"x-github": {
3307833078
"githubCloudOnly": false,
3307933079
"enabledForGitHubApps": true,
33080+
"category": "repos",
33081+
"subcategory": "branches",
3308033082
"previews": [
3308133083
{
3308233084
"required": false,
3308333085
"name": "luke-cage",
3308433086
"note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
3308533087
"html": "<p>The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews\">blog post</a> for full details. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.luke-cage-preview+json</code></pre>"
3308633088
}
33087-
],
33088-
"category": "repos",
33089-
"subcategory": "branches"
33089+
]
3309033090
},
3309133091
"slug": "update-pull-request-review-protection",
3309233092
"category": "repos",

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1289,16 +1289,16 @@
12891289
"x-github": {
12901290
"githubCloudOnly": false,
12911291
"enabledForGitHubApps": false,
1292+
"category": "enterprise-admin",
1293+
"subcategory": "ldap",
12921294
"previews": [
12931295
{
12941296
"required": false,
12951297
"name": "hellcat",
12961298
"note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
12971299
"html": "<p>The Nested Teams API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2017-08-30-preview-nested-teams\">blog post</a> for full details. To access the API, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.hellcat-preview+json</code></pre>"
12981300
}
1299-
],
1300-
"category": "enterprise-admin",
1301-
"subcategory": "ldap"
1301+
]
13021302
},
13031303
"slug": "update-ldap-mapping-for-a-team",
13041304
"category": "enterprise-admin",
@@ -37657,16 +37657,16 @@
3765737657
"x-github": {
3765837658
"githubCloudOnly": false,
3765937659
"enabledForGitHubApps": true,
37660+
"category": "repos",
37661+
"subcategory": "branches",
3766037662
"previews": [
3766137663
{
3766237664
"required": false,
3766337665
"name": "luke-cage",
3766437666
"note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
3766537667
"html": "<p>The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews\">blog post</a> for full details. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.luke-cage-preview+json</code></pre>"
3766637668
}
37667-
],
37668-
"category": "repos",
37669-
"subcategory": "branches"
37669+
]
3767037670
},
3767137671
"slug": "update-pull-request-review-protection",
3767237672
"category": "repos",

lib/rest/static/decorated/ghes-3.1.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1289,16 +1289,16 @@
12891289
"x-github": {
12901290
"githubCloudOnly": false,
12911291
"enabledForGitHubApps": false,
1292+
"category": "enterprise-admin",
1293+
"subcategory": "ldap",
12921294
"previews": [
12931295
{
12941296
"required": false,
12951297
"name": "hellcat",
12961298
"note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
12971299
"html": "<p>The Nested Teams API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2017-08-30-preview-nested-teams\">blog post</a> for full details. To access the API, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.hellcat-preview+json</code></pre>"
12981300
}
1299-
],
1300-
"category": "enterprise-admin",
1301-
"subcategory": "ldap"
1301+
]
13021302
},
13031303
"slug": "update-ldap-mapping-for-a-team",
13041304
"category": "enterprise-admin",
@@ -37794,16 +37794,16 @@
3779437794
"x-github": {
3779537795
"githubCloudOnly": false,
3779637796
"enabledForGitHubApps": true,
37797+
"category": "repos",
37798+
"subcategory": "branches",
3779737799
"previews": [
3779837800
{
3779937801
"required": false,
3780037802
"name": "luke-cage",
3780137803
"note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
3780237804
"html": "<p>The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews\">blog post</a> for full details. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.luke-cage-preview+json</code></pre>"
3780337805
}
37804-
],
37805-
"category": "repos",
37806-
"subcategory": "branches"
37806+
]
3780737807
},
3780837808
"slug": "update-pull-request-review-protection",
3780937809
"category": "repos",

lib/rest/static/decorated/ghes-3.2.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1289,16 +1289,16 @@
12891289
"x-github": {
12901290
"githubCloudOnly": false,
12911291
"enabledForGitHubApps": false,
1292+
"category": "enterprise-admin",
1293+
"subcategory": "ldap",
12921294
"previews": [
12931295
{
12941296
"required": false,
12951297
"name": "hellcat",
12961298
"note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
12971299
"html": "<p>The Nested Teams API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2017-08-30-preview-nested-teams\">blog post</a> for full details. To access the API, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.hellcat-preview+json</code></pre>"
12981300
}
1299-
],
1300-
"category": "enterprise-admin",
1301-
"subcategory": "ldap"
1301+
]
13021302
},
13031303
"slug": "update-ldap-mapping-for-a-team",
13041304
"category": "enterprise-admin",
@@ -39040,16 +39040,16 @@
3904039040
"x-github": {
3904139041
"githubCloudOnly": false,
3904239042
"enabledForGitHubApps": true,
39043+
"category": "repos",
39044+
"subcategory": "branches",
3904339045
"previews": [
3904439046
{
3904539047
"required": false,
3904639048
"name": "luke-cage",
3904739049
"note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
3904839050
"html": "<p>The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews\">blog post</a> for full details. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.luke-cage-preview+json</code></pre>"
3904939051
}
39050-
],
39051-
"category": "repos",
39052-
"subcategory": "branches"
39052+
]
3905339053
},
3905439054
"slug": "update-pull-request-review-protection",
3905539055
"category": "repos",

lib/rest/static/decorated/github.ae.json

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31163,14 +31163,6 @@
3116331163
"x-github": {
3116431164
"githubCloudOnly": false,
3116531165
"enabledForGitHubApps": true,
31166-
"previews": [
31167-
{
31168-
"required": false,
31169-
"name": "luke-cage",
31170-
"note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
31171-
"html": "<p>The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews\">blog post</a> for full details. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.luke-cage-preview+json</code></pre>"
31172-
}
31173-
],
3117431166
"category": "repos",
3117531167
"subcategory": "branches"
3117631168
},

lib/rest/static/dereferenced/api.github.com.deref.json

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -155634,13 +155634,6 @@
155634155634
"x-github": {
155635155635
"githubCloudOnly": false,
155636155636
"enabledForGitHubApps": true,
155637-
"previews": [
155638-
{
155639-
"required": false,
155640-
"name": "luke-cage",
155641-
"note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```"
155642-
}
155643-
],
155644155637
"category": "repos",
155645155638
"subcategory": "branches"
155646155639
}

lib/rest/static/dereferenced/ghes-2.22.deref.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1462,15 +1462,15 @@
14621462
"x-github": {
14631463
"githubCloudOnly": false,
14641464
"enabledForGitHubApps": false,
1465+
"category": "enterprise-admin",
1466+
"subcategory": "ldap",
14651467
"previews": [
14661468
{
14671469
"required": false,
14681470
"name": "hellcat",
14691471
"note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
14701472
}
1471-
],
1472-
"category": "enterprise-admin",
1473-
"subcategory": "ldap"
1473+
]
14741474
}
14751475
}
14761476
},
@@ -127999,15 +127999,15 @@
127999127999
"x-github": {
128000128000
"githubCloudOnly": false,
128001128001
"enabledForGitHubApps": true,
128002+
"category": "repos",
128003+
"subcategory": "branches",
128002128004
"previews": [
128003128005
{
128004128006
"required": false,
128005128007
"name": "luke-cage",
128006128008
"note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```"
128007128009
}
128008-
],
128009-
"category": "repos",
128010-
"subcategory": "branches"
128010+
]
128011128011
}
128012128012
},
128013128013
"delete": {

lib/rest/static/dereferenced/ghes-3.0.deref.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1462,15 +1462,15 @@
14621462
"x-github": {
14631463
"githubCloudOnly": false,
14641464
"enabledForGitHubApps": false,
1465+
"category": "enterprise-admin",
1466+
"subcategory": "ldap",
14651467
"previews": [
14661468
{
14671469
"required": false,
14681470
"name": "hellcat",
14691471
"note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
14701472
}
1471-
],
1472-
"category": "enterprise-admin",
1473-
"subcategory": "ldap"
1473+
]
14741474
}
14751475
}
14761476
},
@@ -134164,15 +134164,15 @@
134164134164
"x-github": {
134165134165
"githubCloudOnly": false,
134166134166
"enabledForGitHubApps": true,
134167+
"category": "repos",
134168+
"subcategory": "branches",
134167134169
"previews": [
134168134170
{
134169134171
"required": false,
134170134172
"name": "luke-cage",
134171134173
"note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```"
134172134174
}
134173-
],
134174-
"category": "repos",
134175-
"subcategory": "branches"
134175+
]
134176134176
}
134177134177
},
134178134178
"delete": {

0 commit comments

Comments
 (0)