diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2019-05-20 22:01:32 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2019-05-20 22:01:32 +0900 |
| commit | a78b048720800973925b89455237de5c51bd780c (patch) | |
| tree | a13c6f9bd0118a6f52ed1490c68dcb2471fe1bc2 /src/server/api/endpoints | |
| parent | Fix bugs (diff) | |
| download | sharkey-a78b048720800973925b89455237de5c51bd780c.tar.gz sharkey-a78b048720800973925b89455237de5c51bd780c.tar.bz2 sharkey-a78b048720800973925b89455237de5c51bd780c.zip | |
Improve API doc
Diffstat (limited to 'src/server/api/endpoints')
| -rw-r--r-- | src/server/api/endpoints/i/favorites.ts | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/src/server/api/endpoints/i/favorites.ts b/src/server/api/endpoints/i/favorites.ts index aad706545a..d1e90dd15c 100644 --- a/src/server/api/endpoints/i/favorites.ts +++ b/src/server/api/endpoints/i/favorites.ts @@ -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) => { |