api.jsonに出力されないエンドポイントはoverwriteを介さないように

misskey-dev · Nov 7, 2024 · a4e4799 · a4e4799
1 parent 576e0bc
commit a4e4799
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 43 deletions.
diff --git a/packages/misskey-js/etc/misskey-js.api.md b/packages/misskey-js/etc/misskey-js.api.md
@@ -1160,6 +1160,13 @@ export type Endpoints = Overwrite<Endpoints_2, {
             };
         };
     };
+    'admin/roles/create': {
+        req: Overwrite<AdminRolesCreateRequest, {
+            policies: PartialRolePolicyOverride;
+        }>;
+        res: AdminRolesCreateResponse;
+    };
+}> & {
     'signup': {
         req: SignupRequest;
         res: SignupResponse;
@@ -1188,17 +1195,11 @@ export type Endpoints = Overwrite<Endpoints_2, {
             };
         };
     };
-    'admin/roles/create': {
-        req: Overwrite<AdminRolesCreateRequest, {
-            policies: PartialRolePolicyOverride;
-        }>;
-        res: AdminRolesCreateResponse;
-    };
     [ep: `miauth/${string}/check`]: {
         req: EmptyRequest;
         res: MiAuthCheckResponse;
     };
-}>;
+};
 
 // @public (undocumented)
 type EndpointsResponse = operations['endpoints']['responses']['200']['content']['application/json'];

diff --git a/packages/misskey-js/src/api.types.ts b/packages/misskey-js/src/api.types.ts
@@ -58,6 +58,7 @@ export type SwitchCaseResponseType<E extends keyof Endpoints, P extends Endpoint
 export type Endpoints = Overwrite<
 	Gen,
 	{
+		// ▼ api.jsonのオーバーライド ▼
 		'users/show': {
 			req: UsersShowRequest;
 			res: {
@@ -71,44 +72,45 @@ export type Endpoints = Overwrite<
 				};
 			};
 		},
-		// api.jsonには載せないものなのでここで定義
-		'signup': {
-			req: SignupRequest;
-			res: SignupResponse;
-		},
-		// api.jsonには載せないものなのでここで定義
-		'signup-pending': {
-			req: SignupPendingRequest;
-			res: SignupPendingResponse;
-		},
-		// api.jsonには載せないものなのでここで定義
-		'signin-flow': {
-			req: SigninFlowRequest;
-			res: SigninFlowResponse;
-		},
-		'signin-with-passkey': {
-			req: SigninWithPasskeyRequest;
-			res: {
-				$switch: {
-					$cases: [
-						[
-							{
-								context: string;
-							},
-							SigninWithPasskeyResponse,
-						],
-					];
-					$default: SigninWithPasskeyInitResponse;
-				},
-			},
-		},
 		'admin/roles/create': {
 			req: Overwrite<AdminRolesCreateRequest, { policies: PartialRolePolicyOverride }>;
 			res: AdminRolesCreateResponse;
 		},
-		[ep: `miauth/${string}/check`]: {
-			req: EmptyRequest;
-			res: MiAuthCheckResponse;
-		}
+		// ▲ api.jsonのオーバーライド ▲
 	}
->
+> & {
+	// ▼ api.jsonに載らないもの ▼
+	'signup': {
+		req: SignupRequest;
+		res: SignupResponse;
+	},
+	'signup-pending': {
+		req: SignupPendingRequest;
+		res: SignupPendingResponse;
+	},
+	'signin-flow': {
+		req: SigninFlowRequest;
+		res: SigninFlowResponse;
+	},
+	'signin-with-passkey': {
+		req: SigninWithPasskeyRequest;
+		res: {
+			$switch: {
+				$cases: [
+					[
+						{
+							context: string;
+						},
+						SigninWithPasskeyResponse,
+					],
+				];
+				$default: SigninWithPasskeyInitResponse;
+			},
+		},
+	},
+	[ep: `miauth/${string}/check`]: {
+		req: EmptyRequest;
+		res: MiAuthCheckResponse;
+	},
+	// ▲ api.jsonに載らないもの ▲
+};