mirror of
https://git.joinsharkey.org/Sharkey/Sharkey.git
synced 2024-11-27 11:23:08 +02:00
Improve doc
This commit is contained in:
parent
77676d18c8
commit
495aad6a2d
3 changed files with 34 additions and 1 deletions
|
@ -10,7 +10,14 @@ export const meta = {
|
|||
|
||||
requireCredential: true,
|
||||
|
||||
kind: 'account-read'
|
||||
kind: 'account-read',
|
||||
|
||||
res: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'UserList',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
export default define(meta, async (ps, me) => {
|
||||
|
|
|
@ -23,6 +23,10 @@ export const meta = {
|
|||
},
|
||||
},
|
||||
|
||||
res: {
|
||||
type: 'UserList'
|
||||
},
|
||||
|
||||
errors: {
|
||||
noSuchList: {
|
||||
message: 'No such list.',
|
||||
|
|
|
@ -97,6 +97,28 @@ export const schemas = {
|
|||
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: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
|
|
Loading…
Reference in a new issue