Skip to content

Commit 5860f47

Browse files
authored
Merge pull request #1541 from github/openapi-update-4c7677aff2714ca12e804c2b2b9cebd4be41ac53fb9674875f55af14604869c8
Update OpenAPI 3.1 Descriptions
2 parents 4bbadbf + ff2ae50 commit 5860f47

28 files changed

Lines changed: 142 additions & 46 deletions

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

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3531,7 +3531,7 @@
35313531
"/enterprises/{enterprise}/consumed-licenses": {
35323532
"get": {
35333533
"summary": "List enterprise consumed licenses",
3534-
"description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
3534+
"description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.\n\n**Note:** The license consumption API endpoints for enterprise accounts are currently\nin Beta and are subject to change.",
35353535
"tags": [
35363536
"enterprise-admin"
35373537
],
@@ -30906,7 +30906,7 @@
3090630906
},
3090730907
"put": {
3090830908
"summary": "Create or update file contents",
30909-
"description": "Creates a new file or replaces an existing file in a repository.",
30909+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
3091030910
"tags": [
3091130911
"repos"
3091230912
],
@@ -34314,7 +34314,7 @@
3431434314
"/repos/{owner}/{repo}/hooks": {
3431534315
"get": {
3431634316
"summary": "List repository webhooks",
34317-
"description": "",
34317+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
3431834318
"tags": [
3431934319
"repos"
3432034320
],
@@ -63673,7 +63673,15 @@
6367363673
"type": [
6367463674
"string",
6367563675
"null"
63676-
]
63676+
],
63677+
"description": "Deprecated: The most permissive enterprise role for a user."
63678+
},
63679+
"github_com_enterprise_roles": {
63680+
"type": "array",
63681+
"description": "All enterprise roles for a user.",
63682+
"items": {
63683+
"type": "string"
63684+
}
6367763685
},
6367863686
"visual_studio_subscription_user": {
6367963687
"type": "boolean"
@@ -92606,6 +92614,9 @@
9260692614
"org2:Owner"
9260792615
],
9260892616
"github_com_enterprise_role": "owner",
92617+
"github_com_enterprise_roles": [
92618+
"owner"
92619+
],
9260992620
"visual_studio_subscription_user": false,
9261092621
"github_com_verified_domain_emails": [
9261192622
"monalisa@github.com"
@@ -92636,6 +92647,9 @@
9263692647

9263792648
],
9263892649
"github_com_enterprise_role": "",
92650+
"github_com_enterprise_roles": [
92651+
92652+
],
9263992653
"visual_studio_subscription_user": false,
9264092654
"github_com_verified_domain_emails": [
9264192655

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2493,6 +2493,9 @@ paths:
24932493
Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.
24942494
To use this endpoint, you must be an enterprise admin, and you must use an access
24952495
token with the `read:enterprise` scope.
2496+
2497+
**Note:** The license consumption API endpoints for enterprise accounts are currently
2498+
in Beta and are subject to change.
24962499
tags:
24972500
- enterprise-admin
24982501
operationId: enterprise-admin/get-consumed-licenses
@@ -22350,6 +22353,8 @@ paths:
2235022353
put:
2235122354
summary: Create or update file contents
2235222355
description: Creates a new file or replaces an existing file in a repository.
22356+
You must authenticate using an access token with the `workflow` scope to use
22357+
this endpoint.
2235322358
tags:
2235422359
- repos
2235522360
operationId: repos/create-or-update-file-contents
@@ -25002,7 +25007,8 @@ paths:
2500225007
"/repos/{owner}/{repo}/hooks":
2500325008
get:
2500425009
summary: List repository webhooks
25005-
description: ''
25010+
description: Lists webhooks for a repository. `last response` may return null
25011+
if there have not been any deliveries within 30 days.
2500625012
tags:
2500725013
- repos
2500825014
operationId: repos/list-webhooks
@@ -45880,6 +45886,13 @@ components:
4588045886
type:
4588145887
- string
4588245888
- 'null'
45889+
description: 'Deprecated: The most permissive enterprise role for
45890+
a user.'
45891+
github_com_enterprise_roles:
45892+
type: array
45893+
description: All enterprise roles for a user.
45894+
items:
45895+
type: string
4588345896
visual_studio_subscription_user:
4588445897
type: boolean
4588545898
github_com_verified_domain_emails:
@@ -67197,6 +67210,8 @@ components:
6719767210
- org1:Owner
6719867211
- org2:Owner
6719967212
github_com_enterprise_role: owner
67213+
github_com_enterprise_roles:
67214+
- owner
6720067215
visual_studio_subscription_user: false
6720167216
github_com_verified_domain_emails:
6720267217
- monalisa@github.com
@@ -67219,6 +67234,7 @@ components:
6721967234
license_type: enterprise
6722067235
github_com_member_roles: []
6722167236
github_com_enterprise_role: ''
67237+
github_com_enterprise_roles: []
6722267238
visual_studio_subscription_user: false
6722367239
github_com_verified_domain_emails: []
6722467240
github_com_saml_name_id: ''

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

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22270,7 +22270,7 @@
2227022270
"/enterprises/{enterprise}/consumed-licenses": {
2227122271
"get": {
2227222272
"summary": "List enterprise consumed licenses",
22273-
"description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
22273+
"description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.\n\n**Note:** The license consumption API endpoints for enterprise accounts are currently\nin Beta and are subject to change.",
2227422274
"tags": [
2227522275
"enterprise-admin"
2227622276
],
@@ -22356,7 +22356,15 @@
2235622356
"type": [
2235722357
"string",
2235822358
"null"
22359-
]
22359+
],
22360+
"description": "Deprecated: The most permissive enterprise role for a user."
22361+
},
22362+
"github_com_enterprise_roles": {
22363+
"type": "array",
22364+
"description": "All enterprise roles for a user.",
22365+
"items": {
22366+
"type": "string"
22367+
}
2236022368
},
2236122369
"visual_studio_subscription_user": {
2236222370
"type": "boolean"
@@ -22433,6 +22441,9 @@
2243322441
"org2:Owner"
2243422442
],
2243522443
"github_com_enterprise_role": "owner",
22444+
"github_com_enterprise_roles": [
22445+
"owner"
22446+
],
2243622447
"visual_studio_subscription_user": false,
2243722448
"github_com_verified_domain_emails": [
2243822449
"monalisa@github.com"
@@ -22463,6 +22474,9 @@
2246322474

2246422475
],
2246522476
"github_com_enterprise_role": "",
22477+
"github_com_enterprise_roles": [
22478+
22479+
],
2246622480
"visual_studio_subscription_user": false,
2246722481
"github_com_verified_domain_emails": [
2246822482

@@ -283626,7 +283640,7 @@
283626283640
},
283627283641
"put": {
283628283642
"summary": "Create or update file contents",
283629-
"description": "Creates a new file or replaces an existing file in a repository.",
283643+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
283630283644
"tags": [
283631283645
"repos"
283632283646
],
@@ -310635,7 +310649,7 @@
310635310649
"/repos/{owner}/{repo}/hooks": {
310636310650
"get": {
310637310651
"summary": "List repository webhooks",
310638-
"description": "",
310652+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
310639310653
"tags": [
310640310654
"repos"
310641310655
],

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8938,6 +8938,9 @@ paths:
89388938
Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.
89398939
To use this endpoint, you must be an enterprise admin, and you must use an access
89408940
token with the `read:enterprise` scope.
8941+
8942+
**Note:** The license consumption API endpoints for enterprise accounts are currently
8943+
in Beta and are subject to change.
89418944
tags:
89428945
- enterprise-admin
89438946
operationId: enterprise-admin/get-consumed-licenses
@@ -8986,6 +8989,13 @@ paths:
89868989
type:
89878990
- string
89888991
- 'null'
8992+
description: 'Deprecated: The most permissive enterprise
8993+
role for a user.'
8994+
github_com_enterprise_roles:
8995+
type: array
8996+
description: All enterprise roles for a user.
8997+
items:
8998+
type: string
89898999
visual_studio_subscription_user:
89909000
type: boolean
89919001
github_com_verified_domain_emails:
@@ -9036,6 +9046,8 @@ paths:
90369046
- org1:Owner
90379047
- org2:Owner
90389048
github_com_enterprise_role: owner
9049+
github_com_enterprise_roles:
9050+
- owner
90399051
visual_studio_subscription_user: false
90409052
github_com_verified_domain_emails:
90419053
- monalisa@github.com
@@ -9058,6 +9070,7 @@ paths:
90589070
license_type: enterprise
90599071
github_com_member_roles: []
90609072
github_com_enterprise_role: ''
9073+
github_com_enterprise_roles: []
90619074
visual_studio_subscription_user: false
90629075
github_com_verified_domain_emails: []
90639076
github_com_saml_name_id: ''
@@ -48764,6 +48777,8 @@ paths:
4876448777
put:
4876548778
summary: Create or update file contents
4876648779
description: Creates a new file or replaces an existing file in a repository.
48780+
You must authenticate using an access token with the `workflow` scope to use
48781+
this endpoint.
4876748782
tags:
4876848783
- repos
4876948784
operationId: repos/create-or-update-file-contents
@@ -53167,7 +53182,8 @@ paths:
5316753182
"/repos/{owner}/{repo}/hooks":
5316853183
get:
5316953184
summary: List repository webhooks
53170-
description: ''
53185+
description: Lists webhooks for a repository. `last response` may return null
53186+
if there have not been any deliveries within 30 days.
5317153187
tags:
5317253188
- repos
5317353189
operationId: repos/list-webhooks

descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225938,7 +225938,7 @@
225938225938
},
225939225939
"put": {
225940225940
"summary": "Create or update file contents",
225941-
"description": "Creates a new file or replaces an existing file in a repository.",
225941+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
225942225942
"tags": [
225943225943
"repos"
225944225944
],
@@ -251280,7 +251280,7 @@
251280251280
"/repos/{owner}/{repo}/hooks": {
251281251281
"get": {
251282251282
"summary": "List repository webhooks",
251283-
"description": "",
251283+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
251284251284
"tags": [
251285251285
"repos"
251286251286
],

descriptions-next/ghes-3.2/dereferenced/ghes-3.2.deref.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41384,6 +41384,8 @@ paths:
4138441384
put:
4138541385
summary: Create or update file contents
4138641386
description: Creates a new file or replaces an existing file in a repository.
41387+
You must authenticate using an access token with the `workflow` scope to use
41388+
this endpoint.
4138741389
tags:
4138841390
- repos
4138941391
operationId: repos/create-or-update-file-contents
@@ -45106,7 +45108,8 @@ paths:
4510645108
"/repos/{owner}/{repo}/hooks":
4510745109
get:
4510845110
summary: List repository webhooks
45109-
description: ''
45111+
description: Lists webhooks for a repository. `last response` may return null
45112+
if there have not been any deliveries within 30 days.
4511045113
tags:
4511145114
- repos
4511245115
operationId: repos/list-webhooks

descriptions-next/ghes-3.2/ghes-3.2.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26988,7 +26988,7 @@
2698826988
},
2698926989
"put": {
2699026990
"summary": "Create or update file contents",
26991-
"description": "Creates a new file or replaces an existing file in a repository.",
26991+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
2699226992
"tags": [
2699326993
"repos"
2699426994
],
@@ -30023,7 +30023,7 @@
3002330023
"/repos/{owner}/{repo}/hooks": {
3002430024
"get": {
3002530025
"summary": "List repository webhooks",
30026-
"description": "",
30026+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
3002730027
"tags": [
3002830028
"repos"
3002930029
],

0 commit comments

Comments
 (0)