Improve API doc

This commit is contained in:
syuilo
2019-05-20 22:01:32 +09:00
parent e7dd5e155d
commit a78b048720
3 changed files with 46 additions and 2 deletions

View File

@ -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) => {