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/admin/show-users.ts

@@ -3,6 +3,11 @@ import define from '../../define';
 import { Users } from '../../../../models';
 
 export const meta = {
+	desc: {
+		'ja-JP': '管理者用のユーザー一覧を表示します。',
+		'en-US': 'Displays a list of users for administrators.'
+	},
+
 	tags: ['admin'],
 
 	requireCredential: true as const,
@@ -61,6 +66,16 @@ export const meta = {
 			validator: $.optional.str,
 			default: null
 		}
+	},
+
+	res: {
+		type: 'array' as const,
+		nullable: false as const, optional: false as const,
+		items: {
+			type: 'object' as const,
+			nullable: false as const, optional: false as const,
+			ref: 'User'
+		}
 	}
 };