Skip to content

Commit c30d13b

Browse files
beccobecco
authored
Merge pull request #630 from github/openapi-update-1866343e7087943544af384a11fbd158e13e13bfcb00777025d60d4935351455
Update OpenAPI Descriptions
2 parents 74e228b + f80a0d8 commit c30d13b

24 files changed

+802
-276
lines changed

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

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9199,10 +9199,11 @@
91999199
{
92009200
"name": "group_id",
92019201
"description": "External Group Id",
9202-
"in": "query",
9202+
"in": "path",
92039203
"schema": {
92049204
"type": "integer"
9205-
}
9205+
},
9206+
"required": true
92069207
}
92079208
],
92089209
"responses": {
@@ -9254,7 +9255,7 @@
92549255
"description": "Page token",
92559256
"in": "query",
92569257
"schema": {
9257-
"type": "string"
9258+
"type": "integer"
92589259
}
92599260
},
92609261
{
@@ -12492,7 +12493,6 @@
1249212493
"enum": [
1249312494
"public",
1249412495
"private",
12495-
"visibility",
1249612496
"internal"
1249712497
]
1249812498
},
@@ -14268,7 +14268,7 @@
1426814268
"tags": [
1426914269
"teams"
1427014270
],
14271-
"operationId": "operations/teams/link-external-idp-group-to-team-for-org",
14271+
"operationId": "teams/link-external-idp-group-to-team-for-org",
1427214272
"externalDocs": {
1427314273
"description": "API method documentation",
1427414274
"url": "https://docs.github.com/rest/reference/teams#link-external-idp-group-team-connection"
@@ -14334,7 +14334,7 @@
1433414334
"tags": [
1433514335
"teams"
1433614336
],
14337-
"operationId": "operations/teams/unlink-external-idp-group-from-team-for-org",
14337+
"operationId": "teams/unlink-external-idp-group-from-team-for-org",
1433814338
"externalDocs": {
1433914339
"description": "API method documentation",
1434014340
"url": "https://docs.github.com/rest/reference/teams#unlink-external-idp-group-team-connection"
@@ -16933,7 +16933,6 @@
1693316933
"enum": [
1693416934
"public",
1693516935
"private",
16936-
"visibility",
1693716936
"internal"
1693816937
]
1693916938
},
@@ -22675,7 +22674,7 @@
2267522674
},
2267622675
"actions": {
2267722676
"type": "array",
22678-
"description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"",
22677+
"description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"",
2267922678
"maxItems": 3,
2268022679
"items": {
2268122680
"type": "object",
@@ -24346,7 +24345,7 @@
2434624345
"/repos/{owner}/{repo}/collaborators": {
2434724346
"get": {
2434824347
"summary": "List repository collaborators",
24349-
"description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.",
24348+
"description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nYou must have push access to the repository in order to list collaborators.",
2435024349
"tags": [
2435124350
"repos"
2435224351
],
@@ -49289,9 +49288,6 @@
4928949288
}
4929049289
}
4929149290
},
49292-
"202": {
49293-
"$ref": "#/components/responses/accepted"
49294-
},
4929549291
"404": {
4929649292
"$ref": "#/components/responses/not_found"
4929749293
}
@@ -64639,7 +64635,16 @@
6463964635
"default": {
6464064636
"type": "boolean"
6464164637
}
64642-
}
64638+
},
64639+
"required": [
64640+
"id",
64641+
"node_id",
64642+
"url",
64643+
"name",
64644+
"description",
64645+
"color",
64646+
"default"
64647+
]
6464364648
}
6464464649
},
6464564650
"milestone": {
@@ -70105,7 +70110,16 @@
7010570110
"default": {
7010670111
"type": "boolean"
7010770112
}
70108-
}
70113+
},
70114+
"required": [
70115+
"id",
70116+
"node_id",
70117+
"url",
70118+
"name",
70119+
"description",
70120+
"color",
70121+
"default"
70122+
]
7010970123
}
7011070124
},
7011170125
"milestone": {

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

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6649,9 +6649,10 @@ paths:
66496649
- "$ref": "#/components/parameters/org"
66506650
- name: group_id
66516651
description: External Group Id
6652-
in: query
6652+
in: path
66536653
schema:
66546654
type: integer
6655+
required: true
66556656
responses:
66566657
'200':
66576658
description: Response
@@ -6687,7 +6688,7 @@ paths:
66876688
description: Page token
66886689
in: query
66896690
schema:
6690-
type: string
6691+
type: integer
66916692
- name: display_name
66926693
description: Limits the list to groups containing the text in the group name
66936694
in: query
@@ -8962,7 +8963,6 @@ paths:
89628963
enum:
89638964
- public
89648965
- private
8965-
- visibility
89668966
- internal
89678967
has_issues:
89688968
type: boolean
@@ -10240,7 +10240,7 @@ paths:
1024010240
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation.
1024110241
tags:
1024210242
- teams
10243-
operationId: operations/teams/link-external-idp-group-to-team-for-org
10243+
operationId: teams/link-external-idp-group-to-team-for-org
1024410244
externalDocs:
1024510245
description: API method documentation
1024610246
url: https://docs.github.com/rest/reference/teams#link-external-idp-group-team-connection
@@ -10285,7 +10285,7 @@ paths:
1028510285
You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
1028610286
tags:
1028710287
- teams
10288-
operationId: operations/teams/unlink-external-idp-group-from-team-for-org
10288+
operationId: teams/unlink-external-idp-group-from-team-for-org
1028910289
externalDocs:
1029010290
description: API method documentation
1029110291
url: https://docs.github.com/rest/reference/teams#unlink-external-idp-group-team-connection
@@ -12110,7 +12110,6 @@ paths:
1211012110
enum:
1211112111
- public
1211212112
- private
12113-
- visibility
1211412113
- internal
1211512114
security_and_analysis:
1211612115
type: object
@@ -16241,8 +16240,6 @@ paths:
1624116240
[`actions` object](https://docs.github.com/rest/reference/checks#actions-object)
1624216241
description. To learn more about check runs and requested actions,
1624316242
see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)."
16244-
To learn more about check runs and requested actions, see "[Check
16245-
runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)."
1624616243
maxItems: 3
1624716244
items:
1624816245
type: object
@@ -17553,6 +17550,8 @@ paths:
1755317550
For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
1755417551

1755517552
Team members will include the members of child teams.
17553+
17554+
You must have push access to the repository in order to list collaborators.
1755617555
tags:
1755717556
- repos
1755817557
operationId: repos/list-collaborators
@@ -35463,8 +35462,6 @@ paths:
3546335462
"$ref": "#/components/examples/public-user-default-response"
3546435463
response-with-git-hub-plan-information:
3546535464
"$ref": "#/components/examples/public-user-response-with-git-hub-plan-information"
35466-
'202':
35467-
"$ref": "#/components/responses/accepted"
3546835465
'404':
3546935466
"$ref": "#/components/responses/not_found"
3547035467
x-github:
@@ -47185,6 +47182,14 @@ components:
4718547182
type: string
4718647183
default:
4718747184
type: boolean
47185+
required:
47186+
- id
47187+
- node_id
47188+
- url
47189+
- name
47190+
- description
47191+
- color
47192+
- default
4718847193
milestone:
4718947194
"$ref": "#/components/schemas/nullable-milestone"
4719047195
active_lock_reason:
@@ -51266,6 +51271,14 @@ components:
5126651271
type: string
5126751272
default:
5126851273
type: boolean
51274+
required:
51275+
- id
51276+
- node_id
51277+
- url
51278+
- name
51279+
- description
51280+
- color
51281+
- default
5126951282
milestone:
5127051283
"$ref": "#/components/schemas/nullable-milestone"
5127151284
active_lock_reason:

0 commit comments

Comments
 (0)