feat: new endpoints for rulesets, update template to use type imports (…

…#533)
octokit · Jun 10, 2023 · ac4adf5 · ac4adf5
1 parent 52d9052
commit ac4adf5
Show file tree

Hide file tree

Showing 5 changed files with 171 additions and 55 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -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",

diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json
diff --git a/scripts/update-endpoints/typescript.js b/scripts/update-endpoints/typescript.js
@@ -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")}

diff --git a/src/generated/paginating-endpoints.ts b/src/generated/paginating-endpoints.ts
@@ -1,4 +1,4 @@
-import { Endpoints } from "@octokit/types";
+import type { Endpoints } from "@octokit/types";
 
 export interface PaginatingEndpoints {
   /**
@@ -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
    */
@@ -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
    */
@@ -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",
@@ -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",