Update api definitions

5 files changed, 53 insertions, 12 deletions

diff --git a/src/server/api/endpoints/users/lists/create.ts b/src/server/api/endpoints/users/lists/create.ts
index f3776afee0..d7dc2a5f70 100644
--- a/src/server/api/endpoints/users/lists/create.ts
+++ b/src/server/api/endpoints/users/lists/create.ts
@@ -2,9 +2,17 @@ import $ from 'cafy';
 import UserList, { pack } from '../../../../../models/user-list';
 import { ILocalUser } from '../../../../../models/user';
 
-/**
- * Create a user list
- */
+export const meta = {
+	desc: {
+		ja: 'ユーザーリストを作成します。',
+		en: 'Create a user list'
+	},
+
+	requireCredential: true,
+
+	kind: 'account-write'
+};
+
 export default async (params: any, user: ILocalUser) => new Promise(async (res, rej) => {
 	// Get 'title' parameter
 	const [title, titleErr] = $.str.range(1, 100).get(params.title);
diff --git a/src/server/api/endpoints/users/lists/list.ts b/src/server/api/endpoints/users/lists/list.ts
index 88fa75a111..31fef26bdc 100644
--- a/src/server/api/endpoints/users/lists/list.ts
+++ b/src/server/api/endpoints/users/lists/list.ts
@@ -1,9 +1,16 @@
 import UserList, { pack } from '../../../../../models/user-list';
 import { ILocalUser } from '../../../../../models/user';
 
-/**
- * Add a user to a user list
- */
+export const meta = {
+	desc: {
+		ja: '自分の作成したユーザーリスト一覧を取得します。'
+	},
+
+	requireCredential: true,
+
+	kind: 'account-read'
+};
+
 export default async (params: any, me: ILocalUser) => new Promise(async (res, rej) => {
 	// Fetch lists
 	const userLists = await UserList.find({
diff --git a/src/server/api/endpoints/users/lists/push.ts b/src/server/api/endpoints/users/lists/push.ts
index 9e99d59fc1..bd4e201bde 100644
--- a/src/server/api/endpoints/users/lists/push.ts
+++ b/src/server/api/endpoints/users/lists/push.ts
@@ -6,6 +6,17 @@ import ap from '../../../../../remote/activitypub/renderer';
 import renderFollow from '../../../../../remote/activitypub/renderer/follow';
 import { deliver } from '../../../../../queue';
 
+export const meta = {
+	desc: {
+		ja: '指定したユーザーリストに指定したユーザーを追加します。',
+		en: 'Add a user to a user list.'
+	},
+
+	requireCredential: true,
+
+	kind: 'account-write'
+};
+
 /**
  * Add a user to a user list
  */
diff --git a/src/server/api/endpoints/users/lists/show.ts b/src/server/api/endpoints/users/lists/show.ts
index f432cf44fb..2fd142a609 100644
--- a/src/server/api/endpoints/users/lists/show.ts
+++ b/src/server/api/endpoints/users/lists/show.ts
@@ -2,9 +2,17 @@ import $ from 'cafy'; import ID from '../../../../../misc/cafy-id';
 import UserList, { pack } from '../../../../../models/user-list';
 import { ILocalUser } from '../../../../../models/user';
 
-/**
- * Show a user list
- */
+export const meta = {
+	desc: {
+		ja: '指定したユーザーリストの情報を取得します。',
+		en: 'Show a user list.'
+	},
+
+	requireCredential: true,
+
+	kind: 'account-read'
+};
+
 export default async (params: any, me: ILocalUser) => new Promise(async (res, rej) => {
 	// Get 'listId' parameter
 	const [listId, listIdErr] = $.type(ID).get(params.listId);
diff --git a/src/server/api/endpoints/users/recommendation.ts b/src/server/api/endpoints/users/recommendation.ts
index b7402b7fb1..13377e6fff 100644
--- a/src/server/api/endpoints/users/recommendation.ts
+++ b/src/server/api/endpoints/users/recommendation.ts
@@ -4,9 +4,16 @@ import User, { pack, ILocalUser } from '../../../../models/user';
 import { getFriendIds } from '../../common/get-friends';
 import Mute from '../../../../models/mute';
 
-/**
- * Get recommended users
- */
+export const meta = {
+	desc: {
+		ja: 'おすすめのユーザー一覧を取得します。'
+	},
+
+	requireCredential: true,
+
+	kind: 'account-read'
+};
+
 export default (params: any, me: ILocalUser) => new Promise(async (res, rej) => {
 	// Get 'limit' parameter
 	const [limit = 10, limitErr] = $.num.optional.range(1, 100).get(params.limit);