From eb8d1211ba51d1c9b17b2c47642123aa108ad213 Mon Sep 17 00:00:00 2001 From: syuilo Date: Mon, 25 Feb 2019 03:43:19 +0900 Subject: Improve doc --- src/server/api/endpoints/messaging/history.ts | 9 ++++++++- src/server/api/endpoints/messaging/messages.ts | 7 +++++++ src/server/api/endpoints/messaging/messages/create.ts | 4 ++++ 3 files changed, 19 insertions(+), 1 deletion(-) (limited to 'src/server/api/endpoints') diff --git a/src/server/api/endpoints/messaging/history.ts b/src/server/api/endpoints/messaging/history.ts index 0425ef0213..699dc7c253 100644 --- a/src/server/api/endpoints/messaging/history.ts +++ b/src/server/api/endpoints/messaging/history.ts @@ -20,7 +20,14 @@ export const meta = { validator: $.optional.num.range(1, 100), default: 10 } - } + }, + + res: { + type: 'array', + items: { + type: 'MessagingMessage', + }, + }, }; export default define(meta, async (ps, user) => { diff --git a/src/server/api/endpoints/messaging/messages.ts b/src/server/api/endpoints/messaging/messages.ts index f1408f87fe..c19db45f1f 100644 --- a/src/server/api/endpoints/messaging/messages.ts +++ b/src/server/api/endpoints/messaging/messages.ts @@ -50,6 +50,13 @@ export const meta = { } }, + res: { + type: 'array', + items: { + type: 'MessagingMessage', + }, + }, + errors: { noSuchUser: { message: 'No such user.', diff --git a/src/server/api/endpoints/messaging/messages/create.ts b/src/server/api/endpoints/messaging/messages/create.ts index cf32b4461d..fc048e6edd 100644 --- a/src/server/api/endpoints/messaging/messages/create.ts +++ b/src/server/api/endpoints/messaging/messages/create.ts @@ -45,6 +45,10 @@ export const meta = { } }, + res: { + type: 'MessagingMessage', + }, + errors: { recipientIsYourself: { message: 'You can not send a message to yourself.', -- cgit v1.2.3-freya