Improve doc

This commit is contained in:
syuilo 2019-02-27 05:08:42 +09:00
parent 9f439aabba
commit 6f71ba376d
No known key found for this signature in database
GPG Key ID: BDC4C49D06AB9D69
2 changed files with 45 additions and 0 deletions

View File

@ -46,6 +46,13 @@ export const meta = {
}, },
}, },
res: {
type: 'array',
items: {
type: 'Reaction'
}
},
errors: { errors: {
noSuchNote: { noSuchNote: {
message: 'No such note.', message: 'No such note.',

View File

@ -362,6 +362,44 @@ export const schemas = {
required: ['id', 'createdAt', 'blockee'] required: ['id', 'createdAt', 'blockee']
}, },
Reaction: {
type: 'object',
properties: {
id: {
type: 'string',
format: 'id',
description: 'The unique identifier for this reaction.',
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
},
createdAt: {
type: 'string',
format: 'date-time',
description: 'The date that the reaction was created.'
},
user: {
$ref: '#/components/schemas/User',
description: 'User who performed this reaction.'
},
type: {
type: 'string',
enum: [
'like',
'love',
'laugh',
'hmm',
'surprise',
'congrats',
'angry',
'confused',
'rip',
'pudding'
],
description: 'The reaction type.'
},
},
required: ['id', 'createdAt', 'user', 'type']
},
Hashtag: { Hashtag: {
type: 'object', type: 'object',
properties: { properties: {