jointrashposs/content/ja/.docs-legacy/api/endpoints/meta.json5

{
	summary: '自サーバー情報を取得します。',
	description: '自サーバー情報を取得します。',
	tags: [
		'meta',
	],
	requireCredential: false,
	req: {
		type: 'object',
		properties: {
			detail: {
				type: 'boolean',
				default: true,
			},
		},
		required: [],
	},
	res: {
		type: 'object',
		optional: false,
		nullable: false,
		properties: {
			maintainerName: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			maintainerEmail: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			version: {
				type: 'string',
				optional: false,
				nullable: false,
				example: '12.117.1',
			},
			name: {
				type: 'string',
				optional: false,
				nullable: false,
			},
			uri: {
				type: 'string',
				optional: false,
				nullable: false,
				format: 'url',
				example: 'https://misskey.example.com',
			},
			description: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			langs: {
				type: 'array',
				optional: false,
				nullable: false,
				items: {
					type: 'string',
					optional: false,
					nullable: false,
				},
			},
			tosUrl: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			repositoryUrl: {
				type: 'string',
				optional: false,
				nullable: false,
				default: 'https://github.com/misskey-dev/misskey',
			},
			feedbackUrl: {
				type: 'string',
				optional: false,
				nullable: false,
				default: 'https://github.com/misskey-dev/misskey/issues/new',
			},
			defaultDarkTheme: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			defaultLightTheme: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			disableRegistration: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			disableLocalTimeline: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			disableGlobalTimeline: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			driveCapacityPerLocalUserMb: {
				type: 'number',
				optional: false,
				nullable: false,
			},
			driveCapacityPerRemoteUserMb: {
				type: 'number',
				optional: false,
				nullable: false,
			},
			cacheRemoteFiles: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			emailRequiredForSignup: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			enableHcaptcha: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			hcaptchaSiteKey: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			enableRecaptcha: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			recaptchaSiteKey: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			swPublickey: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			mascotImageUrl: {
				type: 'string',
				optional: false,
				nullable: false,
				default: '/assets/ai.png',
			},
			bannerUrl: {
				type: 'string',
				optional: false,
				nullable: false,
			},
			errorImageUrl: {
				type: 'string',
				optional: false,
				nullable: false,
				default: 'https://xn--931a.moe/aiart/yubitun.png',
			},
			iconUrl: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			maxNoteTextLength: {
				type: 'number',
				optional: false,
				nullable: false,
			},
			emojis: {
				type: 'array',
				optional: false,
				nullable: false,
				items: {
					type: 'object',
					optional: false,
					nullable: false,
					properties: {
						id: {
							type: 'string',
							optional: false,
							nullable: false,
							format: 'id',
						},
						aliases: {
							type: 'array',
							optional: false,
							nullable: false,
							items: {
								type: 'string',
								optional: false,
								nullable: false,
							},
						},
						category: {
							type: 'string',
							optional: false,
							nullable: true,
						},
						host: {
							type: 'string',
							optional: false,
							nullable: true,
							description: 'The local host is represented with `null`.',
						},
						url: {
							type: 'string',
							optional: false,
							nullable: false,
							format: 'url',
						},
					},
					required: [
						'id',
						'aliases',
						'category',
						'host',
						'url',
					],
				},
			},
			ads: {
				type: 'array',
				optional: false,
				nullable: false,
				items: {
					type: 'object',
					optional: false,
					nullable: false,
					properties: {
						place: {
							type: 'string',
							optional: false,
							nullable: false,
						},
						url: {
							type: 'string',
							optional: false,
							nullable: false,
							format: 'url',
						},
						imageUrl: {
							type: 'string',
							optional: false,
							nullable: false,
							format: 'url',
						},
					},
					required: [
						'place',
						'url',
						'imageUrl',
					],
				},
			},
			requireSetup: {
				type: 'boolean',
				optional: false,
				nullable: false,
				example: false,
			},
			enableEmail: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			enableTwitterIntegration: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			enableGithubIntegration: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			enableDiscordIntegration: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			enableServiceWorker: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			translatorAvailable: {
				type: 'boolean',
				optional: false,
				nullable: false,
			},
			proxyAccountName: {
				type: 'string',
				optional: false,
				nullable: true,
			},
			features: {
				type: 'object',
				optional: true,
				nullable: false,
				properties: {
					registration: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					localTimeLine: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					globalTimeLine: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					elasticsearch: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					hcaptcha: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					recaptcha: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					objectStorage: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					twitter: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					github: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					discord: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					serviceWorker: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					miauth: {
						type: 'boolean',
						optional: true,
						nullable: false,
						default: true,
					},
				},
				required: [
					'registration',
					'localTimeLine',
					'globalTimeLine',
					'elasticsearch',
					'hcaptcha',
					'recaptcha',
					'objectStorage',
					'twitter',
					'github',
					'discord',
					'serviceWorker',
				],
			},
		},
		required: [
			'maintainerName',
			'maintainerEmail',
			'version',
			'name',
			'uri',
			'description',
			'langs',
			'tosUrl',
			'repositoryUrl',
			'feedbackUrl',
			'defaultDarkTheme',
			'defaultLightTheme',
			'disableRegistration',
			'disableLocalTimeline',
			'disableGlobalTimeline',
			'driveCapacityPerLocalUserMb',
			'driveCapacityPerRemoteUserMb',
			'cacheRemoteFiles',
			'emailRequiredForSignup',
			'enableHcaptcha',
			'hcaptchaSiteKey',
			'enableRecaptcha',
			'recaptchaSiteKey',
			'swPublickey',
			'mascotImageUrl',
			'bannerUrl',
			'errorImageUrl',
			'iconUrl',
			'maxNoteTextLength',
			'emojis',
			'ads',
			'requireSetup',
			'enableEmail',
			'enableTwitterIntegration',
			'enableGithubIntegration',
			'enableDiscordIntegration',
			'enableServiceWorker',
			'translatorAvailable',
			'proxyAccountName',
		],
	},
	errors: {},
}