From 52774bbe6402aee076b2e0648bd1f4764924da8a Mon Sep 17 00:00:00 2001
From: syuilo <Syuilotan@yahoo.co.jp>
Date: Sat, 23 Feb 2019 11:20:58 +0900
Subject: 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   | 11 ++++++++++-
 src/server/api/endpoints/charts/drive.ts          | 11 ++++++++++-
 src/server/api/endpoints/charts/federation.ts     | 11 ++++++++++-
 src/server/api/endpoints/charts/hashtag.ts        | 11 ++++++++++-
 src/server/api/endpoints/charts/instance.ts       | 11 ++++++++++-
 src/server/api/endpoints/charts/network.ts        | 11 ++++++++++-
 src/server/api/endpoints/charts/notes.ts          | 11 ++++++++++-
 src/server/api/endpoints/charts/user/drive.ts     | 11 ++++++++++-
 src/server/api/endpoints/charts/user/following.ts | 11 ++++++++++-
 src/server/api/endpoints/charts/user/notes.ts     | 11 ++++++++++-
 src/server/api/endpoints/charts/user/reactions.ts | 11 ++++++++++-
 src/server/api/endpoints/charts/users.ts          | 11 ++++++++++-
 12 files changed, 120 insertions(+), 12 deletions(-)

(limited to 'src/server/api/endpoints/charts')

diff --git a/src/server/api/endpoints/charts/active-users.ts b/src/server/api/endpoints/charts/active-users.ts
index 11f86d0baa..9dad942e06 100644
--- a/src/server/api/endpoints/charts/active-users.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/drive.ts b/src/server/api/endpoints/charts/drive.ts
index 9244ef7481..5438d76486 100644
--- a/src/server/api/endpoints/charts/drive.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/federation.ts b/src/server/api/endpoints/charts/federation.ts
index c98c9f6cbb..c7b34f1015 100644
--- a/src/server/api/endpoints/charts/federation.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/hashtag.ts b/src/server/api/endpoints/charts/hashtag.ts
index 5905fdc1a2..4db6e62408 100644
--- a/src/server/api/endpoints/charts/hashtag.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/instance.ts b/src/server/api/endpoints/charts/instance.ts
index e47334c7ce..3fe85f086a 100644
--- a/src/server/api/endpoints/charts/instance.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/network.ts b/src/server/api/endpoints/charts/network.ts
index fa1917f753..48b1d0f66f 100644
--- a/src/server/api/endpoints/charts/network.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/notes.ts b/src/server/api/endpoints/charts/notes.ts
index 006a8d6e21..d254bb854c 100644
--- a/src/server/api/endpoints/charts/notes.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/user/drive.ts b/src/server/api/endpoints/charts/user/drive.ts
index 6383ddf2f8..32645b38c6 100644
--- a/src/server/api/endpoints/charts/user/drive.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/user/following.ts b/src/server/api/endpoints/charts/user/following.ts
index 9443b56a40..73f0c1e4f0 100644
--- a/src/server/api/endpoints/charts/user/following.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/user/notes.ts b/src/server/api/endpoints/charts/user/notes.ts
index da642fc761..6a95911b11 100644
--- a/src/server/api/endpoints/charts/user/notes.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/user/reactions.ts b/src/server/api/endpoints/charts/user/reactions.ts
index e440b3ae34..51ff83f20e 100644
--- a/src/server/api/endpoints/charts/user/reactions.ts
+++ b/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) => {
diff --git a/src/server/api/endpoints/charts/users.ts b/src/server/api/endpoints/charts/users.ts
index ea32b7afd8..0b1b18bbe7 100644
--- a/src/server/api/endpoints/charts/users.ts
+++ b/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) => {
-- 
cgit v1.2.3-freya