Skip to content

feat: new endpoints for rulesets #533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 10, 2023
Merged

feat: new endpoints for rulesets #533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5937202
WIP octokit/openapi updated
octokitbot Jun 9, 2023
4dfe635
WIP octokit/openapi updated
octokitbot Jun 9, 2023
af66842
build: use type imports
wolfy1339 Jun 9, 2023
4741917
build(deps): update `@octokit/plugin-rest-endpoint-methods`
wolfy1339 Jun 9, 2023
8b7cdfa
WIP octokit/openapi updated
octokitbot Jun 10, 2023
1326f5c
build: update `@octokit/plugin-rest-endpoint-methods`
wolfy1339 Jun 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 24 additions & 26 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@
"license": "MIT",
"dependencies": {
"@octokit/tsconfig": "^1.0.2",
"@octokit/types": "^9.2.3"
"@octokit/types": "^9.3.1"
},
"peerDependencies": {
"@octokit/core": ">=4"
},
"devDependencies": {
"@octokit/core": "^4.0.0",
"@octokit/plugin-rest-endpoint-methods": "^7.1.0",
"@octokit/plugin-rest-endpoint-methods": "^7.2.1",
"@types/fetch-mock": "^7.3.1",
"@types/jest": "^29.0.0",
"@types/node": "^18.0.0",
Expand Down
141 changes: 116 additions & 25 deletions scripts/update-endpoints/generated/endpoints.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion scripts/update-endpoints/typescript.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ function endpointToKey(endpoint) {
writeFileSync(
"./src/generated/paginating-endpoints.ts",
prettier.format(
`import { Endpoints } from "@octokit/types";
`import type { Endpoints } from "@octokit/types";

export interface PaginatingEndpoints {
${sortEndpoints(endpoints).map(endpointToTypes).join("\n\n")}
Expand Down
29 changes: 28 additions & 1 deletion src/generated/paginating-endpoints.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Endpoints } from "@octokit/types";
import type { Endpoints } from "@octokit/types";

export interface PaginatingEndpoints {
/**
Expand Down Expand Up @@ -513,6 +513,14 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /orgs/{org}/repos"]["response"];
};

/**
* @see https://docs.github.com/rest/repos/rules#get-organization-rulesets
*/
"GET /orgs/{org}/rulesets": {
parameters: Endpoints["GET /orgs/{org}/rulesets"]["parameters"];
response: Endpoints["GET /orgs/{org}/rulesets"]["response"];
};

/**
* @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization
*/
Expand Down Expand Up @@ -1277,6 +1285,22 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/reactions"]["response"];
};

/**
* @see https://docs.github.com/rest/repos/rules#get-rules-for-a-branch
*/
"GET /repos/{owner}/{repo}/rules/branches/{branch}": {
parameters: Endpoints["GET /repos/{owner}/{repo}/rules/branches/{branch}"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/rules/branches/{branch}"]["response"];
};

/**
* @see https://docs.github.com/rest/repos/rules#get-repository-rulesets
*/
"GET /repos/{owner}/{repo}/rulesets": {
parameters: Endpoints["GET /repos/{owner}/{repo}/rulesets"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/rulesets"]["response"];
};

/**
* @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository
*/
Expand Down Expand Up @@ -1951,6 +1975,7 @@ export const paginatingEndpoints: (keyof PaginatingEndpoints)[] = [
"GET /orgs/{org}/projects",
"GET /orgs/{org}/public_members",
"GET /orgs/{org}/repos",
"GET /orgs/{org}/rulesets",
"GET /orgs/{org}/secret-scanning/alerts",
"GET /orgs/{org}/teams",
"GET /orgs/{org}/teams/{team_slug}/discussions",
Expand Down Expand Up @@ -2040,6 +2065,8 @@ export const paginatingEndpoints: (keyof PaginatingEndpoints)[] = [
"GET /repos/{owner}/{repo}/releases",
"GET /repos/{owner}/{repo}/releases/{release_id}/assets",
"GET /repos/{owner}/{repo}/releases/{release_id}/reactions",
"GET /repos/{owner}/{repo}/rules/branches/{branch}",
"GET /repos/{owner}/{repo}/rulesets",
"GET /repos/{owner}/{repo}/secret-scanning/alerts",
"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations",
"GET /repos/{owner}/{repo}/security-advisories",
Expand Down