jointrashposs/content/ja-JP/.docs-legacy/api/endpoints/drive/folders.json5
kakkokari-gtyih a8dca2c347 migrate docs
2023-07-11 00:44:03 +09:00

52 lines
1.3 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
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: {},
}