Improve doc

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

@@ -1,6 +1,7 @@
 import $ from 'cafy';
 import define from '../../define';
-import driveChart from '../../../../services/chart/drive';
+import driveChart, { driveLogSchema } from '../../../../services/chart/drive';
+import { convertLog } from '../../../../services/chart';
 
 export const meta = {
 	stability: 'stable',
@@ -28,12 +29,7 @@ export const meta = {
 		},
 	},
 
-	res: {
-		type: 'array',
-		items: {
-			type: 'object',
-		},
-	},
+	res: convertLog(driveLogSchema),
 };
 
 export default define(meta, async (ps) => {

src/services/chart/drive.ts

@@ -2,46 +2,74 @@ import autobind from 'autobind-decorator';
 import Chart, { Obj } from './';
 import DriveFile, { IDriveFile } from '../../models/drive-file';
 import { isLocalUser } from '../../models/user';
+import { SchemaType } from '../../prelude/schema';
 
-/**
- * ドライブに関するチャート
- */
-type DriveLog = {
-	local: {
+const logSchema = {
 	/**
 	 * 集計期間時点での、全ドライブファイル数
 	 */
-		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;
-	};
-
-	remote: DriveLog['local'];
+	decSize: {
+		type: 'number' as 'number',
+		description: '減少したドライブ使用量'
+	},
 };
 
+export const driveLogSchema = {
+	type: 'object' as 'object',
+	properties: {
+		local: {
+			type: 'object' as 'object',
+			properties: logSchema
+		},
+		remote: {
+			type: 'object' as 'object',
+			properties: logSchema
+		},
+	}
+};
+
+type DriveLog = SchemaType<typeof driveLogSchema>;
+
 class DriveChart extends Chart<DriveLog> {
 	constructor() {
 		super('drive');