Improve doc

This commit is contained in:
syuilo 2019-02-24 18:13:11 +09:00
parent f4ae939124
commit fcc6a65e08
No known key found for this signature in database
GPG Key ID: BDC4C49D06AB9D69
5 changed files with 50 additions and 3 deletions

View File

@ -30,6 +30,13 @@ export const meta = {
} }
}, },
res: {
type: 'array',
items: {
type: 'Note',
},
},
errors: { errors: {
noSuchFile: { noSuchFile: {
message: 'No such file.', message: 'No such file.',

View File

@ -21,7 +21,11 @@ export const meta = {
'ja-JP': 'ファイルのMD5ハッシュ' 'ja-JP': 'ファイルのMD5ハッシュ'
} }
} }
} },
res: {
type: 'DriveFile',
},
}; };
export default define(meta, async (ps, user) => { export default define(meta, async (ps, user) => {

View File

@ -29,7 +29,14 @@ export const meta = {
type: { type: {
validator: $.optional.str.match(/^[a-zA-Z\/\-\*]+$/) validator: $.optional.str.match(/^[a-zA-Z\/\-\*]+$/)
} }
} },
res: {
type: 'array',
items: {
type: 'DriveFile',
},
},
}; };
export default define(meta, async (ps, user) => { export default define(meta, async (ps, user) => {

View File

@ -54,7 +54,14 @@ export const meta = {
validator: $.optional.arr($.str.or(['follow', 'mention', 'reply', 'renote', 'quote', 'reaction', 'poll_vote', 'receiveFollowRequest'])), validator: $.optional.arr($.str.or(['follow', 'mention', 'reply', 'renote', 'quote', 'reaction', 'poll_vote', 'receiveFollowRequest'])),
default: [] as string[] default: [] as string[]
} }
} },
res: {
type: 'array',
items: {
type: 'Notification',
},
},
}; };
export default define(meta, async (ps, user) => { export default define(meta, async (ps, user) => {

View File

@ -146,6 +146,28 @@ export const schemas = {
required: ['id', 'userId', 'createdAt'] required: ['id', 'userId', 'createdAt']
}, },
Notification: {
type: 'object',
properties: {
id: {
type: 'string',
format: 'id',
description: 'The unique identifier for this notification.'
},
createdAt: {
type: 'string',
format: 'date-time',
description: 'The date that the notification was created.'
},
type: {
type: 'string',
enum: ['follow', 'receiveFollowRequest', 'mention', 'reply', 'renote', 'quote', 'reaction', 'poll_vote'],
description: 'The type of the notification.'
},
},
required: ['id', 'createdAt', 'type']
},
DriveFile: { DriveFile: {
type: 'object', type: 'object',
properties: { properties: {