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/charts/active-users.ts

@@ -9,6 +9,8 @@ export const meta = {
 		'ja-JP': 'アクティブユーザーのチャートを取得します。'
 	},
 
+	tags: ['charts', 'users'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -24,7 +26,14 @@ export const meta = {
 				'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
 			}
 		},
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -9,6 +9,8 @@ export const meta = {
 		'ja-JP': 'ドライブのチャートを取得します。'
 	},
 
+	tags: ['charts', 'drive'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -24,7 +26,14 @@ export const meta = {
 				'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
 			}
 		},
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -9,6 +9,8 @@ export const meta = {
 		'ja-JP': 'フェデレーションのチャートを取得します。'
 	},
 
+	tags: ['charts'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -24,7 +26,14 @@ export const meta = {
 				'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
 			}
 		},
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -9,6 +9,8 @@ export const meta = {
 		'ja-JP': 'ハッシュタグごとのチャートを取得します。'
 	},
 
+	tags: ['charts', 'hashtags'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -31,7 +33,14 @@ export const meta = {
 				'ja-JP': '対象のハッシュタグ'
 			}
 		},
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -9,6 +9,8 @@ export const meta = {
 		'ja-JP': 'インスタンスごとのチャートを取得します。'
 	},
 
+	tags: ['charts'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -32,7 +34,14 @@ export const meta = {
 				'en-US': 'Target instance host'
 			}
 		}
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -9,6 +9,8 @@ export const meta = {
 		'ja-JP': 'ネットワークのチャートを取得します。'
 	},
 
+	tags: ['charts'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -24,7 +26,14 @@ export const meta = {
 				'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
 			}
 		},
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -9,6 +9,8 @@ export const meta = {
 		'ja-JP': '投稿のチャートを取得します。'
 	},
 
+	tags: ['charts', 'notes'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -24,7 +26,14 @@ export const meta = {
 				'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
 			}
 		},
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -10,6 +10,8 @@ export const meta = {
 		'ja-JP': 'ユーザーごとのドライブのチャートを取得します。'
 	},
 
+	tags: ['charts', 'drive', 'users'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -34,7 +36,14 @@ export const meta = {
 				'en-US': 'Target user ID'
 			}
 		}
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -10,6 +10,8 @@ export const meta = {
 		'ja-JP': 'ユーザーごとのフォロー/フォロワーのチャートを取得します。'
 	},
 
+	tags: ['charts', 'users', 'following'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -34,7 +36,14 @@ export const meta = {
 				'en-US': 'Target user ID'
 			}
 		}
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -10,6 +10,8 @@ export const meta = {
 		'ja-JP': 'ユーザーごとの投稿のチャートを取得します。'
 	},
 
+	tags: ['charts', 'users', 'notes'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -34,7 +36,14 @@ export const meta = {
 				'en-US': 'Target user ID'
 			}
 		}
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -10,6 +10,8 @@ export const meta = {
 		'ja-JP': 'ユーザーごとの被リアクション数のチャートを取得します。'
 	},
 
+	tags: ['charts', 'users', 'reactions'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -34,7 +36,14 @@ export const meta = {
 				'en-US': 'Target user ID'
 			}
 		}
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {

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

@@ -9,6 +9,8 @@ export const meta = {
 		'ja-JP': 'ユーザーのチャートを取得します。'
 	},
 
+	tags: ['charts', 'users'],
+
 	params: {
 		span: {
 			validator: $.str.or(['day', 'hour']),
@@ -24,7 +26,14 @@ export const meta = {
 				'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
 			}
 		},
-	}
+	},
+
+	res: {
+		type: 'array',
+		items: {
+			type: 'object',
+		},
+	},
 };
 
 export default define(meta, async (ps) => {