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/admin/get-table-stats.ts
+++ b/src/server/api/endpoints/admin/get-table-stats.ts
@ -6,6 +6,7 @@ export const meta = {
 	requireModerator: true,

 	desc: {
+		'ja-JP': 'テーブル情報を取得します。',
 		'en-US': 'Get table stats'
 	},

@ -13,6 +14,17 @@ export const meta = {

 	params: {
 	},
+
+	res: {
+		type: 'object' as const,
+		optional: false as const, nullable: false as const,
+		example: {
+			migrations: {
+				count: 66,
+				size: 32768
+			},
+		}
+	}
 };

 export default define(meta, async () => {