Improve doc

src/server/api/endpoints/charts/user/drive.ts

@@ -1,7 +1,8 @@
 import $ from 'cafy';
 import define from '../../../define';
-import perUserDriveChart from '../../../../../services/chart/per-user-drive';
+import perUserDriveChart, { perUserDriveLogSchema } from '../../../../../services/chart/per-user-drive';
 import ID, { transform } from '../../../../../misc/cafy-id';
+import { convertLog } from '../../../../../services/chart';
 
 export const meta = {
 	stability: 'stable',
@@ -38,12 +39,7 @@ export const meta = {
 		}
 	},
 
-	res: {
+	res: convertLog(perUserDriveLogSchema),
-		type: 'array',
-		items: {
-			type: 'object',
-		},
-	},
 };
 
 export default define(meta, async (ps) => {

src/services/chart/per-user-drive.ts

@@ -1,42 +1,63 @@
 import autobind from 'autobind-decorator';
 import Chart, { Obj } from './';
 import DriveFile, { IDriveFile } from '../../models/drive-file';
+import { SchemaType } from '../../prelude/schema';
 
-/**
+export const perUserDriveLogSchema = {
- * ユーザーごとのドライブに関するチャート
+	type: 'object' as 'object',
- */
+	properties: {
-type PerUserDriveLog = {
 		/**
 		 * 集計期間時点での、全ドライブファイル数
 		 */
-	totalCount: number;
+		totalCount: {
+			type: 'number' as 'number',
+			description: '集計期間時点での、全ドライブファイル数'
+		},
 
 		/**
 		 * 集計期間時点での、全ドライブファイルの合計サイズ
 		 */
-	totalSize: number;
+		totalSize: {
+			type: 'number' as 'number',
+			description: '集計期間時点での、全ドライブファイルの合計サイズ'
+		},
 
 		/**
 		 * 増加したドライブファイル数
 		 */
-	incCount: number;
+		incCount: {
+			type: 'number' as 'number',
+			description: '増加したドライブファイル数'
+		},
 
 		/**
 		 * 増加したドライブ使用量
 		 */
-	incSize: number;
+		incSize: {
+			type: 'number' as 'number',
+			description: '増加したドライブ使用量'
+		},
 
 		/**
 		 * 減少したドライブファイル数
 		 */
-	decCount: number;
+		decCount: {
+			type: 'number' as 'number',
+			description: '減少したドライブファイル数'
+		},
 
 		/**
 		 * 減少したドライブ使用量
 		 */
-	decSize: number;
+		decSize: {
+			type: 'number' as 'number',
+			description: '減少したドライブ使用量'
+		},
+	}
 };
 
+type PerUserDriveLog = SchemaType<typeof perUserDriveLogSchema>;
+
 class PerUserDriveChart extends Chart<PerUserDriveLog> {
 	constructor() {
 		super('perUserDrive', true);