Skip to content

Commit 42321eb

Browse files
feat: new /orgs/{org}/campaigns and /orgs/{org}/campaigns/{campaign_number} enpoints, remove Copilot usage endpoints (#672)
BREAKING CHANGE: remove Copilot usage endpoints
1 parent 302087f commit 42321eb

File tree

4 files changed

+206
-49
lines changed

4 files changed

+206
-49
lines changed

package-lock.json

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
},
88
"description": "Shared TypeScript definitions for Octokit projects",
99
"dependencies": {
10-
"@octokit/openapi-types": "^24.2.0"
10+
"@octokit/openapi-types": "^25.0.0"
1111
},
1212
"scripts": {
1313
"build": "node scripts/build.mjs && tsc -p tsconfig.json",
@@ -76,6 +76,6 @@
7676
]
7777
},
7878
"octokit": {
79-
"openapi-version": "18.2.0"
79+
"openapi-version": "19.0.0"
8080
}
8181
}

scripts/update-endpoints/generated/endpoints.json

+171-29
Original file line numberDiff line numberDiff line change
@@ -3997,6 +3997,141 @@
39973997
],
39983998
"renamed": null
39993999
},
4000+
{
4001+
"method": "POST",
4002+
"url": "/orgs/{org}/campaigns",
4003+
"documentationUrl": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization",
4004+
"parameters": [
4005+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
4006+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "name" },
4007+
{
4008+
"alias": null,
4009+
"deprecated": null,
4010+
"in": "BODY",
4011+
"name": "description"
4012+
},
4013+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "managers" },
4014+
{
4015+
"alias": null,
4016+
"deprecated": null,
4017+
"in": "BODY",
4018+
"name": "team_managers"
4019+
},
4020+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "ends_at" },
4021+
{
4022+
"alias": null,
4023+
"deprecated": null,
4024+
"in": "BODY",
4025+
"name": "contact_link"
4026+
},
4027+
{
4028+
"alias": null,
4029+
"deprecated": null,
4030+
"in": "BODY",
4031+
"name": "code_scanning_alerts"
4032+
},
4033+
{
4034+
"alias": null,
4035+
"deprecated": null,
4036+
"in": "BODY",
4037+
"name": "code_scanning_alerts[].repository_id"
4038+
},
4039+
{
4040+
"alias": null,
4041+
"deprecated": null,
4042+
"in": "BODY",
4043+
"name": "code_scanning_alerts[].alert_numbers"
4044+
},
4045+
{
4046+
"alias": null,
4047+
"deprecated": null,
4048+
"in": "BODY",
4049+
"name": "generate_issues"
4050+
}
4051+
],
4052+
"renamed": null
4053+
},
4054+
{
4055+
"method": "DELETE",
4056+
"url": "/orgs/{org}/campaigns/{campaign_number}",
4057+
"documentationUrl": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization",
4058+
"parameters": [
4059+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
4060+
{
4061+
"alias": null,
4062+
"deprecated": null,
4063+
"in": "PATH",
4064+
"name": "campaign_number"
4065+
}
4066+
],
4067+
"renamed": null
4068+
},
4069+
{
4070+
"method": "GET",
4071+
"url": "/orgs/{org}/campaigns/{campaign_number}",
4072+
"documentationUrl": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization",
4073+
"parameters": [
4074+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
4075+
{
4076+
"alias": null,
4077+
"deprecated": null,
4078+
"in": "PATH",
4079+
"name": "campaign_number"
4080+
}
4081+
],
4082+
"renamed": null
4083+
},
4084+
{
4085+
"method": "GET",
4086+
"url": "/orgs/{org}/campaigns",
4087+
"documentationUrl": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization",
4088+
"parameters": [
4089+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
4090+
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "page" },
4091+
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "per_page" },
4092+
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "direction" },
4093+
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "state" },
4094+
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "sort" }
4095+
],
4096+
"renamed": null
4097+
},
4098+
{
4099+
"method": "PATCH",
4100+
"url": "/orgs/{org}/campaigns/{campaign_number}",
4101+
"documentationUrl": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign",
4102+
"parameters": [
4103+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
4104+
{
4105+
"alias": null,
4106+
"deprecated": null,
4107+
"in": "PATH",
4108+
"name": "campaign_number"
4109+
},
4110+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "name" },
4111+
{
4112+
"alias": null,
4113+
"deprecated": null,
4114+
"in": "BODY",
4115+
"name": "description"
4116+
},
4117+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "managers" },
4118+
{
4119+
"alias": null,
4120+
"deprecated": null,
4121+
"in": "BODY",
4122+
"name": "team_managers"
4123+
},
4124+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "ends_at" },
4125+
{
4126+
"alias": null,
4127+
"deprecated": null,
4128+
"in": "BODY",
4129+
"name": "contact_link"
4130+
},
4131+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "state" }
4132+
],
4133+
"renamed": null
4134+
},
40004135
{
40014136
"method": "POST",
40024137
"url": "/repos/{owner}/{repo}/check-runs",
@@ -6803,33 +6938,6 @@
68036938
],
68046939
"renamed": null
68056940
},
6806-
{
6807-
"method": "GET",
6808-
"url": "/orgs/{org}/copilot/usage",
6809-
"documentationUrl": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members",
6810-
"parameters": [
6811-
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
6812-
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "since" },
6813-
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "until" },
6814-
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "page" },
6815-
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "per_page" }
6816-
],
6817-
"renamed": null
6818-
},
6819-
{
6820-
"method": "GET",
6821-
"url": "/orgs/{org}/team/{team_slug}/copilot/usage",
6822-
"documentationUrl": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team",
6823-
"parameters": [
6824-
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
6825-
{ "alias": null, "deprecated": null, "in": "PATH", "name": "team_slug" },
6826-
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "since" },
6827-
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "until" },
6828-
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "page" },
6829-
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "per_page" }
6830-
],
6831-
"renamed": null
6832-
},
68336941
{
68346942
"method": "PUT",
68356943
"url": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}",
@@ -9446,7 +9554,6 @@
94469554
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
94479555
{ "alias": null, "deprecated": null, "in": "BODY", "name": "name" },
94489556
{ "alias": null, "deprecated": null, "in": "BODY", "name": "is_enabled" },
9449-
{ "alias": null, "deprecated": null, "in": "BODY", "name": "is_private" },
94509557
{
94519558
"alias": null,
94529559
"deprecated": null,
@@ -10549,7 +10656,6 @@
1054910656
},
1055010657
{ "alias": null, "deprecated": null, "in": "BODY", "name": "name" },
1055110658
{ "alias": null, "deprecated": null, "in": "BODY", "name": "is_enabled" },
10552-
{ "alias": null, "deprecated": null, "in": "BODY", "name": "is_private" },
1055310659
{
1055410660
"alias": null,
1055510661
"deprecated": null,
@@ -13594,6 +13700,12 @@
1359413700
"in": "BODY",
1359513701
"name": "rules[].parameters.allowed_merge_methods"
1359613702
},
13703+
{
13704+
"alias": null,
13705+
"deprecated": null,
13706+
"in": "BODY",
13707+
"name": "rules[].parameters.automatic_copilot_code_review_enabled"
13708+
},
1359713709
{
1359813710
"alias": null,
1359913711
"deprecated": null,
@@ -13978,6 +14090,12 @@
1397814090
"in": "BODY",
1397914091
"name": "rules[].parameters.allowed_merge_methods"
1398014092
},
14093+
{
14094+
"alias": null,
14095+
"deprecated": null,
14096+
"in": "BODY",
14097+
"name": "rules[].parameters.automatic_copilot_code_review_enabled"
14098+
},
1398114099
{
1398214100
"alias": null,
1398314101
"deprecated": null,
@@ -16260,6 +16378,18 @@
1626016378
"in": "BODY",
1626116379
"name": "security_and_analysis.advanced_security.status"
1626216380
},
16381+
{
16382+
"alias": null,
16383+
"deprecated": null,
16384+
"in": "BODY",
16385+
"name": "security_and_analysis.code_security"
16386+
},
16387+
{
16388+
"alias": null,
16389+
"deprecated": null,
16390+
"in": "BODY",
16391+
"name": "security_and_analysis.code_security.status"
16392+
},
1626316393
{
1626416394
"alias": null,
1626516395
"deprecated": null,
@@ -16791,6 +16921,12 @@
1679116921
"in": "BODY",
1679216922
"name": "rules[].parameters.allowed_merge_methods"
1679316923
},
16924+
{
16925+
"alias": null,
16926+
"deprecated": null,
16927+
"in": "BODY",
16928+
"name": "rules[].parameters.automatic_copilot_code_review_enabled"
16929+
},
1679416930
{
1679516931
"alias": null,
1679616932
"deprecated": null,
@@ -17219,6 +17355,12 @@
1721917355
"in": "BODY",
1722017356
"name": "rules[].parameters.allowed_merge_methods"
1722117357
},
17358+
{
17359+
"alias": null,
17360+
"deprecated": null,
17361+
"in": "BODY",
17362+
"name": "rules[].parameters.automatic_copilot_code_review_enabled"
17363+
},
1722217364
{
1722317365
"alias": null,
1722417366
"deprecated": null,

src/generated/Endpoints.ts

+29-14
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,13 @@ export interface Endpoints {
268268
"/orgs/{org}/blocks/{username}",
269269
"delete"
270270
>;
271+
/**
272+
* @see https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization
273+
*/
274+
"DELETE /orgs/{org}/campaigns/{campaign_number}": Operation<
275+
"/orgs/{org}/campaigns/{campaign_number}",
276+
"delete"
277+
>;
271278
/**
272279
* @see https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories
273280
*/
@@ -1758,6 +1765,17 @@ export interface Endpoints {
17581765
"/orgs/{org}/blocks/{username}",
17591766
"get"
17601767
>;
1768+
/**
1769+
* @see https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization
1770+
*/
1771+
"GET /orgs/{org}/campaigns": Operation<"/orgs/{org}/campaigns", "get">;
1772+
/**
1773+
* @see https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization
1774+
*/
1775+
"GET /orgs/{org}/campaigns/{campaign_number}": Operation<
1776+
"/orgs/{org}/campaigns/{campaign_number}",
1777+
"get"
1778+
>;
17611779
/**
17621780
* @see https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
17631781
*/
@@ -1846,13 +1864,6 @@ export interface Endpoints {
18461864
"/orgs/{org}/copilot/metrics",
18471865
"get"
18481866
>;
1849-
/**
1850-
* @see https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members
1851-
*/
1852-
"GET /orgs/{org}/copilot/usage": Operation<
1853-
"/orgs/{org}/copilot/usage",
1854-
"get"
1855-
>;
18561867
/**
18571868
* @see https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization
18581869
*/
@@ -2363,13 +2374,6 @@ export interface Endpoints {
23632374
"/orgs/{org}/team/{team_slug}/copilot/metrics",
23642375
"get"
23652376
>;
2366-
/**
2367-
* @see https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team
2368-
*/
2369-
"GET /orgs/{org}/team/{team_slug}/copilot/usage": Operation<
2370-
"/orgs/{org}/team/{team_slug}/copilot/usage",
2371-
"get"
2372-
>;
23732377
/**
23742378
* @see https://docs.github.com/rest/teams/teams#list-teams
23752379
*/
@@ -4817,6 +4821,13 @@ export interface Endpoints {
48174821
"/orgs/{org}/actions/variables/{name}",
48184822
"patch"
48194823
>;
4824+
/**
4825+
* @see https://docs.github.com/rest/campaigns/campaigns#update-a-campaign
4826+
*/
4827+
"PATCH /orgs/{org}/campaigns/{campaign_number}": Operation<
4828+
"/orgs/{org}/campaigns/{campaign_number}",
4829+
"patch"
4830+
>;
48204831
/**
48214832
* @see https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration
48224833
*/
@@ -5280,6 +5291,10 @@ export interface Endpoints {
52805291
"/orgs/{org}/actions/variables",
52815292
"post"
52825293
>;
5294+
/**
5295+
* @see https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization
5296+
*/
5297+
"POST /orgs/{org}/campaigns": Operation<"/orgs/{org}/campaigns", "post">;
52835298
/**
52845299
* @see https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration
52855300
*/

0 commit comments

Comments
 (0)