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>
2021-03-06 22:34:11 +09:00
parent 3003100443
commit a07d753da8
100 changed files with 3050 additions and 109 deletions
--- a/src/server/api/endpoints/antennas/create.ts
+++ b/src/server/api/endpoints/antennas/create.ts
@@ -6,6 +6,11 @@ import { ID } from '../../../../misc/cafy-id';
 import { ApiError } from '../../error';

 export const meta = {
+	desc: {
+		'ja-JP': 'アンテナを作成します。',
+		'en-US': 'Create a antenna.'
+	},
+
 	tags: ['antennas'],

 	requireCredential: true as const,
@@ -70,6 +75,12 @@ export const meta = {
 			code: 'NO_SUCH_USER_GROUP',
 			id: 'aa3c0b9a-8cae-47c0-92ac-202ce5906682'
 		}
+	},
+
+	res: {
+		type: 'object' as const,
+		optional: false as const, nullable: false as const,
+		ref: 'Antenna'
 	}
 };