Skip to content

Commit 4bbadbf

Browse files
authored
Merge pull request #1540 from github/openapi-update-7d386b587ced94ac77628b885faf93fbc11d4de8722f610d38043c5dd0a839db
Update OpenAPI 3.0 Descriptions
2 parents baae884 + cec1b03 commit 4bbadbf

28 files changed

+142
-46
lines changed

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

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3515,7 +3515,7 @@
35153515
"/enterprises/{enterprise}/consumed-licenses": {
35163516
"get": {
35173517
"summary": "List enterprise consumed licenses",
3518-
"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.",
3518+
"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.",
35193519
"tags": [
35203520
"enterprise-admin"
35213521
],
@@ -30756,7 +30756,7 @@
3075630756
},
3075730757
"put": {
3075830758
"summary": "Create or update file contents",
30759-
"description": "Creates a new file or replaces an existing file in a repository.",
30759+
"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.",
3076030760
"tags": [
3076130761
"repos"
3076230762
],
@@ -34140,7 +34140,7 @@
3414034140
"/repos/{owner}/{repo}/hooks": {
3414134141
"get": {
3414234142
"summary": "List repository webhooks",
34143-
"description": "",
34143+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
3414434144
"tags": [
3414534145
"repos"
3414634146
],
@@ -62799,7 +62799,15 @@
6279962799
},
6280062800
"github_com_enterprise_role": {
6280162801
"type": "string",
62802-
"nullable": true
62802+
"nullable": true,
62803+
"description": "Deprecated: The most permissive enterprise role for a user."
62804+
},
62805+
"github_com_enterprise_roles": {
62806+
"type": "array",
62807+
"description": "All enterprise roles for a user.",
62808+
"items": {
62809+
"type": "string"
62810+
}
6280362811
},
6280462812
"visual_studio_subscription_user": {
6280562813
"type": "boolean"
@@ -89705,6 +89713,9 @@
8970589713
"org2:Owner"
8970689714
],
8970789715
"github_com_enterprise_role": "owner",
89716+
"github_com_enterprise_roles": [
89717+
"owner"
89718+
],
8970889719
"visual_studio_subscription_user": false,
8970989720
"github_com_verified_domain_emails": [
8971089721
@@ -89735,6 +89746,9 @@
8973589746

8973689747
],
8973789748
"github_com_enterprise_role": "",
89749+
"github_com_enterprise_roles": [
89750+
89751+
],
8973889752
"visual_studio_subscription_user": false,
8973989753
"github_com_verified_domain_emails": [
8974089754

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2485,6 +2485,9 @@ paths:
24852485
Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.
24862486
To use this endpoint, you must be an enterprise admin, and you must use an access
24872487
token with the `read:enterprise` scope.
2488+
2489+
**Note:** The license consumption API endpoints for enterprise accounts are currently
2490+
in Beta and are subject to change.
24882491
tags:
24892492
- enterprise-admin
24902493
operationId: enterprise-admin/get-consumed-licenses
@@ -22278,6 +22281,8 @@ paths:
2227822281
put:
2227922282
summary: Create or update file contents
2228022283
description: Creates a new file or replaces an existing file in a repository.
22284+
You must authenticate using an access token with the `workflow` scope to use
22285+
this endpoint.
2228122286
tags:
2228222287
- repos
2228322288
operationId: repos/create-or-update-file-contents
@@ -24918,7 +24923,8 @@ paths:
2491824923
"/repos/{owner}/{repo}/hooks":
2491924924
get:
2492024925
summary: List repository webhooks
24921-
description: ''
24926+
description: Lists webhooks for a repository. `last response` may return null
24927+
if there have not been any deliveries within 30 days.
2492224928
tags:
2492324929
- repos
2492424930
operationId: repos/list-webhooks
@@ -45490,6 +45496,13 @@ components:
4549045496
github_com_enterprise_role:
4549145497
type: string
4549245498
nullable: true
45499+
description: 'Deprecated: The most permissive enterprise role for
45500+
a user.'
45501+
github_com_enterprise_roles:
45502+
type: array
45503+
description: All enterprise roles for a user.
45504+
items:
45505+
type: string
4549345506
visual_studio_subscription_user:
4549445507
type: boolean
4549545508
github_com_verified_domain_emails:
@@ -66610,6 +66623,8 @@ components:
6661066623
- org1:Owner
6661166624
- org2:Owner
6661266625
github_com_enterprise_role: owner
66626+
github_com_enterprise_roles:
66627+
- owner
6661366628
visual_studio_subscription_user: false
6661466629
github_com_verified_domain_emails:
6661566630
@@ -66632,6 +66647,7 @@ components:
6663266647
license_type: enterprise
6663366648
github_com_member_roles: []
6663466649
github_com_enterprise_role: ''
66650+
github_com_enterprise_roles: []
6663566651
visual_studio_subscription_user: false
6663666652
github_com_verified_domain_emails: []
6663766653
github_com_saml_name_id: ''

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

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20073,7 +20073,7 @@
2007320073
"/enterprises/{enterprise}/consumed-licenses": {
2007420074
"get": {
2007520075
"summary": "List enterprise consumed licenses",
20076-
"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.",
20076+
"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.",
2007720077
"tags": [
2007820078
"enterprise-admin"
2007920079
],
@@ -20153,7 +20153,15 @@
2015320153
},
2015420154
"github_com_enterprise_role": {
2015520155
"type": "string",
20156-
"nullable": true
20156+
"nullable": true,
20157+
"description": "Deprecated: The most permissive enterprise role for a user."
20158+
},
20159+
"github_com_enterprise_roles": {
20160+
"type": "array",
20161+
"description": "All enterprise roles for a user.",
20162+
"items": {
20163+
"type": "string"
20164+
}
2015720165
},
2015820166
"visual_studio_subscription_user": {
2015920167
"type": "boolean"
@@ -20224,6 +20232,9 @@
2022420232
"org2:Owner"
2022520233
],
2022620234
"github_com_enterprise_role": "owner",
20235+
"github_com_enterprise_roles": [
20236+
"owner"
20237+
],
2022720238
"visual_studio_subscription_user": false,
2022820239
"github_com_verified_domain_emails": [
2022920240
@@ -20254,6 +20265,9 @@
2025420265

2025520266
],
2025620267
"github_com_enterprise_role": "",
20268+
"github_com_enterprise_roles": [
20269+
20270+
],
2025720271
"visual_studio_subscription_user": false,
2025820272
"github_com_verified_domain_emails": [
2025920273

@@ -240151,7 +240165,7 @@
240151240165
},
240152240166
"put": {
240153240167
"summary": "Create or update file contents",
240154-
"description": "Creates a new file or replaces an existing file in a repository.",
240168+
"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.",
240155240169
"tags": [
240156240170
"repos"
240157240171
],
@@ -263100,7 +263114,7 @@
263100263114
"/repos/{owner}/{repo}/hooks": {
263101263115
"get": {
263102263116
"summary": "List repository webhooks",
263103-
"description": "",
263117+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
263104263118
"tags": [
263105263119
"repos"
263106263120
],

0 commit comments

Comments
 (0)