Improve doc

This commit is contained in:
syuilo 2019-02-25 03:43:19 +09:00
parent 495aad6a2d
commit eb8d1211ba
No known key found for this signature in database
GPG Key ID: BDC4C49D06AB9D69
4 changed files with 52 additions and 1 deletions

View File

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

View File

@ -50,6 +50,13 @@ export const meta = {
}
},
res: {
type: 'array',
items: {
type: 'MessagingMessage',
},
},
errors: {
noSuchUser: {
message: 'No such user.',

View File

@ -45,6 +45,10 @@ export const meta = {
}
},
res: {
type: 'MessagingMessage',
},
errors: {
recipientIsYourself: {
message: 'You can not send a message to yourself.',

View File

@ -119,6 +119,39 @@ export const schemas = {
required: ['id', 'createdAt', 'title']
},
MessagingMessage: {
type: 'object',
properties: {
id: {
type: 'string',
format: 'id',
description: 'The unique identifier for this MessagingMessage.',
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
},
createdAt: {
type: 'string',
format: 'date-time',
description: 'The date that the MessagingMessage was created.'
},
text: {
type: 'string',
nullable: true
},
file: {
type: 'DriveFile',
nullable: true
},
recipientId: {
type: 'string',
format: 'id',
},
recipient: {
$ref: '#/components/schemas/User'
},
},
required: ['id', 'createdAt']
},
Note: {
type: 'object',
properties: {