misskey/src/server/api/endpoints/admin/relays/list.ts

import define from '../../../define';
import { listRelay } from '../../../../../services/relay';

export const meta = {
	desc: {
		'ja-JP': 'リレー一覧を表示します。',
		'en-US': 'List relay'
	},

	tags: ['admin'],

	requireCredential: true as const,
	requireModerator: true as const,

	params: {
	},

	res: {
		type: 'array' as const,
		optional: false as const, nullable: false as const,
		items: {
			type: 'object' as const,
			optional: false as const, nullable: false as const,
			properties: {
				id: {
					type: 'string' as const,
					optional: false as const, nullable: false as const,
					format: 'id'
				},
				inbox: {
					type: 'string' as const,
					optional: false as const, nullable: false as const,
					format: 'url'
				},
				status: {
					type: 'string' as const,
					optional: false as const, nullable: false as const,
					default: 'requesting',
					enum: [
						'requesting',
						'accepted',
						'rejected'
					]
				}
			}
		}
	}
};

export default define(meta, async (ps, user) => {
	return await listRelay();
});