Mizah/Sharkey
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove endpoint descriptions

Browse source 
#6627
This commit is contained in:
syuilo 2021-06-08 14:09:32 +09:00
parent d6267f797d
commit 6b312f755e
198 changed files with 0 additions and 1904 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/server/api/endpoints/users/followers.ts
View file

@ -7,11 +7,6 @@ import { makePaginationQuery } from '../../common/make-pagination-query';
import { toPunyNullable } from '@/misc/convert-host';
export const meta = {
desc: {
'ja-JP': '指定したユーザーのフォロワー一覧を取得します。',
'en-US': 'Get followers of a user.'
},
tags: ['users'],
requireCredential: false as const,
@ -19,10 +14,6 @@ export const meta = {
params: {
userId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
username: {

9
src/server/api/endpoints/users/following.ts
View file

@ -7,11 +7,6 @@ import { makePaginationQuery } from '../../common/make-pagination-query';
import { toPunyNullable } from '@/misc/convert-host';
export const meta = {
desc: {
'ja-JP': '指定したユーザーのフォロー一覧を取得します。',
'en-US': 'Get following users of a user.'
},
tags: ['users'],
requireCredential: false as const,
@ -19,10 +14,6 @@ export const meta = {
params: {
userId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
username: {

4
src/server/api/endpoints/users/get-frequently-replied-users.ts
View file

@ -15,10 +15,6 @@ export const meta = {
params: {
userId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
limit: {

5
src/server/api/endpoints/users/groups/create.ts
View file

@ -6,11 +6,6 @@ import { UserGroup } from '../../../../../models/entities/user-group';
import { UserGroupJoining } from '../../../../../models/entities/user-group-joining';
export const meta = {
desc: {
'ja-JP': 'ユーザーグループを作成します。',
'en-US': 'Create a user group.'
},
tags: ['groups'],
requireCredential: true as const,

9
src/server/api/endpoints/users/groups/delete.ts
View file

@ -5,11 +5,6 @@ import { ApiError } from '../../../error';
import { UserGroups } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定したユーザーグループを削除します。',
'en-US': 'Delete a user group'
},
tags: ['groups'],
requireCredential: true as const,
@ -19,10 +14,6 @@ export const meta = {
params: {
groupId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象となるユーザーグループのID',
'en-US': 'ID of target user group'
}
}
},

9
src/server/api/endpoints/users/groups/invitations/accept.ts
View file

@ -7,11 +7,6 @@ import { genId } from '@/misc/gen-id';
import { UserGroupJoining } from '../../../../../../models/entities/user-group-joining';
export const meta = {
desc: {
'ja-JP': 'ユーザーグループへの招待を承認します。',
'en-US': 'Accept invitation of a user group.'
},
tags: ['groups', 'users'],
requireCredential: true as const,
@ -21,10 +16,6 @@ export const meta = {
params: {
invitationId: {
validator: $.type(ID),
desc: {
'ja-JP': '招待ID',
'en-US': 'The invitation ID'
}
},
},

9
src/server/api/endpoints/users/groups/invitations/reject.ts
View file

@ -5,11 +5,6 @@ import { ApiError } from '../../../../error';
import { UserGroupInvitations } from '../../../../../../models';
export const meta = {
desc: {
'ja-JP': 'ユーザーグループへの招待を拒否します。',
'en-US': 'Reject invitation of a user group.'
},
tags: ['groups', 'users'],
requireCredential: true as const,
@ -19,10 +14,6 @@ export const meta = {
params: {
invitationId: {
validator: $.type(ID),
desc: {
'ja-JP': '招待ID',
'en-US': 'The invitation ID'
}
},
},

9
src/server/api/endpoints/users/groups/invite.ts
View file

@ -9,11 +9,6 @@ import { UserGroupInvitation } from '../../../../../models/entities/user-group-i
import { createNotification } from '../../../../../services/create-notification';
export const meta = {
desc: {
'ja-JP': '指定したユーザーグループに指定したユーザーを招待します。',
'en-US': 'Invite a user to a user group.'
},
tags: ['groups', 'users'],
requireCredential: true as const,
@ -27,10 +22,6 @@ export const meta = {
userId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
},

4
src/server/api/endpoints/users/groups/joined.ts
View file

@ -3,10 +3,6 @@ import { UserGroups, UserGroupJoinings } from '../../../../../models';
import { Not, In } from 'typeorm';
export const meta = {
desc: {
'ja-JP': '自分の所属するユーザーグループ一覧を取得します。'
},
tags: ['groups', 'account'],
requireCredential: true as const,

4
src/server/api/endpoints/users/groups/owned.ts
View file

@ -2,10 +2,6 @@ import define from '../../../define';
import { UserGroups } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '自分の作成したユーザーグループ一覧を取得します。'
},
tags: ['groups', 'account'],
requireCredential: true as const,

9
src/server/api/endpoints/users/groups/pull.ts
View file

@ -6,11 +6,6 @@ import { getUser } from '../../../common/getters';
import { UserGroups, UserGroupJoinings } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定したユーザーグループから指定したユーザーを削除します。',
'en-US': 'Remove a user to a user group.'
},
tags: ['groups', 'users'],
requireCredential: true as const,
@ -24,10 +19,6 @@ export const meta = {
userId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
},

5
src/server/api/endpoints/users/groups/show.ts
View file

@ -5,11 +5,6 @@ import { ApiError } from '../../../error';
import { UserGroups, UserGroupJoinings } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定したユーザーグループの情報を取得します。',
'en-US': 'Show a user group.'
},
tags: ['groups', 'account'],
requireCredential: true as const,

9
src/server/api/endpoints/users/groups/transfer.ts
View file

@ -6,11 +6,6 @@ import { getUser } from '../../../common/getters';
import { UserGroups, UserGroupJoinings } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定したユーザーグループを指定したユーザーグループ内のユーザーに譲渡します。',
'en-US': 'Transfer user group ownership to another user in group.'
},
tags: ['groups', 'users'],
requireCredential: true as const,
@ -24,10 +19,6 @@ export const meta = {
userId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
},

13
src/server/api/endpoints/users/groups/update.ts
View file

@ -5,11 +5,6 @@ import { ApiError } from '../../../error';
import { UserGroups } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定したユーザーグループを更新します。',
'en-US': 'Update a user group'
},
tags: ['groups'],
requireCredential: true as const,
@ -19,18 +14,10 @@ export const meta = {
params: {
groupId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象となるユーザーグループのID',
'en-US': 'ID of target user group'
}
},
name: {
validator: $.str.range(1, 100),
desc: {
'ja-JP': 'このユーザーグループの名前',
'en-US': 'name of this user group'
}
}
},

5
src/server/api/endpoints/users/lists/create.ts
View file

@ -5,11 +5,6 @@ import { genId } from '@/misc/gen-id';
import { UserList } from '../../../../../models/entities/user-list';
export const meta = {
desc: {
'ja-JP': 'ユーザーリストを作成します。',
'en-US': 'Create a user list'
},
tags: ['lists'],
requireCredential: true as const,

9
src/server/api/endpoints/users/lists/delete.ts
View file

@ -5,11 +5,6 @@ import { ApiError } from '../../../error';
import { UserLists } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定したユーザーリストを削除します。',
'en-US': 'Delete a user list'
},
tags: ['lists'],
requireCredential: true as const,
@ -19,10 +14,6 @@ export const meta = {
params: {
listId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象となるユーザーリストのID',
'en-US': 'ID of target user list'
}
}
},

4
src/server/api/endpoints/users/lists/list.ts
View file

@ -2,10 +2,6 @@ import define from '../../../define';
import { UserLists } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '自分の作成したユーザーリスト一覧を取得します。'
},
tags: ['lists', 'account'],
requireCredential: true as const,

9
src/server/api/endpoints/users/lists/pull.ts
View file

@ -7,11 +7,6 @@ import { getUser } from '../../../common/getters';
import { UserLists, UserListJoinings, Users } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定したユーザーリストから指定したユーザーを削除します。',
'en-US': 'Remove a user to a user list.'
},
tags: ['lists', 'users'],
requireCredential: true as const,
@ -25,10 +20,6 @@ export const meta = {
userId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
},

9
src/server/api/endpoints/users/lists/push.ts
View file

@ -7,11 +7,6 @@ import { pushUserToUserList } from '../../../../../services/user-list/push';
import { UserLists, UserListJoinings } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定したユーザーリストに指定したユーザーを追加します。',
'en-US': 'Add a user to a user list.'
},
tags: ['lists', 'users'],
requireCredential: true as const,
@ -25,10 +20,6 @@ export const meta = {
userId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
},

5
src/server/api/endpoints/users/lists/show.ts
View file

@ -5,11 +5,6 @@ import { ApiError } from '../../../error';
import { UserLists } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定したユーザーリストの情報を取得します。',
'en-US': 'Show a user list.'
},
tags: ['lists', 'account'],
requireCredential: true as const,

13
src/server/api/endpoints/users/lists/update.ts
View file

@ -5,11 +5,6 @@ import { ApiError } from '../../../error';
import { UserLists } from '../../../../../models';
export const meta = {
desc: {
'ja-JP': '指定したユーザーリストを更新します。',
'en-US': 'Update a user list'
},
tags: ['lists'],
requireCredential: true as const,
@ -19,18 +14,10 @@ export const meta = {
params: {
listId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象となるユーザーリストのID',
'en-US': 'ID of target user list'
}
},
name: {
validator: $.str.range(1, 100),
desc: {
'ja-JP': 'このユーザーリストの名前',
'en-US': 'name of this user list'
}
}
},

39
src/server/api/endpoints/users/notes.ts
View file

@ -10,95 +10,56 @@ import { generateMutedUserQuery } from '../../common/generate-muted-user-query';
import { Brackets } from 'typeorm';
export const meta = {
desc: {
'ja-JP': '指定したユーザーのタイムラインを取得します。'
},
tags: ['users', 'notes'],
params: {
userId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
includeReplies: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'リプライを含めるか否か'
}
},
limit: {
validator: $.optional.num.range(1, 100),
default: 10,
desc: {
'ja-JP': '最大数'
}
},
sinceId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより新しい投稿を取得します'
}
},
untilId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより古い投稿を取得します'
}
},
sinceDate: {
validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより新しい投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
},
untilDate: {
validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより古い投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
},
includeMyRenotes: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'Renoteを含めるかどうか'
}
},
withFiles: {
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します'
}
},
fileType: {
validator: $.optional.arr($.str),
desc: {
'ja-JP': '指定された種類のファイルが添付された投稿のみを取得します'
}
},
excludeNsfw: {
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': 'true にすると、NSFW指定されたファイルを除外します(fileTypeが指定されている場合のみ有効)'
}
},
},

4
src/server/api/endpoints/users/recommendation.ts
View file

@ -6,10 +6,6 @@ import { generateMutedUserQueryForUsers } from '../../common/generate-muted-user
import { generateBlockQueryForUsers } from '../../common/generate-block-query';
export const meta = {
desc: {
'ja-JP': 'おすすめのユーザー一覧を取得します。'
},
tags: ['users'],
requireCredential: true as const,

7
src/server/api/endpoints/users/relation.ts
View file

@ -4,10 +4,6 @@ import { ID } from '@/misc/cafy-id';
import { Users } from '../../../../models';
export const meta = {
desc: {
'ja-JP': 'ユーザー間のリレーションを取得します。'
},
tags: ['users'],
requireCredential: true as const,
@ -15,9 +11,6 @@ export const meta = {
params: {
userId: {
validator: $.either($.type(ID), $.arr($.type(ID)).unique()),
desc: {
'ja-JP': 'ユーザーID (配列でも可)'
}
}
},

11
src/server/api/endpoints/users/report-abuse.ts
View file

@ -8,10 +8,6 @@ import { AbuseUserReports, Users } from '../../../../models';
import { genId } from '@/misc/gen-id';
export const meta = {
desc: {
'ja-JP': '指定したユーザーを迷惑なユーザーであると報告します。'
},
tags: ['users'],
requireCredential: true as const,
@ -19,17 +15,10 @@ export const meta = {
params: {
userId: {
validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
comment: {
validator: $.str.range(1, 2048),
desc: {
'ja-JP': '迷惑行為の詳細'
}
},
},

19
src/server/api/endpoints/users/search-by-username-and-host.ts
View file

@ -3,10 +3,6 @@ import define from '../../define';
import { Users } from '../../../../models';
export const meta = {
desc: {
'ja-JP': 'ユーザーを検索します。'
},
tags: ['users'],
requireCredential: false as const,
@ -14,40 +10,25 @@ export const meta = {
params: {
username: {
validator: $.optional.nullable.str,
desc: {
'ja-JP': 'クエリ'
}
},
host: {
validator: $.optional.nullable.str,
desc: {
'ja-JP': 'クエリ'
}
},
offset: {
validator: $.optional.num.min(0),
default: 0,
desc: {
'ja-JP': 'オフセット'
}
},
limit: {
validator: $.optional.num.range(1, 100),
default: 10,
desc: {
'ja-JP': '取得する数'
}
},
detail: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': '詳細なユーザー情報を含めるか否か'
}
},
},

19
src/server/api/endpoints/users/search.ts
View file

@ -4,10 +4,6 @@ import { UserProfiles, Users } from '../../../../models';
import { User } from '../../../../models/entities/user';
export const meta = {
desc: {
'ja-JP': 'ユーザーを検索します。'
},
tags: ['users'],
requireCredential: false as const,
@ -15,41 +11,26 @@ export const meta = {
params: {
query: {
validator: $.str,
desc: {
'ja-JP': 'クエリ'
}
},
offset: {
validator: $.optional.num.min(0),
default: 0,
desc: {
'ja-JP': 'オフセット'
}
},
limit: {
validator: $.optional.num.range(1, 100),
default: 10,
desc: {
'ja-JP': '取得する数'
}
},
localOnly: {
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': 'ローカルユーザーのみ検索対象にするか否か'
}
},
detail: {
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': '詳細なユーザー情報を含めるか否か'
}
},
},

11
src/server/api/endpoints/users/show.ts
View file

@ -9,10 +9,6 @@ import { In } from 'typeorm';
import { User } from '@/models/entities/user';
export const meta = {
desc: {
'ja-JP': '指定したユーザーの情報を取得します。'
},
tags: ['users'],
requireCredential: false as const,
@ -20,17 +16,10 @@ export const meta = {
params: {
userId: {
validator: $.optional.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
userIds: {
validator: $.optional.arr($.type(ID)).unique(),
desc: {
'ja-JP': 'ユーザーID (配列)'
}
},
username: {