Improve doc

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

@@ -40,7 +40,14 @@ export const meta = {
 		type: {
 			validator: $.optional.str.match(/^[a-zA-Z\/\-\*]+$/)
 		}
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'DriveFile',
+		},
+	},
 };
 
 export default define(meta, async (ps, user) => {

src/server/api/endpoints/drive/files/create.ts

@@ -56,6 +56,10 @@ export const meta = {
 		}
 	},
 
+	res: {
+		type: 'DriveFile',
+	},
+
 	errors: {
 		invalidFileName: {
 			message: 'Invalid file name.',

src/server/api/endpoints/drive/files/show.ts

@@ -39,6 +39,10 @@ export const meta = {
 		}
 	},
 
+	res: {
+		type: 'DriveFile',
+	},
+
 	errors: {
 		noSuchFile: {
 			message: 'No such file.',

src/server/api/gen-openapi-spec.ts

@@ -109,21 +109,25 @@ const schemas = {
 			},
 			username: {
 				type: 'string',
-				description: 'The screen name, handle, or alias that this user identifies themselves with.'
+				description: 'The screen name, handle, or alias that this user identifies themselves with.',
+				example: 'ai'
 			},
 			name: {
 				type: 'string',
 				nullable: true,
-				description: 'The name of the user, as they’ve defined it.'
+				description: 'The name of the user, as they’ve defined it.',
+				example: '藍'
 			},
 			host: {
 				type: 'string',
-				nullable: true
+				nullable: true,
+				example: 'misskey.example.com'
 			},
 			description: {
 				type: 'string',
 				nullable: true,
-				description: 'The user-defined UTF-8 string describing their account.'
+				description: 'The user-defined UTF-8 string describing their account.',
+				example: 'Hi masters, I am Ai!'
 			},
 			createdAt: {
 				type: 'string',
@@ -143,13 +147,16 @@ const schemas = {
 				description: 'The number of Notes (including renotes) issued by the user.'
 			},
 			isBot: {
-				type: 'boolean'
+				type: 'boolean',
+				description: 'Whether this account is a bot.'
 			},
 			isCat: {
-				type: 'boolean'
+				type: 'boolean',
+				description: 'Whether this account is a cat.'
 			},
 			isAdmin: {
-				type: 'boolean'
+				type: 'boolean',
+				description: 'Whether this account is the admin.'
 			},
 			isVerified: {
 				type: 'boolean'
@@ -208,7 +215,55 @@ const schemas = {
 				type: 'string'
 			},
 		},
-		required: ['id', 'userId']
+		required: ['id', 'userId', 'createdAt']
+	},
+
+	DriveFile: {
+		type: 'object',
+		properties: {
+			id: {
+				type: 'string',
+				format: 'id',
+				description: 'The unique identifier for this Drive file.'
+			},
+			createdAt: {
+				type: 'string',
+				format: 'date-time',
+				description: 'The date that the Drive file was created on Misskey.'
+			},
+			name: {
+				type: 'string',
+				description: 'The file name with extension.',
+				example: 'lenna.jpg'
+			},
+			type: {
+				type: 'string',
+				description: 'The MIME type of this Drive file.',
+				example: 'image/jpeg'
+			},
+			md5: {
+				type: 'string',
+				format: 'md5',
+				description: 'The MD5 hash of this Drive file.',
+				example: '15eca7fba0480996e2245f5185bf39f2'
+			},
+			datasize: {
+				type: 'number',
+				description: 'The size of this Drive file. (bytes)',
+				example: 51469
+			},
+			folderId: {
+				type: 'string',
+				format: 'id',
+				nullable: true,
+				description: 'The parent folder ID of this Drive file.',
+			},
+			isSensitive: {
+				type: 'boolean',
+				description: 'Whether this Drive file is sensitive.',
+			},
+		},
+		required: ['id', 'createdAt', 'name', 'type', 'datasize', 'md5']
 	}
 };
 
@@ -311,7 +366,7 @@ export function genOpenapiSpec(lang = 'ja-JP') {
 		function renderType(x: any) {
 			const res = {} as any;
 
-			if (['User', 'Note'].includes(x.type)) {
+			if (['User', 'Note', 'DriveFile'].includes(x.type)) {
 				res['$ref'] = `#/components/schemas/${x.type}`;
 			} else if (x.type === 'object') {
 				res['type'] = 'object';