From a515c1f53ebcb8eba0c20b1f7951573d2ca7809e Mon Sep 17 00:00:00 2001
From: syuilo <syuilotan@yahoo.co.jp>
Date: Sat, 3 Nov 2018 22:49:36 +0900
Subject: Improve API documentation

---
 src/server/api/endpoints/users/followers.ts                    | 4 ++++
 src/server/api/endpoints/users/following.ts                    | 4 ++++
 src/server/api/endpoints/users/get_frequently_replied_users.ts | 4 ++++
 src/server/api/endpoints/users/lists/push.ts                   | 4 ++++
 src/server/api/endpoints/users/notes.ts                        | 3 ++-
 src/server/api/endpoints/users/show.ts                         | 3 ++-
 6 files changed, 20 insertions(+), 2 deletions(-)

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

diff --git a/src/server/api/endpoints/users/followers.ts b/src/server/api/endpoints/users/followers.ts
index 9e3a30f6f1..e7f74b0651 100644
--- a/src/server/api/endpoints/users/followers.ts
+++ b/src/server/api/endpoints/users/followers.ts
@@ -17,6 +17,10 @@ export const meta = {
 		userId: {
 			validator: $.type(ID),
 			transform: transform,
+			desc: {
+				'ja-JP': '対象のユーザーのID',
+				'en-US': 'Target user ID'
+			}
 		},
 
 		limit: {
diff --git a/src/server/api/endpoints/users/following.ts b/src/server/api/endpoints/users/following.ts
index 57bf1e1e8b..371a54f901 100644
--- a/src/server/api/endpoints/users/following.ts
+++ b/src/server/api/endpoints/users/following.ts
@@ -17,6 +17,10 @@ export const meta = {
 		userId: {
 			validator: $.type(ID),
 			transform: transform,
+			desc: {
+				'ja-JP': '対象のユーザーのID',
+				'en-US': 'Target user ID'
+			}
 		},
 
 		limit: {
diff --git a/src/server/api/endpoints/users/get_frequently_replied_users.ts b/src/server/api/endpoints/users/get_frequently_replied_users.ts
index 6b8b985eea..cf123b82ba 100644
--- a/src/server/api/endpoints/users/get_frequently_replied_users.ts
+++ b/src/server/api/endpoints/users/get_frequently_replied_users.ts
@@ -10,6 +10,10 @@ export const meta = {
 		userId: {
 			validator: $.type(ID),
 			transform: transform,
+			desc: {
+				'ja-JP': '対象のユーザーのID',
+				'en-US': 'Target user ID'
+			}
 		},
 
 		limit: {
diff --git a/src/server/api/endpoints/users/lists/push.ts b/src/server/api/endpoints/users/lists/push.ts
index 5c11f25dc4..396f9813a4 100644
--- a/src/server/api/endpoints/users/lists/push.ts
+++ b/src/server/api/endpoints/users/lists/push.ts
@@ -26,6 +26,10 @@ export const meta = {
 		userId: {
 			validator: $.type(ID),
 			transform: transform,
+			desc: {
+				'ja-JP': '対象のユーザーのID',
+				'en-US': 'Target user ID'
+			}
 		},
 	}
 };
diff --git a/src/server/api/endpoints/users/notes.ts b/src/server/api/endpoints/users/notes.ts
index 4bbacab2bf..7901ac1de1 100644
--- a/src/server/api/endpoints/users/notes.ts
+++ b/src/server/api/endpoints/users/notes.ts
@@ -15,7 +15,8 @@ export const meta = {
 			validator: $.type(ID).optional,
 			transform: transform,
 			desc: {
-				'ja-JP': 'ユーザーID'
+				'ja-JP': '対象のユーザーのID',
+				'en-US': 'Target user ID'
 			}
 		},
 
diff --git a/src/server/api/endpoints/users/show.ts b/src/server/api/endpoints/users/show.ts
index 93223b3f9f..6e4cf514de 100644
--- a/src/server/api/endpoints/users/show.ts
+++ b/src/server/api/endpoints/users/show.ts
@@ -17,7 +17,8 @@ export const meta = {
 			validator: $.type(ID).optional,
 			transform: transform,
 			desc: {
-				'ja-JP': 'ユーザーID'
+				'ja-JP': '対象のユーザーのID',
+				'en-US': 'Target user ID'
 			}
 		},
 
-- 
cgit v1.2.3-freya