summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/antennas/show.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/show.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/show.ts')
-rw-r--r--src/server/api/endpoints/antennas/show.ts11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/server/api/endpoints/antennas/show.ts b/src/server/api/endpoints/antennas/show.ts
index bc2093ba61..ed400f830c 100644
--- a/src/server/api/endpoints/antennas/show.ts
+++ b/src/server/api/endpoints/antennas/show.ts
@@ -5,6 +5,11 @@ import { ApiError } from '../../error';
import { Antennas } from '../../../../models';
export const meta = {
+ desc: {
+ 'ja-JP': '指定したアンテナの情報を取得します。',
+ 'en-US': 'Acquires the information of the specified antenna.'
+ },
+
tags: ['antennas', 'account'],
requireCredential: true as const,
@@ -23,6 +28,12 @@ export const meta = {
code: 'NO_SUCH_ANTENNA',
id: 'c06569fb-b025-4f23-b22d-1fcd20d2816b'
},
+ },
+
+ res: {
+ type: 'object' as const,
+ optional: false as const, nullable: false as const,
+ ref: 'Antenna'
}
};