jointrashposs/content/ja/.docs-legacy/api/endpoints/notes/reactions.json5
2023-07-11 23:48:17 +09:00

68 lines
1.7 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: [
'notes',
],
requireCredential: false,
req: {
type: 'object',
properties: {
noteId: {
type: 'string',
format: 'misskey:id',
description: 'ートのid。',
},
type: {
type: 'string',
nullable: true,
description: 'リアクションの種類。リアクションはUnicode絵文字もしくはカスタム絵文字です。カスタム絵文字の場合はコロンで絵文字名を括ります。',
},
limit: {
type: 'integer',
minimum: 1,
maximum: 100,
default: 10,
description: '取得するリアクションの最大数。',
},
offset: {
type: 'integer',
default: 0,
description: '検索結果の先頭 offset 個をスキップします。'
},
sinceId: {
type: 'string',
format: 'misskey:id',
description: '指定すると、idがその値よりも大きいリアクションを返します。',
},
untilId: {
type: 'string',
format: 'misskey:id',
description: '指定すると、idがその値よりも小さいリアクションを返します。',
},
},
required: [
'noteId',
],
},
res: {
type: 'array',
optional: false,
nullable: false,
items: {
type: 'object',
optional: false,
nullable: false,
ref: 'NoteReaction',
$ref: 'misskey://NoteReaction',
},
},
errors: {
'263fff3d-d0e1-4af4-bea7-8408059b451a': {
id: '263fff3d-d0e1-4af4-bea7-8408059b451a',
code: 'NO_SUCH_NOTE',
description: '指定されたノートが存在しないか、アクセスが許可されていません。',
},
},
}