1
1
mirror of https://github.com/kokonect-link/cherrypick synced 2024-12-11 13:18:54 +09:00

Improve doc

This commit is contained in:
syuilo 2019-02-25 03:35:45 +09:00
parent 77676d18c8
commit 495aad6a2d
No known key found for this signature in database
GPG Key ID: BDC4C49D06AB9D69
3 changed files with 34 additions and 1 deletions

View File

@ -10,7 +10,14 @@ export const meta = {
requireCredential: true, requireCredential: true,
kind: 'account-read' kind: 'account-read',
res: {
type: 'array',
items: {
type: 'UserList',
},
},
}; };
export default define(meta, async (ps, me) => { export default define(meta, async (ps, me) => {

View File

@ -23,6 +23,10 @@ export const meta = {
}, },
}, },
res: {
type: 'UserList'
},
errors: { errors: {
noSuchList: { noSuchList: {
message: 'No such list.', message: 'No such list.',

View File

@ -97,6 +97,28 @@ export const schemas = {
required: ['id', 'name', 'username', 'createdAt'] required: ['id', 'name', 'username', 'createdAt']
}, },
UserList: {
type: 'object',
properties: {
id: {
type: 'string',
format: 'id',
description: 'The unique identifier for this UserList.',
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
},
createdAt: {
type: 'string',
format: 'date-time',
description: 'The date that the UserList was created.'
},
title: {
type: 'string',
description: 'The name of the UserList.'
},
},
required: ['id', 'createdAt', 'title']
},
Note: { Note: {
type: 'object', type: 'object',
properties: { properties: {