mirror of
https://iceshrimp.dev/Crimekillz/jointrashposs.git
synced 2024-11-25 02:09:05 +01:00
75 lines
1.7 KiB
Plaintext
75 lines
1.7 KiB
Plaintext
{
|
||
summary: 'ノートを検索します。',
|
||
description: 'ノートを検索します。',
|
||
tags: [
|
||
'notes',
|
||
],
|
||
requireCredential: false,
|
||
req: {
|
||
type: 'object',
|
||
properties: {
|
||
query: {
|
||
type: 'string',
|
||
description: '検索クエリ。クエリが本文に含まれるノートを検索します。',
|
||
},
|
||
sinceId: {
|
||
type: 'string',
|
||
format: 'misskey:id',
|
||
description: '指定すると、idがその値よりも大きいノートを返します。',
|
||
},
|
||
untilId: {
|
||
type: 'string',
|
||
format: 'misskey:id',
|
||
description: '指定すると、idがその値よりも小さいノートを返します。',
|
||
},
|
||
limit: {
|
||
type: 'integer',
|
||
minimum: 1,
|
||
maximum: 100,
|
||
default: 10,
|
||
description: '取得するノートの最大数。',
|
||
},
|
||
offset: {
|
||
type: 'integer',
|
||
default: 0,
|
||
description: '検索結果の先頭offset個をスキップします。',
|
||
},
|
||
host: {
|
||
type: 'string',
|
||
nullable: true,
|
||
description: 'The local host is represented with `null`.',
|
||
},
|
||
userId: {
|
||
type: 'string',
|
||
format: 'misskey:id',
|
||
nullable: true,
|
||
default: null,
|
||
description: '指定すると、そのユーザが作成したノートを検索します。',
|
||
},
|
||
channelId: {
|
||
type: 'string',
|
||
format: 'misskey:id',
|
||
nullable: true,
|
||
default: null,
|
||
description: '指定すると、そのチャンネルに属するノートを検索します。userIdと併せて指定した場合、channelIdは無視されます。',
|
||
},
|
||
},
|
||
required: [
|
||
'query',
|
||
],
|
||
},
|
||
res: {
|
||
type: 'array',
|
||
optional: false,
|
||
nullable: false,
|
||
items: {
|
||
type: 'object',
|
||
optional: false,
|
||
nullable: false,
|
||
ref: 'Note',
|
||
$ref: 'misskey://Note',
|
||
},
|
||
},
|
||
errors: {},
|
||
}
|