jointrashposs/content/ja-JP/.docs-legacy/api/endpoints/users/relation.json5

{
	summary: '',
	description: '',
	tags: [
		'users',
	],
	requireCredential: true,
	req: {
		type: 'object',
		properties: {
			userId: {
				anyOf: [
					{
						type: 'string',
						format: 'misskey:id',
					},
					{
						type: 'array',
						items: {
							type: 'string',
							format: 'misskey:id',
						},
					},
				],
			},
		},
		required: [
			'userId',
		],
	},
	res: {
		optional: false,
		nullable: false,
		oneOf: [
			{
				type: 'object',
				properties: {
					id: {
						type: 'string',
						optional: false,
						nullable: false,
						format: 'id',
					},
					isFollowing: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					hasPendingFollowRequestFromYou: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					hasPendingFollowRequestToYou: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					isFollowed: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					isBlocking: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					isBlocked: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
					isMuted: {
						type: 'boolean',
						optional: false,
						nullable: false,
					},
				},
				required: [
					'id',
					'isFollowing',
					'hasPendingFollowRequestFromYou',
					'hasPendingFollowRequestToYou',
					'isFollowed',
					'isBlocking',
					'isBlocked',
					'isMuted',
				],
			},
			{
				type: 'array',
				items: {
					type: 'object',
					optional: false,
					nullable: false,
					properties: {
						id: {
							type: 'string',
							optional: false,
							nullable: false,
							format: 'id',
						},
						isFollowing: {
							type: 'boolean',
							optional: false,
							nullable: false,
						},
						hasPendingFollowRequestFromYou: {
							type: 'boolean',
							optional: false,
							nullable: false,
						},
						hasPendingFollowRequestToYou: {
							type: 'boolean',
							optional: false,
							nullable: false,
						},
						isFollowed: {
							type: 'boolean',
							optional: false,
							nullable: false,
						},
						isBlocking: {
							type: 'boolean',
							optional: false,
							nullable: false,
						},
						isBlocked: {
							type: 'boolean',
							optional: false,
							nullable: false,
						},
						isMuted: {
							type: 'boolean',
							optional: false,
							nullable: false,
						},
					},
					required: [
						'id',
						'isFollowing',
						'hasPendingFollowRequestFromYou',
						'hasPendingFollowRequestToYou',
						'isFollowed',
						'isBlocking',
						'isBlocked',
						'isMuted',
					],
				},
			},
		],
	},
	errors: {},
}