jointrashposs/content/ja/.docs-legacy/api/endpoints/drive/folders.json5

52 lines
1.3 KiB
Plaintext
Raw Normal View History

2023-07-08 10:36:02 +02:00
{
summary: '指定のフォルダーあるいはルート階層にある、フォルダーの一覧を取得します。',
description: 'ログイン中のユーザのドライブ以下、指定のフォルダーあるいはルート階層にある、フォルダーの一覧を取得します。',
tags: [
'drive',
],
requireCredential: true,
req: {
type: 'object',
properties: {
limit: {
type: 'integer',
minimum: 1,
maximum: 100,
default: 10,
description: '取得するフォルダーの最大数。',
},
sinceId: {
type: 'string',
format: 'misskey:id',
description: '指定すると、idがその値よりも大きいフォルダーを返します。',
},
untilId: {
type: 'string',
format: 'misskey:id',
description: '指定すると、idがその値よりも小さいフォルダーを返します。',
},
folderId: {
type: 'string',
format: 'misskey:id',
nullable: true,
default: null,
description: '親フォルダのid。nullデフォルトであればルート階層にあるフォルダーを取得します。',
},
},
required: [],
},
res: {
type: 'array',
optional: false,
nullable: false,
items: {
type: 'object',
optional: false,
nullable: false,
ref: 'DriveFolder',
$ref: 'misskey://DriveFolder',
},
},
errors: {},
}