Mizah/mizzkey
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

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

Browse source
This commit is contained in:
kakkokari-gtyih 2024-11-07 13:51:52 +09:00
parent 576e0bc9db
commit a4e4799613
2 changed files with 46 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
packages/misskey-js/etc/misskey-js.api.md
View file

@ -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'];

74
packages/misskey-js/src/api.types.ts
View file

@ -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に載らないもの ▲
};