Skip to content

Commit 4e75fa7

Browse files
beccobecco
authored
Merge pull request #634 from github/openapi-update-6749f4a8563783aa417ac7961bab6515731ca936a19dc7c3cfb12e478a47020d
Update OpenAPI Descriptions
2 parents 30b72db + b8ad9b4 commit 4e75fa7

24 files changed

Lines changed: 3840 additions & 564 deletions

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9197,13 +9197,7 @@
91979197
"$ref": "#/components/parameters/org"
91989198
},
91999199
{
9200-
"name": "group_id",
9201-
"description": "External Group Id",
9202-
"in": "path",
9203-
"schema": {
9204-
"type": "integer"
9205-
},
9206-
"required": true
9200+
"$ref": "#/components/parameters/group-id"
92079201
}
92089202
],
92099203
"responses": {
@@ -20669,13 +20663,6 @@
2066920663
"x-github": {
2067020664
"githubCloudOnly": false,
2067120665
"enabledForGitHubApps": true,
20672-
"previews": [
20673-
{
20674-
"required": false,
20675-
"name": "luke-cage",
20676-
"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```"
20677-
}
20678-
],
2067920666
"category": "repos",
2068020667
"subcategory": "branches"
2068120668
}
@@ -95326,6 +95313,15 @@
9532695313
"type": "string"
9532795314
}
9532895315
},
95316+
"group-id": {
95317+
"name": "group_id",
95318+
"description": "group_id parameter",
95319+
"in": "path",
95320+
"required": true,
95321+
"schema": {
95322+
"type": "integer"
95323+
}
95324+
},
9532995325
"hook-id": {
9533095326
"name": "hook_id",
9533195327
"in": "path",

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

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6647,12 +6647,7 @@ paths:
66476647
url: https://docs.github.com/rest/reference/teams#external-idp-group-info-for-an-organization
66486648
parameters:
66496649
- "$ref": "#/components/parameters/org"
6650-
- name: group_id
6651-
description: External Group Id
6652-
in: path
6653-
schema:
6654-
type: integer
6655-
required: true
6650+
- "$ref": "#/components/parameters/group-id"
66566651
responses:
66576652
'200':
66586653
description: Response
@@ -14793,14 +14788,6 @@ paths:
1479314788
x-github:
1479414789
githubCloudOnly: false
1479514790
enabledForGitHubApps: true
14796-
previews:
14797-
- required: false
14798-
name: luke-cage
14799-
note: |-
14800-
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:
14801-
```shell
14802-
application/vnd.github.luke-cage-preview+json
14803-
```
1480414791
category: repos
1480514792
subcategory: branches
1480614793
delete:
@@ -72735,6 +72722,13 @@ components:
7273572722
required: true
7273672723
schema:
7273772724
type: string
72725+
group-id:
72726+
name: group_id
72727+
description: group_id parameter
72728+
in: path
72729+
required: true
72730+
schema:
72731+
type: integer
7273872732
hook-id:
7273972733
name: hook_id
7274072734
in: path

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

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65840,12 +65840,12 @@
6584065840
},
6584165841
{
6584265842
"name": "group_id",
65843-
"description": "External Group Id",
65843+
"description": "group_id parameter",
6584465844
"in": "path",
65845+
"required": true,
6584565846
"schema": {
6584665847
"type": "integer"
65847-
},
65848-
"required": true
65848+
}
6584965849
}
6585065850
],
6585165851
"responses": {
@@ -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
}

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

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15307,11 +15307,11 @@ paths:
1530715307
required: true
1530815308
schema: *100
1530915309
- name: group_id
15310-
description: External Group Id
15310+
description: group_id parameter
1531115311
in: path
15312+
required: true
1531215313
schema:
1531315314
type: integer
15314-
required: true
1531515315
responses:
1531615316
'200':
1531715317
description: Response
@@ -34347,14 +34347,6 @@ paths:
3434734347
x-github:
3434834348
githubCloudOnly: false
3434934349
enabledForGitHubApps: true
34350-
previews:
34351-
- required: false
34352-
name: luke-cage
34353-
note: |-
34354-
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:
34355-
```shell
34356-
application/vnd.github.luke-cage-preview+json
34357-
```
3435834350
category: repos
3435934351
subcategory: branches
3436034352
delete:

‎descriptions/ghes-2.22/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": {

‎descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -970,6 +970,8 @@ paths:
970970
x-github:
971971
githubCloudOnly: false
972972
enabledForGitHubApps: false
973+
category: enterprise-admin
974+
subcategory: ldap
973975
previews:
974976
- required: false
975977
name: hellcat
@@ -978,8 +980,6 @@ paths:
978980
```shell
979981
application/vnd.github.hellcat-preview+json
980982
```
981-
category: enterprise-admin
982-
subcategory: ldap
983983
"/admin/ldap/teams/{team_id}/sync":
984984
post:
985985
summary: Sync LDAP mapping for a team
@@ -30126,6 +30126,8 @@ paths:
3012630126
x-github:
3012730127
githubCloudOnly: false
3012830128
enabledForGitHubApps: true
30129+
category: repos
30130+
subcategory: branches
3012930131
previews:
3013030132
- required: false
3013130133
name: luke-cage
@@ -30134,8 +30136,6 @@ paths:
3013430136
```shell
3013530137
application/vnd.github.luke-cage-preview+json
3013630138
```
30137-
category: repos
30138-
subcategory: branches
3013930139
delete:
3014030140
summary: Delete pull request review protection
3014130141
description: Protected branches are available in public repositories with GitHub

‎descriptions/ghes-2.22/ghes-2.22.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -992,15 +992,15 @@
992992
"x-github": {
993993
"githubCloudOnly": false,
994994
"enabledForGitHubApps": false,
995+
"category": "enterprise-admin",
996+
"subcategory": "ldap",
995997
"previews": [
996998
{
997999
"required": false,
9981000
"name": "hellcat",
9991001
"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```"
10001002
}
1001-
],
1002-
"category": "enterprise-admin",
1003-
"subcategory": "ldap"
1003+
]
10041004
}
10051005
}
10061006
},
@@ -18661,15 +18661,15 @@
1866118661
"x-github": {
1866218662
"githubCloudOnly": false,
1866318663
"enabledForGitHubApps": true,
18664+
"category": "repos",
18665+
"subcategory": "branches",
1866418666
"previews": [
1866518667
{
1866618668
"required": false,
1866718669
"name": "luke-cage",
1866818670
"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```"
1866918671
}
18670-
],
18671-
"category": "repos",
18672-
"subcategory": "branches"
18672+
]
1867318673
}
1867418674
},
1867518675
"delete": {

‎descriptions/ghes-2.22/ghes-2.22.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -711,6 +711,8 @@ paths:
711711
x-github:
712712
githubCloudOnly: false
713713
enabledForGitHubApps: false
714+
category: enterprise-admin
715+
subcategory: ldap
714716
previews:
715717
- required: false
716718
name: hellcat
@@ -719,8 +721,6 @@ paths:
719721
```shell
720722
application/vnd.github.hellcat-preview+json
721723
```
722-
category: enterprise-admin
723-
subcategory: ldap
724724
"/admin/ldap/teams/{team_id}/sync":
725725
post:
726726
summary: Sync LDAP mapping for a team
@@ -13658,6 +13658,8 @@ paths:
1365813658
x-github:
1365913659
githubCloudOnly: false
1366013660
enabledForGitHubApps: true
13661+
category: repos
13662+
subcategory: branches
1366113663
previews:
1366213664
- required: false
1366313665
name: luke-cage
@@ -13666,8 +13668,6 @@ paths:
1366613668
```shell
1366713669
application/vnd.github.luke-cage-preview+json
1366813670
```
13669-
category: repos
13670-
subcategory: branches
1367113671
delete:
1367213672
summary: Delete pull request review protection
1367313673
description: Protected branches are available in public repositories with GitHub

‎descriptions/ghes-3.0/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": {

‎descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -970,6 +970,8 @@ paths:
970970
x-github:
971971
githubCloudOnly: false
972972
enabledForGitHubApps: false
973+
category: enterprise-admin
974+
subcategory: ldap
973975
previews:
974976
- required: false
975977
name: hellcat
@@ -978,8 +980,6 @@ paths:
978980
```shell
979981
application/vnd.github.hellcat-preview+json
980982
```
981-
category: enterprise-admin
982-
subcategory: ldap
983983
"/admin/ldap/teams/{team_id}/sync":
984984
post:
985985
summary: Sync LDAP mapping for a team
@@ -31838,6 +31838,8 @@ paths:
3183831838
x-github:
3183931839
githubCloudOnly: false
3184031840
enabledForGitHubApps: true
31841+
category: repos
31842+
subcategory: branches
3184131843
previews:
3184231844
- required: false
3184331845
name: luke-cage
@@ -31846,8 +31848,6 @@ paths:
3184631848
```shell
3184731849
application/vnd.github.luke-cage-preview+json
3184831850
```
31849-
category: repos
31850-
subcategory: branches
3185131851
delete:
3185231852
summary: Delete pull request review protection
3185331853
description: Protected branches are available in public repositories with GitHub

0 commit comments

Comments
 (0)