mirror of
https://iceshrimp.dev/Crimekillz/jointrashposs.git
synced 2024-11-24 09:49:06 +01:00
67 lines
2.2 KiB
Plaintext
67 lines
2.2 KiB
Plaintext
|
{
|
|||
|
|
summary: 'ノート一覧を取得します。',
|
|||
|
|
description: 'ノート一覧を取得します。',
|
|||
|
|
requireCredential: true,
|
|||
|
|
tags: [
|
|||
|
|
'notes',
|
|||
|
|
],
|
|||
|
|
requireCredential: false,
|
|||
|
|
req: {
|
|||
|
|
type: 'object',
|
|||
|
|
properties: {
|
|||
|
|
local: {
|
|||
|
|
type: 'boolean',
|
|||
|
|
default: false,
|
|||
|
|
description: 'ローカルで作成されたノートのみを取得します。',
|
|||
|
|
},
|
|||
|
|
reply: {
|
|||
|
|
type: 'boolean',
|
|||
|
|
description: '`true` にすると返信だけを、 `false` にすると返信以外を取得します。値を設定しなければ返信であるかそうでないかに関係なくノートを取得します。',
|
|||
|
|
},
|
|||
|
|
renote: {
|
|||
|
|
type: 'boolean',
|
|||
|
|
description: '`true` にするとリノートだけを、 `false` にするとリノート以外を取得します。値を設定しなければリノートであるかそうでないかに関係なくノートを取得します。',
|
|||
|
|
},
|
|||
|
|
withFiles: {
|
|||
|
|
type: 'boolean',
|
|||
|
|
description: '`true` にすると添付ファイルのあるノートだけを、 `false` にすると添付ファイルがないノートだけを取得します。値を設定しなければ添付ファイルの有無にかかわらずノートを取得します。',
|
|||
|
|
},
|
|||
|
|
poll: {
|
|||
|
|
type: 'boolean',
|
|||
|
|
description: '`true` にすると投票を含むノートだけを、 `false` にすると含まないノートだけを取得します。値を設定しなければ投票の有無にかかわらずノートを取得します。',
|
|||
|
|
},
|
|||
|
|
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がその値よりも小さいノートを返します。',
|
|||
|
|
},
|
|||
|
|
},
|
|||
|
|
required: [],
|
|||
|
|
},
|
|||
|
|
res: {
|
|||
|
|
type: 'array',
|
|||
|
|
optional: false,
|
|||
|
|
nullable: false,
|
|||
|
|
items: {
|
|||
|
|
type: 'object',
|
|||
|
|
optional: false,
|
|||
|
|
nullable: false,
|
|||
|
|
ref: 'Note',
|
|||
|
|
$ref: 'misskey://Note',
|
|||
|
|
},
|
|||
|
|
},
|
|||
|
|
errors: {},
|
|||
|
|
}
|