mirror of
https://git.joinsharkey.org/Sharkey/Sharkey.git
synced 2024-11-27 14:13:07 +02:00
Improve doc
This commit is contained in:
parent
61ac024127
commit
077bdbfdef
4 changed files with 60 additions and 2 deletions
|
@ -36,7 +36,14 @@ export const meta = {
|
|||
default: null as any,
|
||||
transform: transform,
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
res: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'DriveFolder',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
export default define(meta, async (ps, user) => {
|
||||
|
|
|
@ -23,7 +23,14 @@ export const meta = {
|
|||
'ja-JP': 'フォルダID'
|
||||
}
|
||||
},
|
||||
}
|
||||
},
|
||||
|
||||
res: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'DriveFolder',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
export default define(meta, async (ps, user) => {
|
||||
|
|
|
@ -29,6 +29,10 @@ export const meta = {
|
|||
}
|
||||
},
|
||||
|
||||
res: {
|
||||
type: 'DriveFolder',
|
||||
},
|
||||
|
||||
errors: {
|
||||
noSuchFolder: {
|
||||
message: 'No such folder.',
|
||||
|
|
|
@ -278,6 +278,46 @@ export const schemas = {
|
|||
required: ['id', 'createdAt', 'name', 'type', 'datasize', 'md5']
|
||||
},
|
||||
|
||||
DriveFolder: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: {
|
||||
type: 'string',
|
||||
format: 'id',
|
||||
description: 'The unique identifier for this Drive folder.',
|
||||
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
|
||||
},
|
||||
createdAt: {
|
||||
type: 'string',
|
||||
format: 'date-time',
|
||||
description: 'The date that the Drive folder was created.'
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
description: 'The folder name.',
|
||||
},
|
||||
foldersCount: {
|
||||
type: 'number',
|
||||
description: 'The count of child folders.',
|
||||
},
|
||||
filesCount: {
|
||||
type: 'number',
|
||||
description: 'The count of child files.',
|
||||
},
|
||||
parentId: {
|
||||
type: 'string',
|
||||
format: 'id',
|
||||
nullable: true,
|
||||
description: 'The parent folder ID of this folder.',
|
||||
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
|
||||
},
|
||||
parent: {
|
||||
type: 'DriveFolder',
|
||||
},
|
||||
},
|
||||
required: ['id', 'createdAt', 'name']
|
||||
},
|
||||
|
||||
Muting: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
|
|
Loading…
Reference in a new issue