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

452 lines
9.5 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: [
'account',
],
requireCredential: true,
req: {
type: 'object',
properties: {
name: {
type: 'string',
minLength: 1,
maxLength: 50,
nullable: true,
description: 'ユーザーの名前。',
},
description: {
type: 'string',
minLength: 1,
maxLength: 500,
nullable: true,
description: 'ユーザーの自己紹介。',
},
location: {
type: 'string',
minLength: 1,
maxLength: 50,
nullable: true,
description: 'ユーザーの場所。',
},
birthday: {
type: 'string',
pattern: '^([0-9]{4})-([0-9]{2})-([0-9]{2})$',
nullable: true,
description: 'ユーザーの誕生日。YYYY-MM-DDの形式で指定します2001年9月13日→2001-09-13。',
},
lang: {
type: 'string',
enum: [
null,
'ach',
'ady',
'af',
'af-NA',
'af-ZA',
'ak',
'ar',
'ar-AR',
'ar-MA',
'ar-SA',
'ay-BO',
'az',
'az-AZ',
'be-BY',
'bg',
'bg-BG',
'bn',
'bn-IN',
'bn-BD',
'br',
'bs-BA',
'ca',
'ca-ES',
'cak',
'ck-US',
'cs',
'cs-CZ',
'cy',
'cy-GB',
'da',
'da-DK',
'de',
'de-AT',
'de-DE',
'de-CH',
'dsb',
'el',
'el-GR',
'en',
'en-GB',
'en-AU',
'en-CA',
'en-IE',
'en-IN',
'en-PI',
'en-SG',
'en-UD',
'en-US',
'en-ZA',
'en@pirate',
'eo',
'eo-EO',
'es',
'es-AR',
'es-419',
'es-CL',
'es-CO',
'es-EC',
'es-ES',
'es-LA',
'es-NI',
'es-MX',
'es-US',
'es-VE',
'et',
'et-EE',
'eu',
'eu-ES',
'fa',
'fa-IR',
'fb-LT',
'ff',
'fi',
'fi-FI',
'fo',
'fo-FO',
'fr',
'fr-CA',
'fr-FR',
'fr-BE',
'fr-CH',
'fy-NL',
'ga',
'ga-IE',
'gd',
'gl',
'gl-ES',
'gn-PY',
'gu-IN',
'gv',
'gx-GR',
'he',
'he-IL',
'hi',
'hi-IN',
'hr',
'hr-HR',
'hsb',
'ht',
'hu',
'hu-HU',
'hy',
'hy-AM',
'id',
'id-ID',
'is',
'is-IS',
'it',
'it-IT',
'ja',
'ja-JP',
'jv-ID',
'ka-GE',
'kk-KZ',
'km',
'kl',
'km-KH',
'kab',
'kn',
'kn-IN',
'ko',
'ko-KR',
'ku-TR',
'kw',
'la',
'la-VA',
'lb',
'li-NL',
'lt',
'lt-LT',
'lv',
'lv-LV',
'mai',
'mg-MG',
'mk',
'mk-MK',
'ml',
'ml-IN',
'mn-MN',
'mr',
'mr-IN',
'ms',
'ms-MY',
'mt',
'mt-MT',
'my',
'no',
'nb',
'nb-NO',
'ne',
'ne-NP',
'nl',
'nl-BE',
'nl-NL',
'nn-NO',
'oc',
'or-IN',
'pa',
'pa-IN',
'pl',
'pl-PL',
'ps-AF',
'pt',
'pt-BR',
'pt-PT',
'qu-PE',
'rm-CH',
'ro',
'ro-RO',
'ru',
'ru-RU',
'sa-IN',
'se-NO',
'sh',
'si-LK',
'sk',
'sk-SK',
'sl',
'sl-SI',
'so-SO',
'sq',
'sq-AL',
'sr',
'sr-RS',
'su',
'sv',
'sv-SE',
'sw',
'sw-KE',
'ta',
'ta-IN',
'te',
'te-IN',
'tg',
'tg-TJ',
'th',
'th-TH',
'fil',
'tlh',
'tr',
'tr-TR',
'tt-RU',
'uk',
'uk-UA',
'ur',
'ur-PK',
'uz',
'uz-UZ',
'vi',
'vi-VN',
'xh-ZA',
'yi',
'yi-DE',
'zh',
'zh-Hans',
'zh-Hant',
'zh-CN',
'zh-HK',
'zh-SG',
'zh-TW',
'zu-ZA',
],
nullable: true,
description: 'ユーザーの使用言語。',
},
avatarId: {
type: 'string',
format: 'misskey:id',
nullable: true,
description: 'ユーザーのアバター画像に対応する、ドライブのファイルのid。',
},
bannerId: {
type: 'string',
format: 'misskey:id',
nullable: true,
description: 'ユーザーのバナー画像に対応する、ドライブのファイルのid。',
},
fields: {
type: 'array',
minItems: 0,
maxItems: 16,
items: {
type: 'object',
properties: {
name: {
type: 'string',
},
value: {
type: 'string',
},
},
required: [
'name',
'value',
],
},
description: 'ユーザーの追加情報。最大で16個の要素を持つことができます。',
},
isLocked: {
type: 'boolean',
description: 'trueにすると、フォローを承認制にします。反対にfalseにすると、他のユーザーが自由にフォローできるようになります。また、その時点で受け取っていたフォローリクエストはすべて承認されます。',
},
isExplorable: {
type: 'boolean',
description: 'trueにすると、ユーザーが他のユーザーにレコメンドされるようになります。Misskey Webでは「みつける」ページに使用されています。',
},
hideOnlineStatus: {
type: 'boolean',
description: 'trueにすると、ユーザーのオンライン状態を隠します。',
},
publicReactions: {
type: 'boolean',
description: 'trueにすると、ユーザーの行ったリアクションの履歴を公開します。',
},
carefulBot: {
type: 'boolean',
description: 'trueにすると、Botからのフォローを承認制にします。',
},
autoAcceptFollowed: {
type: 'boolean',
description: 'trueにすると、フォローしているユーザーからのフォローリクエストを自動で承認します。',
},
noCrawle: {
type: 'boolean',
description: 'trueにすると、クローラーによるインデックスを拒否します。',
},
isBot: {
type: 'boolean',
description: 'ユーザーがBotであるならばtrueにします。',
},
isCat: {
type: 'boolean',
description: 'trueにすると、ユーザーがネコとして扱います。これにより、ユーザーの投稿に出現する「な」が「にゃ」に置換されます。カタカナや英語など、他の文字種・言語についても同様の置換がなされます。',
},
showTimelineReplies: {
type: 'boolean',
description: 'trueにすると、タイムラインにートへの返信を表示します。',
},
injectFeaturedNote: {
type: 'boolean',
description: '',
},
receiveAnnouncementEmail: {
type: 'boolean',
description: 'trueにすると、お知らせをメールで受け取ります。',
},
alwaysMarkNsfw: {
type: 'boolean',
},
autoSensitive: {
type: 'boolean',
},
ffVisibility: {
type: 'string',
enum: [
'public',
'followers',
'private',
],
description: 'ユーザーのフォロー・フォロワー関係の公開範囲。publicにすると全体に、followersにするとフォロワーのみに公開されます。privateにすると誰にも公開されません。',
},
pinnedPageId: {
type: 'array',
items: {
type: 'string',
format: 'misskey:id',
},
description: 'ピン留めするページのid。',
},
mutedWords: {
type: 'array',
description: 'ミュートワード。',
},
mutedInstances: {
type: 'array',
items: {
type: 'string',
},
description: 'ミュートするサーバーのアドレス。',
},
mutingNotificationTypes: {
type: 'array',
items: {
type: 'string',
enum: [
'follow',
'mention',
'reply',
'renote',
'quote',
'reaction',
'pollVote',
'pollEnded',
'receiveFollowRequest',
'followRequestAccepted',
'groupInvited',
'app',
],
},
description: 'ミュートする通知の種類。',
},
emailNotificationTypes: {
type: 'array',
items: {
type: 'string',
},
description: 'メールを送る通知の種類。',
},
},
},
res: {
type: 'object',
optional: false,
nullable: false,
ref: 'MeDetailed',
$ref: 'misskey://MeDetailed',
},
errors: {
'539f3a45-f215-4f81-a9a8-31293640207f': {
id: '539f3a45-f215-4f81-a9a8-31293640207f',
code: 'NO_SUCH_AVATAR',
description: 'アバター画像のファイルが存在しません。',
},
'0d8f5629-f210-41c2-9433-735831a58595': {
id: '0d8f5629-f210-41c2-9433-735831a58595',
code: 'NO_SUCH_BANNER',
description: 'バナー画像のファイルが存在しません。',
},
'f419f9f8-2f4d-46b1-9fb4-49d3a2fd7191': {
id: 'f419f9f8-2f4d-46b1-9fb4-49d3a2fd7191',
code: 'AVATAR_NOT_AN_IMAGE',
description: 'アバター画像に、画像ではないファイルが指定されました。',
},
'75aedb19-2afd-4e6d-87fc-67941256fa60': {
id: '75aedb19-2afd-4e6d-87fc-67941256fa60',
code: 'BANNER_NOT_AN_IMAGE',
description: 'バナー画像に、画像ではないファイルが指定されました。',
},
'8e01b590-7eb9-431b-a239-860e086c408e': {
id: '8e01b590-7eb9-431b-a239-860e086c408e',
code: 'NO_SUCH_PAGE',
description: 'ページが存在しません。',
},
'0d786918-10df-41cd-8f33-8dec7d9a89a5': {
id: '0d786918-10df-41cd-8f33-8dec7d9a89a5',
code: 'INVALID_REGEXP',
description: '正規表現が不正です。',
},
},
}