summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/antennas/list.ts
diff options
context:
space:
mode:
authorYuzuRyo61 <yuzuryo61@yuzulia.work>2021-03-06 22:34:11 +0900
committerGitHub <noreply@github.com>2021-03-06 22:34:11 +0900
commita07d753da84191bc8c185a7bcd6d73fab9529b5d (patch)
tree085bc62b1f979020796a73373c3050f4948ed2bd /src/server/api/endpoints/antennas/list.ts
parentfeat: video play inline (using video tag) (#7242) (diff)
downloadmisskey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.tar.gz
misskey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.tar.bz2
misskey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.zip
APIドキュメントの改善 (#6757)
* 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 <Syuilotan@yahoo.co.jp>
Diffstat (limited to 'src/server/api/endpoints/antennas/list.ts')
-rw-r--r--src/server/api/endpoints/antennas/list.ts15
1 files changed, 15 insertions, 0 deletions
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) => {