diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2019-02-24 19:42:26 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2019-02-24 19:42:26 +0900 |
| commit | b67f3438e95af5c9a1143fa9214ae697a1372223 (patch) | |
| tree | 173ec9ae6e63c078aab618423c30d93ebb9eaba5 /src/server/api/endpoints/users | |
| parent | Improve doc (diff) | |
| download | sharkey-b67f3438e95af5c9a1143fa9214ae697a1372223.tar.gz sharkey-b67f3438e95af5c9a1143fa9214ae697a1372223.tar.bz2 sharkey-b67f3438e95af5c9a1143fa9214ae697a1372223.zip | |
Improve doc
Diffstat (limited to 'src/server/api/endpoints/users')
| -rw-r--r-- | src/server/api/endpoints/users/followers.ts | 17 | ||||
| -rw-r--r-- | src/server/api/endpoints/users/following.ts | 17 | ||||
| -rw-r--r-- | src/server/api/endpoints/users/get-frequently-replied-users.ts | 7 | ||||
| -rw-r--r-- | src/server/api/endpoints/users/recommendation.ts | 9 | ||||
| -rw-r--r-- | src/server/api/endpoints/users/search.ts | 7 |
5 files changed, 56 insertions, 1 deletions
diff --git a/src/server/api/endpoints/users/followers.ts b/src/server/api/endpoints/users/followers.ts index 32c75fc8d4..3c8290a8b1 100644 --- a/src/server/api/endpoints/users/followers.ts +++ b/src/server/api/endpoints/users/followers.ts @@ -52,6 +52,23 @@ export const meta = { } }, + res: { + type: 'object', + properties: { + users: { + type: 'array', + items: { + type: 'User', + } + }, + next: { + type: 'string', + format: 'id', + nullable: true + } + } + }, + errors: { noSuchUser: { message: 'No such user.', diff --git a/src/server/api/endpoints/users/following.ts b/src/server/api/endpoints/users/following.ts index 3ce103621b..4bc740cad9 100644 --- a/src/server/api/endpoints/users/following.ts +++ b/src/server/api/endpoints/users/following.ts @@ -52,6 +52,23 @@ export const meta = { } }, + res: { + type: 'object', + properties: { + users: { + type: 'array', + items: { + type: 'User', + } + }, + next: { + type: 'string', + format: 'id', + nullable: true + } + } + }, + errors: { noSuchUser: { message: 'No such user.', diff --git a/src/server/api/endpoints/users/get-frequently-replied-users.ts b/src/server/api/endpoints/users/get-frequently-replied-users.ts index 6f9c746acd..46c7fba2f6 100644 --- a/src/server/api/endpoints/users/get-frequently-replied-users.ts +++ b/src/server/api/endpoints/users/get-frequently-replied-users.ts @@ -29,6 +29,13 @@ export const meta = { }, }, + res: { + type: 'array', + items: { + type: 'User', + } + }, + errors: { noSuchUser: { message: 'No such user.', diff --git a/src/server/api/endpoints/users/recommendation.ts b/src/server/api/endpoints/users/recommendation.ts index 2261ee7df4..60710fffca 100644 --- a/src/server/api/endpoints/users/recommendation.ts +++ b/src/server/api/endpoints/users/recommendation.ts @@ -31,7 +31,14 @@ export const meta = { validator: $.optional.num.min(0), default: 0 } - } + }, + + res: { + type: 'array', + items: { + type: 'User', + } + }, }; export default define(meta, async (ps, me) => { diff --git a/src/server/api/endpoints/users/search.ts b/src/server/api/endpoints/users/search.ts index a6b50b687f..b8519eeba3 100644 --- a/src/server/api/endpoints/users/search.ts +++ b/src/server/api/endpoints/users/search.ts @@ -52,6 +52,13 @@ export const meta = { } }, }, + + res: { + type: 'array', + items: { + type: 'User', + } + }, }; export default define(meta, async (ps, me) => { |