Skip to content

Commit 58951a7

Browse files
octokitbotOctokit Bot
andauthored
feat: add new request parameters and response attributes, plus some small description fixes (see PR body) (#291)
WIP: schema updates Co-authored-by: Octokit Bot <[email protected]>
1 parent e0972bc commit 58951a7

34 files changed

+656
-64
lines changed

cache/api.github.com.deref.json

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20057,7 +20057,7 @@
2005720057
"/enterprises/{enterprise}/consumed-licenses": {
2005820058
"get": {
2005920059
"summary": "List enterprise consumed licenses",
20060-
"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.",
20060+
"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.",
2006120061
"tags": [
2006220062
"enterprise-admin"
2006320063
],
@@ -20137,7 +20137,15 @@
2013720137
},
2013820138
"github_com_enterprise_role": {
2013920139
"type": "string",
20140-
"nullable": true
20140+
"nullable": true,
20141+
"description": "Deprecated: The most permissive enterprise role for a user."
20142+
},
20143+
"github_com_enterprise_roles": {
20144+
"type": "array",
20145+
"description": "All enterprise roles for a user.",
20146+
"items": {
20147+
"type": "string"
20148+
}
2014120149
},
2014220150
"visual_studio_subscription_user": {
2014320151
"type": "boolean"
@@ -20208,6 +20216,9 @@
2020820216
"org2:Owner"
2020920217
],
2021020218
"github_com_enterprise_role": "owner",
20219+
"github_com_enterprise_roles": [
20220+
"owner"
20221+
],
2021120222
"visual_studio_subscription_user": false,
2021220223
"github_com_verified_domain_emails": [
2021320224
@@ -20236,6 +20247,7 @@
2023620247
"license_type": "enterprise",
2023720248
"github_com_member_roles": [],
2023820249
"github_com_enterprise_role": "",
20250+
"github_com_enterprise_roles": [],
2023920251
"visual_studio_subscription_user": false,
2024020252
"github_com_verified_domain_emails": [],
2024120253
"github_com_saml_name_id": "",
@@ -218292,6 +218304,22 @@
218292218304
"default": "all"
218293218305
}
218294218306
},
218307+
{
218308+
"name": "permission",
218309+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
218310+
"in": "query",
218311+
"required": false,
218312+
"schema": {
218313+
"type": "string",
218314+
"enum": [
218315+
"pull",
218316+
"triage",
218317+
"push",
218318+
"maintain",
218319+
"admin"
218320+
]
218321+
}
218322+
},
218295218323
{
218296218324
"name": "per_page",
218297218325
"description": "The number of results per page (max 100).",
@@ -239971,7 +239999,7 @@
239971239999
},
239972240000
"put": {
239973240001
"summary": "Create or update file contents",
239974-
"description": "Creates a new file or replaces an existing file in a repository.",
240002+
"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.",
239975240003
"tags": [
239976240004
"repos"
239977240005
],
@@ -262912,7 +262940,7 @@
262912262940
"/repos/{owner}/{repo}/hooks": {
262913262941
"get": {
262914262942
"summary": "List repository webhooks",
262915-
"description": "",
262943+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
262916262944
"tags": [
262917262945
"repos"
262918262946
],

cache/api.github.com.json

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3507,7 +3507,7 @@
35073507
"/enterprises/{enterprise}/consumed-licenses": {
35083508
"get": {
35093509
"summary": "List enterprise consumed licenses",
3510-
"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.",
3510+
"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.",
35113511
"tags": [
35123512
"enterprise-admin"
35133513
],
@@ -28974,6 +28974,22 @@
2897428974
"default": "all"
2897528975
}
2897628976
},
28977+
{
28978+
"name": "permission",
28979+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
28980+
"in": "query",
28981+
"required": false,
28982+
"schema": {
28983+
"type": "string",
28984+
"enum": [
28985+
"pull",
28986+
"triage",
28987+
"push",
28988+
"maintain",
28989+
"admin"
28990+
]
28991+
}
28992+
},
2897728993
{
2897828994
"$ref": "#/components/parameters/per-page"
2897928995
},
@@ -30676,7 +30692,7 @@
3067630692
},
3067730693
"put": {
3067830694
"summary": "Create or update file contents",
30679-
"description": "Creates a new file or replaces an existing file in a repository.",
30695+
"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.",
3068030696
"tags": [
3068130697
"repos"
3068230698
],
@@ -34060,7 +34076,7 @@
3406034076
"/repos/{owner}/{repo}/hooks": {
3406134077
"get": {
3406234078
"summary": "List repository webhooks",
34063-
"description": "",
34079+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
3406434080
"tags": [
3406534081
"repos"
3406634082
],
@@ -62688,7 +62704,15 @@
6268862704
},
6268962705
"github_com_enterprise_role": {
6269062706
"type": "string",
62691-
"nullable": true
62707+
"nullable": true,
62708+
"description": "Deprecated: The most permissive enterprise role for a user."
62709+
},
62710+
"github_com_enterprise_roles": {
62711+
"type": "array",
62712+
"description": "All enterprise roles for a user.",
62713+
"items": {
62714+
"type": "string"
62715+
}
6269262716
},
6269362717
"visual_studio_subscription_user": {
6269462718
"type": "boolean"
@@ -89573,6 +89597,9 @@
8957389597
"org2:Owner"
8957489598
],
8957589599
"github_com_enterprise_role": "owner",
89600+
"github_com_enterprise_roles": [
89601+
"owner"
89602+
],
8957689603
"visual_studio_subscription_user": false,
8957789604
"github_com_verified_domain_emails": [
8957889605
@@ -89601,6 +89628,7 @@
8960189628
"license_type": "enterprise",
8960289629
"github_com_member_roles": [],
8960389630
"github_com_enterprise_role": "",
89631+
"github_com_enterprise_roles": [],
8960489632
"visual_studio_subscription_user": false,
8960589633
"github_com_verified_domain_emails": [],
8960689634
"github_com_saml_name_id": "",

cache/ghes-3.2.deref.json

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170193,6 +170193,22 @@
170193170193
"default": "all"
170194170194
}
170195170195
},
170196+
{
170197+
"name": "permission",
170198+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
170199+
"in": "query",
170200+
"required": false,
170201+
"schema": {
170202+
"type": "string",
170203+
"enum": [
170204+
"pull",
170205+
"triage",
170206+
"push",
170207+
"maintain",
170208+
"admin"
170209+
]
170210+
}
170211+
},
170196170212
{
170197170213
"name": "per_page",
170198170214
"description": "The number of results per page (max 100).",
@@ -191430,7 +191446,7 @@
191430191446
},
191431191447
"put": {
191432191448
"summary": "Create or update file contents",
191433-
"description": "Creates a new file or replaces an existing file in a repository.",
191449+
"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.",
191434191450
"tags": [
191435191451
"repos"
191436191452
],
@@ -212818,7 +212834,7 @@
212818212834
"/repos/{owner}/{repo}/hooks": {
212819212835
"get": {
212820212836
"summary": "List repository webhooks",
212821-
"description": "",
212837+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
212822212838
"tags": [
212823212839
"repos"
212824212840
],

cache/ghes-3.2.json

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24968,6 +24968,22 @@
2496824968
"default": "all"
2496924969
}
2497024970
},
24971+
{
24972+
"name": "permission",
24973+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
24974+
"in": "query",
24975+
"required": false,
24976+
"schema": {
24977+
"type": "string",
24978+
"enum": [
24979+
"pull",
24980+
"triage",
24981+
"push",
24982+
"maintain",
24983+
"admin"
24984+
]
24985+
}
24986+
},
2497124987
{
2497224988
"$ref": "#/components/parameters/per-page"
2497324989
},
@@ -26800,7 +26816,7 @@
2680026816
},
2680126817
"put": {
2680226818
"summary": "Create or update file contents",
26803-
"description": "Creates a new file or replaces an existing file in a repository.",
26819+
"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.",
2680426820
"tags": [
2680526821
"repos"
2680626822
],
@@ -29811,7 +29827,7 @@
2981129827
"/repos/{owner}/{repo}/hooks": {
2981229828
"get": {
2981329829
"summary": "List repository webhooks",
29814-
"description": "",
29830+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
2981529831
"tags": [
2981629832
"repos"
2981729833
],

cache/ghes-3.3.deref.json

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172026,6 +172026,22 @@
172026172026
"default": "all"
172027172027
}
172028172028
},
172029+
{
172030+
"name": "permission",
172031+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
172032+
"in": "query",
172033+
"required": false,
172034+
"schema": {
172035+
"type": "string",
172036+
"enum": [
172037+
"pull",
172038+
"triage",
172039+
"push",
172040+
"maintain",
172041+
"admin"
172042+
]
172043+
}
172044+
},
172029172045
{
172030172046
"name": "per_page",
172031172047
"description": "The number of results per page (max 100).",
@@ -193241,7 +193257,7 @@
193241193257
},
193242193258
"put": {
193243193259
"summary": "Create or update file contents",
193244-
"description": "Creates a new file or replaces an existing file in a repository.",
193260+
"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.",
193245193261
"tags": [
193246193262
"repos"
193247193263
],
@@ -214633,7 +214649,7 @@
214633214649
"/repos/{owner}/{repo}/hooks": {
214634214650
"get": {
214635214651
"summary": "List repository webhooks",
214636-
"description": "",
214652+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
214637214653
"tags": [
214638214654
"repos"
214639214655
],

cache/ghes-3.3.json

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24893,6 +24893,22 @@
2489324893
"default": "all"
2489424894
}
2489524895
},
24896+
{
24897+
"name": "permission",
24898+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
24899+
"in": "query",
24900+
"required": false,
24901+
"schema": {
24902+
"type": "string",
24903+
"enum": [
24904+
"pull",
24905+
"triage",
24906+
"push",
24907+
"maintain",
24908+
"admin"
24909+
]
24910+
}
24911+
},
2489624912
{
2489724913
"$ref": "#/components/parameters/per-page"
2489824914
},
@@ -26669,7 +26685,7 @@
2666926685
},
2667026686
"put": {
2667126687
"summary": "Create or update file contents",
26672-
"description": "Creates a new file or replaces an existing file in a repository.",
26688+
"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.",
2667326689
"tags": [
2667426690
"repos"
2667526691
],
@@ -29618,7 +29634,7 @@
2961829634
"/repos/{owner}/{repo}/hooks": {
2961929635
"get": {
2962029636
"summary": "List repository webhooks",
29621-
"description": "",
29637+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
2962229638
"tags": [
2962329639
"repos"
2962429640
],

cache/ghes-3.4.deref.json

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185883,6 +185883,22 @@
185883185883
"default": "all"
185884185884
}
185885185885
},
185886+
{
185887+
"name": "permission",
185888+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
185889+
"in": "query",
185890+
"required": false,
185891+
"schema": {
185892+
"type": "string",
185893+
"enum": [
185894+
"pull",
185895+
"triage",
185896+
"push",
185897+
"maintain",
185898+
"admin"
185899+
]
185900+
}
185901+
},
185886185902
{
185887185903
"name": "per_page",
185888185904
"description": "The number of results per page (max 100).",
@@ -206791,7 +206807,7 @@
206791206807
},
206792206808
"put": {
206793206809
"summary": "Create or update file contents",
206794-
"description": "Creates a new file or replaces an existing file in a repository.",
206810+
"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.",
206795206811
"tags": [
206796206812
"repos"
206797206813
],
@@ -228639,7 +228655,7 @@
228639228655
"/repos/{owner}/{repo}/hooks": {
228640228656
"get": {
228641228657
"summary": "List repository webhooks",
228642-
"description": "",
228658+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
228643228659
"tags": [
228644228660
"repos"
228645228661
],

0 commit comments

Comments
 (0)