From a07d753da84191bc8c185a7bcd6d73fab9529b5d Mon Sep 17 00:00:00 2001 From: YuzuRyo61 Date: Sat, 6 Mar 2021 22:34:11 +0900 Subject: APIドキュメントの改善 (#6757) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update api document in admin/announcements * Update api document in announcements * Update api document in i/read-announcements * Update api document in username/available * Update api document & Fix typo in API 403 error * Update api document * Update api document * Update api document * Fix API permission definition * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Fix bug in users (api) * Apply reviews #6757 * Apply reviews #6757 Co-authored-by: syuilo --- src/server/api/endpoints/antennas/list.ts | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'src/server/api/endpoints/antennas/list.ts') diff --git a/src/server/api/endpoints/antennas/list.ts b/src/server/api/endpoints/antennas/list.ts index cbc4e827b9..bc9685887f 100644 --- a/src/server/api/endpoints/antennas/list.ts +++ b/src/server/api/endpoints/antennas/list.ts @@ -2,11 +2,26 @@ import define from '../../define'; import { Antennas } from '../../../../models'; export const meta = { + desc: { + 'ja-JP': 'アンテナの一覧を取得します。', + 'en-US': 'Get a list of antennas.' + }, + tags: ['antennas', 'account'], requireCredential: true as const, kind: 'read:account', + + 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, + ref: 'Antenna' + } + } }; export default define(meta, async (ps, me) => { -- cgit v1.2.3-freya