oscar-surf/misskey
oscar-surf/misskey
0
0
Fork 0
Code Issues Pull Requests Packages Releases 2 Activity

autogen: api docs & type hints

Browse Source
This commit is contained in:
オスカー、 2024-09-06 17:09:34 +09:00
parent bfeb2ef2a9
commit 2a7bacc47e
Signed by: SWREI
GPG Key ID: 139D6573F92DA9F7
3 changed files with 68 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
packages/misskey-js/src/autogen/apiClientJSDoc.ts
View File

@ -710,6 +710,18 @@ declare module '../api.js' {
credential?: string | null,
): Promise<SwitchCaseResponseType<E, P>>;
/**
* No description provided.
*
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
* **Credential required**: *Yes* / **Permission**: *write:admin:search*
*/
request<E extends 'admin/reindex-search', P extends Endpoints[E]['req']>(
endpoint: E,
params: P,
credential?: string | null,
): Promise<SwitchCaseResponseType<E, P>>;
/**
* No description provided.
*

1
packages/misskey-js/src/autogen/endpoint.ts
View File

@ -648,6 +648,7 @@ export type Endpoints = {
'admin/queue/inbox-delayed': { req: EmptyRequest; res: AdminQueueInboxDelayedResponse };
'admin/queue/promote': { req: AdminQueuePromoteRequest; res: EmptyResponse };
'admin/queue/stats': { req: EmptyRequest; res: AdminQueueStatsResponse };
'admin/reindex-search': { req: EmptyRequest; res: EmptyResponse };
'admin/relays/add': { req: AdminRelaysAddRequest; res: AdminRelaysAddResponse };
'admin/relays/list': { req: EmptyRequest; res: AdminRelaysListResponse };
'admin/relays/remove': { req: AdminRelaysRemoveRequest; res: EmptyResponse };

55
packages/misskey-js/src/autogen/types.ts
View File

@ -591,6 +591,16 @@ export type paths = {
*/
post: operations['admin___queue___stats'];
};
'/admin/reindex-search': {
/**
* admin/reindex-search
* @description No description provided.
*
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
* **Credential required**: *Yes* / **Permission**: *write:admin:search*
*/
post: operations['admin___reindex-search'];
};
'/admin/relays/add': {
/**
* admin/relays/add
@ -9028,6 +9038,51 @@ export type operations = {
};
};
};
/**
* admin/reindex-search
* @description No description provided.
*
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
* **Credential required**: *Yes* / **Permission**: *write:admin:search*
*/
'admin___reindex-search': {
responses: {
/** @description OK (without any results) */
204: {
content: never;
};
/** @description Client error */
400: {
content: {
'application/json': components['schemas']['Error'];
};
};
/** @description Authentication error */
401: {
content: {
'application/json': components['schemas']['Error'];
};
};
/** @description Forbidden error */
403: {
content: {
'application/json': components['schemas']['Error'];
};
};
/** @description I'm Ai */
418: {
content: {
'application/json': components['schemas']['Error'];
};
};
/** @description Internal server error */
500: {
content: {
'application/json': components['schemas']['Error'];
};
};
};
};
/**
* admin/relays/add
* @description No description provided.