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>

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'
 	}
 };
 

src/server/api/endpoints/antennas/delete.ts

@@ -5,6 +5,11 @@ import { ApiError } from '../../error';
 import { Antennas } from '../../../../models';
 
 export const meta = {
+	desc: {
+		'ja-JP': 'アンテナを削除します。',
+		'en-US': 'Delete a antenna.'
+	},
+
 	tags: ['antennas'],
 
 	requireCredential: true as const,

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) => {

src/server/api/endpoints/antennas/notes.ts

@@ -8,6 +8,11 @@ import { generateMutedUserQuery } from '../../common/generate-muted-user-query';
 import { ApiError } from '../../error';
 
 export const meta = {
+	desc: {
+		'ja-JP': '指定したアンテナのノート一覧を表示します。',
+		'en-US': 'Displays a list of notes for the specified antenna.'
+	},
+
 	tags: ['antennas', 'account', 'notes'],
 
 	requireCredential: true as const,
@@ -39,6 +44,16 @@ export const meta = {
 			code: 'NO_SUCH_ANTENNA',
 			id: '850926e0-fd3b-49b6-b69a-b28a5dbd82fe'
 		}
+	},
+
+	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: 'Note'
+		}
 	}
 };
 

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'
 	}
 };
 

src/server/api/endpoints/antennas/update.ts

@@ -5,6 +5,11 @@ import { ApiError } from '../../error';
 import { Antennas, UserLists, UserGroupJoinings } from '../../../../models';
 
 export const meta = {
+	desc: {
+		'ja-JP': 'アンテナの情報を更新します。',
+		'en-US': 'Updates the information of the specified antenna.'
+	},
+
 	tags: ['antennas'],
 
 	requireCredential: true as const,
@@ -79,6 +84,12 @@ export const meta = {
 			code: 'NO_SUCH_USER_GROUP',
 			id: '109ed789-b6eb-456e-b8a9-6059d567d385'
 		}
+	},
+
+	res: {
+		type: 'object' as const,
+		optional: false as const, nullable: false as const,
+		ref: 'Antenna'
 	}
 };