Skip to content

Commit b40d8ef

Browse files
octokitbotoctokitbot
authored
feat: add support for new request parameter and response attribute, plus in-code documentation updates (see PR body for details( (#244)
WIP
1 parent 7bad67d commit b40d8ef

File tree

21 files changed

+205
-44
lines changed

21 files changed

+205
-44
lines changed

‎cache/api.github.com.json‎

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.11.0",
4+
"version": "7.12.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -3579,7 +3579,7 @@
35793579
"/enterprises/{enterprise}/consumed-licenses": {
35803580
"get": {
35813581
"summary": "List enterprise consumed licenses",
3582-
"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.",
3582+
"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.",
35833583
"tags": [
35843584
"enterprise-admin"
35853585
],
@@ -29439,6 +29439,22 @@
2943929439
"default": "all"
2944029440
}
2944129441
},
29442+
{
29443+
"name": "permission",
29444+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
29445+
"in": "query",
29446+
"required": false,
29447+
"schema": {
29448+
"type": "string",
29449+
"enum": [
29450+
"pull",
29451+
"triage",
29452+
"push",
29453+
"maintain",
29454+
"admin"
29455+
]
29456+
}
29457+
},
2944229458
{
2944329459
"$ref": "#/components/parameters/per-page"
2944429460
},
@@ -31166,7 +31182,7 @@
3116631182
},
3116731183
"put": {
3116831184
"summary": "Create or update file contents",
31169-
"description": "Creates a new file or replaces an existing file in a repository.",
31185+
"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.",
3117031186
"tags": [
3117131187
"repos"
3117231188
],
@@ -34593,7 +34609,7 @@
3459334609
"/repos/{owner}/{repo}/hooks": {
3459434610
"get": {
3459534611
"summary": "List repository webhooks",
34596-
"description": "",
34612+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
3459734613
"tags": [
3459834614
"repos"
3459934615
],
@@ -63849,7 +63865,15 @@
6384963865
},
6385063866
"github_com_enterprise_role": {
6385163867
"type": "string",
63852-
"nullable": true
63868+
"nullable": true,
63869+
"description": "Deprecated: The most permissive enterprise role for a user."
63870+
},
63871+
"github_com_enterprise_roles": {
63872+
"type": "array",
63873+
"description": "All enterprise roles for a user.",
63874+
"items": {
63875+
"type": "string"
63876+
}
6385363877
},
6385463878
"visual_studio_subscription_user": {
6385563879
"type": "boolean"
@@ -90734,6 +90758,9 @@
9073490758
"org2:Owner"
9073590759
],
9073690760
"github_com_enterprise_role": "owner",
90761+
"github_com_enterprise_roles": [
90762+
"owner"
90763+
],
9073790764
"visual_studio_subscription_user": false,
9073890765
"github_com_verified_domain_emails": [
9073990766
"monalisa@github.com"
@@ -90762,6 +90789,7 @@
9076290789
"license_type": "enterprise",
9076390790
"github_com_member_roles": [],
9076490791
"github_com_enterprise_role": "",
90792+
"github_com_enterprise_roles": [],
9076590793
"visual_studio_subscription_user": false,
9076690794
"github_com_verified_domain_emails": [],
9076790795
"github_com_saml_name_id": "",

‎cache/ghes-3.2.json‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.11.0",
4+
"version": "7.12.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -25544,6 +25544,22 @@
2554425544
"default": "all"
2554525545
}
2554625546
},
25547+
{
25548+
"name": "permission",
25549+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
25550+
"in": "query",
25551+
"required": false,
25552+
"schema": {
25553+
"type": "string",
25554+
"enum": [
25555+
"pull",
25556+
"triage",
25557+
"push",
25558+
"maintain",
25559+
"admin"
25560+
]
25561+
}
25562+
},
2554725563
{
2554825564
"$ref": "#/components/parameters/per-page"
2554925565
},
@@ -27431,7 +27447,7 @@
2743127447
},
2743227448
"put": {
2743327449
"summary": "Create or update file contents",
27434-
"description": "Creates a new file or replaces an existing file in a repository.",
27450+
"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.",
2743527451
"tags": [
2743627452
"repos"
2743727453
],
@@ -30496,7 +30512,7 @@
3049630512
"/repos/{owner}/{repo}/hooks": {
3049730513
"get": {
3049830514
"summary": "List repository webhooks",
30499-
"description": "",
30515+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
3050030516
"tags": [
3050130517
"repos"
3050230518
],

‎cache/ghes-3.3.json‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.11.0",
4+
"version": "7.12.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -25497,6 +25497,22 @@
2549725497
"default": "all"
2549825498
}
2549925499
},
25500+
{
25501+
"name": "permission",
25502+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
25503+
"in": "query",
25504+
"required": false,
25505+
"schema": {
25506+
"type": "string",
25507+
"enum": [
25508+
"pull",
25509+
"triage",
25510+
"push",
25511+
"maintain",
25512+
"admin"
25513+
]
25514+
}
25515+
},
2550025516
{
2550125517
"$ref": "#/components/parameters/per-page"
2550225518
},
@@ -27304,7 +27320,7 @@
2730427320
},
2730527321
"put": {
2730627322
"summary": "Create or update file contents",
27307-
"description": "Creates a new file or replaces an existing file in a repository.",
27323+
"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.",
2730827324
"tags": [
2730927325
"repos"
2731027326
],
@@ -30289,7 +30305,7 @@
3028930305
"/repos/{owner}/{repo}/hooks": {
3029030306
"get": {
3029130307
"summary": "List repository webhooks",
30292-
"description": "",
30308+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
3029330309
"tags": [
3029430310
"repos"
3029530311
],

‎cache/ghes-3.4.json‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.11.0",
4+
"version": "7.12.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -27153,6 +27153,22 @@
2715327153
"default": "all"
2715427154
}
2715527155
},
27156+
{
27157+
"name": "permission",
27158+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
27159+
"in": "query",
27160+
"required": false,
27161+
"schema": {
27162+
"type": "string",
27163+
"enum": [
27164+
"pull",
27165+
"triage",
27166+
"push",
27167+
"maintain",
27168+
"admin"
27169+
]
27170+
}
27171+
},
2715627172
{
2715727173
"$ref": "#/components/parameters/per-page"
2715827174
},
@@ -28864,7 +28880,7 @@
2886428880
},
2886528881
"put": {
2886628882
"summary": "Create or update file contents",
28867-
"description": "Creates a new file or replaces an existing file in a repository.",
28883+
"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.",
2886828884
"tags": [
2886928885
"repos"
2887028886
],
@@ -32136,7 +32152,7 @@
3213632152
"/repos/{owner}/{repo}/hooks": {
3213732153
"get": {
3213832154
"summary": "List repository webhooks",
32139-
"description": "",
32155+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
3214032156
"tags": [
3214132157
"repos"
3214232158
],

‎cache/ghes-3.5.json‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.11.0",
4+
"version": "7.12.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -28379,6 +28379,22 @@
2837928379
"default": "all"
2838028380
}
2838128381
},
28382+
{
28383+
"name": "permission",
28384+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
28385+
"in": "query",
28386+
"required": false,
28387+
"schema": {
28388+
"type": "string",
28389+
"enum": [
28390+
"pull",
28391+
"triage",
28392+
"push",
28393+
"maintain",
28394+
"admin"
28395+
]
28396+
}
28397+
},
2838228398
{
2838328399
"$ref": "#/components/parameters/per-page"
2838428400
},
@@ -30084,7 +30100,7 @@
3008430100
},
3008530101
"put": {
3008630102
"summary": "Create or update file contents",
30087-
"description": "Creates a new file or replaces an existing file in a repository.",
30103+
"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.",
3008830104
"tags": [
3008930105
"repos"
3009030106
],
@@ -33368,7 +33384,7 @@
3336833384
"/repos/{owner}/{repo}/hooks": {
3336933385
"get": {
3337033386
"summary": "List repository webhooks",
33371-
"description": "",
33387+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
3337233388
"tags": [
3337333389
"repos"
3337433390
],

‎cache/ghes-3.6.json‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.11.0",
4+
"version": "7.12.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -28879,6 +28879,22 @@
2887928879
"default": "all"
2888028880
}
2888128881
},
28882+
{
28883+
"name": "permission",
28884+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
28885+
"in": "query",
28886+
"required": false,
28887+
"schema": {
28888+
"type": "string",
28889+
"enum": [
28890+
"pull",
28891+
"triage",
28892+
"push",
28893+
"maintain",
28894+
"admin"
28895+
]
28896+
}
28897+
},
2888228898
{
2888328899
"$ref": "#/components/parameters/per-page"
2888428900
},
@@ -30572,7 +30588,7 @@
3057230588
},
3057330589
"put": {
3057430590
"summary": "Create or update file contents",
30575-
"description": "Creates a new file or replaces an existing file in a repository.",
30591+
"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.",
3057630592
"tags": [
3057730593
"repos"
3057830594
],
@@ -33912,7 +33928,7 @@
3391233928
"/repos/{owner}/{repo}/hooks": {
3391333929
"get": {
3391433930
"summary": "List repository webhooks",
33915-
"description": "",
33931+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
3391633932
"tags": [
3391733933
"repos"
3391833934
],

‎cache/github.ae.json‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.11.0",
4+
"version": "7.12.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -23425,6 +23425,22 @@
2342523425
"default": "all"
2342623426
}
2342723427
},
23428+
{
23429+
"name": "permission",
23430+
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
23431+
"in": "query",
23432+
"required": false,
23433+
"schema": {
23434+
"type": "string",
23435+
"enum": [
23436+
"pull",
23437+
"triage",
23438+
"push",
23439+
"maintain",
23440+
"admin"
23441+
]
23442+
}
23443+
},
2342823444
{
2342923445
"$ref": "#/components/parameters/per-page"
2343023446
},
@@ -25169,7 +25185,7 @@
2516925185
},
2517025186
"put": {
2517125187
"summary": "Create or update file contents",
25172-
"description": "Creates a new file or replaces an existing file in a repository.",
25188+
"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.",
2517325189
"tags": [
2517425190
"repos"
2517525191
],
@@ -28172,7 +28188,7 @@
2817228188
"/repos/{owner}/{repo}/hooks": {
2817328189
"get": {
2817428190
"summary": "List repository webhooks",
28175-
"description": "",
28191+
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
2817628192
"tags": [
2817728193
"repos"
2817828194
],

0 commit comments

Comments
 (0)