Introduce OpenAPI specs (#4351)

* wip

* wip

* wip

* Update index.ts

* Update gen-openapi-spec.ts

* Update api.ja-JP.md

* Fix

* Improve doc

* Update gen-openapi-spec.ts

* Update redoc.html

* Improve doc

* Update gen-openapi-spec.ts

* Improve doc

* Update CHANGELOG.md

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

@@ -9,6 +9,8 @@ export const meta = {
 		'en-US': 'Get files of drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-read',
@@ -38,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/attached_notes.ts

@@ -13,6 +13,8 @@ export const meta = {
 		'en-US': 'Get the notes that specified file of drive attached.'
 	},
 
+	tags: ['drive', 'notes'],
+
 	requireCredential: true,
 
 	kind: 'drive-read',

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

@@ -8,6 +8,8 @@ export const meta = {
 		'en-US': 'Returns whether the file with the given MD5 hash exists in the user\'s drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-read',

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

@@ -13,6 +13,8 @@ export const meta = {
 		'en-US': 'Upload a file to drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	limit: {
@@ -35,7 +37,7 @@ export const meta = {
 		},
 
 		isSensitive: {
-			validator: $.optional.or($.bool, $.str),
+			validator: $.optional.either($.bool, $.str),
 			default: false,
 			transform: (v: any): boolean => v === true || v === 'true',
 			desc: {
@@ -45,7 +47,7 @@ export const meta = {
 		},
 
 		force: {
-			validator: $.optional.or($.bool, $.str),
+			validator: $.optional.either($.bool, $.str),
 			default: false,
 			transform: (v: any): boolean => v === true || v === 'true',
 			desc: {
@@ -54,6 +56,10 @@ export const meta = {
 		}
 	},
 
+	res: {
+		type: 'DriveFile',
+	},
+
 	errors: {
 		invalidFileName: {
 			message: 'Invalid file name.',

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

@@ -14,6 +14,8 @@ export const meta = {
 		'en-US': 'Delete a file of drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-write',

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

@@ -6,6 +6,8 @@ import define from '../../../define';
 export const meta = {
 	requireCredential: true,
 
+	tags: ['drive'],
+
 	kind: 'drive-read',
 
 	params: {

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

@@ -14,6 +14,8 @@ export const meta = {
 		'en-US': 'Get specified file of drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-read',
@@ -37,6 +39,10 @@ export const meta = {
 		}
 	},
 
+	res: {
+		type: 'DriveFile',
+	},
+
 	errors: {
 		noSuchFile: {
 			message: 'No such file.',

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

@@ -13,6 +13,8 @@ export const meta = {
 		'en-US': 'Update specified file of drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-write',

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

@@ -10,6 +10,8 @@ export const meta = {
 		'ja-JP': 'ドライブに指定されたURLに存在するファイルをアップロードします。'
 	},
 
+	tags: ['drive'],
+
 	limit: {
 		duration: ms('1hour'),
 		max: 60

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

@@ -9,6 +9,8 @@ export const meta = {
 		'en-US': 'Get folders of drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-read',

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

@@ -13,6 +13,8 @@ export const meta = {
 		'en-US': 'Create a folder of drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-write',

src/server/api/endpoints/drive/folders/delete.ts

@@ -14,6 +14,8 @@ export const meta = {
 		'en-US': 'Delete specified folder of drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-write',

src/server/api/endpoints/drive/folders/find.ts

@@ -4,6 +4,8 @@ import DriveFolder, { pack } from '../../../../../models/drive-folder';
 import define from '../../../define';
 
 export const meta = {
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-read',

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

@@ -12,6 +12,8 @@ export const meta = {
 		'en-US': 'Get specified folder of drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-read',

src/server/api/endpoints/drive/folders/update.ts

@@ -13,6 +13,8 @@ export const meta = {
 		'en-US': 'Update specified folder of drive.'
 	},
 
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-write',

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

@@ -4,6 +4,8 @@ import DriveFile, { packMany } from '../../../../models/drive-file';
 import define from '../../define';
 
 export const meta = {
+	tags: ['drive'],
+
 	requireCredential: true,
 
 	kind: 'drive-read',