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

104 lines
1.5 KiB
Plaintext

{
summary: '',
description: '',
tags: [
'antennas',
],
requireCredential: true,
req: {
type: 'object',
properties: {
antennaId: {
type: 'string',
format: 'misskey:id',
},
name: {
type: 'string',
minLength: 1,
maxLength: 100,
},
src: {
type: 'string',
enum: [
'home',
'all',
'users',
'list',
],
},
userListId: {
type: 'string',
format: 'misskey:id',
nullable: true,
},
keywords: {
type: 'array',
items: {
type: 'array',
items: {
type: 'string',
},
},
},
excludeKeywords: {
type: 'array',
items: {
type: 'array',
items: {
type: 'string',
},
},
},
users: {
type: 'array',
items: {
type: 'string',
},
},
caseSensitive: {
type: 'boolean',
},
withReplies: {
type: 'boolean',
},
withFile: {
type: 'boolean',
},
notify: {
type: 'boolean',
},
},
required: [
'antennaId',
'name',
'src',
'keywords',
'excludeKeywords',
'users',
'caseSensitive',
'withReplies',
'withFile',
'notify',
],
},
res: {
type: 'object',
optional: false,
nullable: false,
ref: 'Antenna',
$ref: 'misskey://Antenna',
},
errors: {
'10c673ac-8852-48eb-aa1f-f5b67f069290': {
id: '10c673ac-8852-48eb-aa1f-f5b67f069290',
code: 'NO_SUCH_ANTENNA',
description: '',
},
'1c6b35c9-943e-48c2-81e4-2844989407f7': {
id: '1c6b35c9-943e-48c2-81e4-2844989407f7',
code: 'NO_SUCH_USER_LIST',
description: '',
},
},
}