Improve API doc
This commit is contained in:
		| @@ -3,6 +3,7 @@ import { ID } from '../../../../misc/cafy-id'; | ||||
| import define from '../../define'; | ||||
| import { NoteFavorites } from '../../../../models'; | ||||
| import { makePaginationQuery } from '../../common/make-pagination-query'; | ||||
| import { types, bool } from '../../../../misc/schema'; | ||||
|  | ||||
| export const meta = { | ||||
| 	desc: { | ||||
| @@ -29,7 +30,17 @@ export const meta = { | ||||
| 		untilId: { | ||||
| 			validator: $.optional.type(ID), | ||||
| 		}, | ||||
| 	} | ||||
| 	}, | ||||
|  | ||||
| 	res: { | ||||
| 		type: types.array, | ||||
| 		optional: bool.false, nullable: bool.false, | ||||
| 		items: { | ||||
| 			type: types.object, | ||||
| 			optional: bool.false, nullable: bool.false, | ||||
| 			ref: 'NoteFavorite', | ||||
| 		} | ||||
| 	}, | ||||
| }; | ||||
|  | ||||
| export default define(meta, async (ps, user) => { | ||||
|   | ||||
| @@ -14,6 +14,7 @@ import { packedNoteReactionSchema } from '../../../models/repositories/note-reac | ||||
| import { packedHashtagSchema } from '../../../models/repositories/hashtag'; | ||||
| import { packedPageSchema } from '../../../models/repositories/page'; | ||||
| import { packedUserGroupSchema } from '../../../models/repositories/user-group'; | ||||
| import { packedNoteFavoriteSchema } from '../../../models/repositories/note-favorite'; | ||||
|  | ||||
| export function convertSchemaToOpenApiSchema(schema: Schema) { | ||||
| 	const res: any = schema; | ||||
| @@ -71,13 +72,14 @@ export const schemas = { | ||||
| 	App: convertSchemaToOpenApiSchema(packedAppSchema), | ||||
| 	MessagingMessage: convertSchemaToOpenApiSchema(packedMessagingMessageSchema), | ||||
| 	Note: convertSchemaToOpenApiSchema(packedNoteSchema), | ||||
| 	NoteReaction: convertSchemaToOpenApiSchema(packedNoteReactionSchema), | ||||
| 	NoteFavorite: convertSchemaToOpenApiSchema(packedNoteFavoriteSchema), | ||||
| 	Notification: convertSchemaToOpenApiSchema(packedNotificationSchema), | ||||
| 	DriveFile: convertSchemaToOpenApiSchema(packedDriveFileSchema), | ||||
| 	DriveFolder: convertSchemaToOpenApiSchema(packedDriveFolderSchema), | ||||
| 	Following: convertSchemaToOpenApiSchema(packedFollowingSchema), | ||||
| 	Muting: convertSchemaToOpenApiSchema(packedMutingSchema), | ||||
| 	Blocking: convertSchemaToOpenApiSchema(packedBlockingSchema), | ||||
| 	NoteReaction: convertSchemaToOpenApiSchema(packedNoteReactionSchema), | ||||
| 	Hashtag: convertSchemaToOpenApiSchema(packedHashtagSchema), | ||||
| 	Page: convertSchemaToOpenApiSchema(packedPageSchema), | ||||
| }; | ||||
|   | ||||
		Reference in New Issue
	
	Block a user
	 syuilo
					syuilo