Remove endpoint descriptions

#6627
This commit is contained in:
syuilo 2021-06-08 14:09:32 +09:00
parent 8485447296
commit dceb64944c
198 changed files with 0 additions and 1904 deletions

View file

@ -8,15 +8,12 @@ export type Param = {
transform?: any; transform?: any;
default?: any; default?: any;
deprecated?: boolean; deprecated?: boolean;
desc?: { [key: string]: string };
ref?: string; ref?: string;
}; };
export interface IEndpointMeta { export interface IEndpointMeta {
stability?: string; //'deprecated' | 'experimental' | 'stable'; stability?: string; //'deprecated' | 'experimental' | 'stable';
desc?: { [key: string]: string };
tags?: string[]; tags?: string[];
params?: { params?: {

View file

@ -5,11 +5,6 @@ import { AbuseUserReports } from '../../../../models';
import { makePaginationQuery } from '../../common/make-pagination-query'; import { makePaginationQuery } from '../../common/make-pagination-query';
export const meta = { export const meta = {
desc: {
'ja-JP': '通報一覧を表示します。',
'en-US': 'Show list of abuse user reports.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -3,11 +3,6 @@ import { Users } from '../../../../../models';
import { signup } from '../../../common/signup'; import { signup } from '../../../common/signup';
export const meta = { export const meta = {
desc: {
'ja-JP': 'アカウントを作成します。',
'en-US': 'Create a account.'
},
tags: ['admin'], tags: ['admin'],
params: { params: {

View file

@ -4,11 +4,6 @@ import { Announcements } from '../../../../../models';
import { genId } from '@/misc/gen-id'; import { genId } from '@/misc/gen-id';
export const meta = { export const meta = {
desc: {
'ja-JP': 'アナウンスを作成します。',
'en-US': 'Create a announcement.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -10,11 +10,6 @@ export const meta = {
requireCredential: true as const, requireCredential: true as const,
requireModerator: true, requireModerator: true,
desc: {
'ja-JP': 'アナウンスを削除します。',
'en-US': 'Delete a announcement.'
},
params: { params: {
id: { id: {
validator: $.type(ID) validator: $.type(ID)

View file

@ -5,11 +5,6 @@ import { Announcements, AnnouncementReads } from '../../../../../models';
import { makePaginationQuery } from '../../../common/make-pagination-query'; import { makePaginationQuery } from '../../../common/make-pagination-query';
export const meta = { export const meta = {
desc: {
'ja-JP': 'アナウンスのリストを表示します。',
'en-US': 'List announcements.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -5,11 +5,6 @@ import { Announcements } from '../../../../../models';
import { ApiError } from '../../../error'; import { ApiError } from '../../../error';
export const meta = { export const meta = {
desc: {
'ja-JP': 'アナウンスの内容を変更します。',
'en-US': 'Update a annoucement.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -5,11 +5,6 @@ import { DriveFiles } from '../../../../models';
import { ID } from '@/misc/cafy-id'; import { ID } from '@/misc/cafy-id';
export const meta = { export const meta = {
desc: {
'ja-JP': '対象のユーザーのファイルを全て削除します。',
'en-US': 'Delete all files to specified user.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,
@ -18,10 +13,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーID',
'en-US': 'The user ID which you want to suspend'
}
}, },
} }
}; };

View file

@ -2,11 +2,6 @@ import define from '../../define';
import { Logs } from '../../../../models'; import { Logs } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ログを全て削除します。',
'en-US': 'Delete all logs.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -2,11 +2,6 @@ import define from '../../../define';
import { createCleanRemoteFilesJob } from '../../../../../queue'; import { createCleanRemoteFilesJob } from '../../../../../queue';
export const meta = { export const meta = {
desc: {
'ja-JP': 'キャッシュされたリモートファイルをすべて削除します。',
'en-US': 'Deletes all cached remote files.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -4,11 +4,6 @@ import { deleteFile } from '../../../../../services/drive/delete-file';
import { DriveFiles } from '../../../../../models'; import { DriveFiles } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '使用されていないユーザーのファイルを削除します。',
'en-US': 'Delete the unused user\'s files.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -5,11 +5,6 @@ import { makePaginationQuery } from '../../../common/make-pagination-query';
import { ID } from '@/misc/cafy-id'; import { ID } from '@/misc/cafy-id';
export const meta = { export const meta = {
desc: {
'ja-JP': '管理用のドライブの一覧を表示します。',
'en-US': 'Displays a list of management drives.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: false as const, requireCredential: false as const,

View file

@ -10,10 +10,6 @@ import rndstr from 'rndstr';
import { publishBroadcastStream } from '../../../../../services/stream'; import { publishBroadcastStream } from '../../../../../services/stream';
export const meta = { export const meta = {
desc: {
'ja-JP': 'カスタム絵文字を追加します。'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -9,11 +9,6 @@ import { ID } from '@/misc/cafy-id';
import uploadFromUrl from '../../../../../services/drive/upload-from-url'; import uploadFromUrl from '../../../../../services/drive/upload-from-url';
export const meta = { export const meta = {
desc: {
'ja-JP': '選択したカスタム絵文字をコピーします。',
'en-US': 'Copies the selected custom emoji.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -6,11 +6,6 @@ import { makePaginationQuery } from '../../../common/make-pagination-query';
import { ID } from '@/misc/cafy-id'; import { ID } from '@/misc/cafy-id';
export const meta = { export const meta = {
desc: {
'ja-JP': 'リモートのカスタム絵文字一覧を取得します。',
'en-US': 'Gets a list of remote custom emojis.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -6,11 +6,6 @@ import { ID } from '@/misc/cafy-id';
import { Emoji } from '../../../../../models/entities/emoji'; import { Emoji } from '../../../../../models/entities/emoji';
export const meta = { export const meta = {
desc: {
'ja-JP': 'カスタム絵文字一覧を取得します。',
'en-US': 'List custom emojis.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -7,10 +7,6 @@ import { insertModerationLog } from '../../../../../services/insert-moderation-l
import { ApiError } from '../../../error'; import { ApiError } from '../../../error';
export const meta = { export const meta = {
desc: {
'ja-JP': 'カスタム絵文字を削除します。'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -6,10 +6,6 @@ import { getConnection } from 'typeorm';
import { ApiError } from '../../../error'; import { ApiError } from '../../../error';
export const meta = { export const meta = {
desc: {
'ja-JP': 'カスタム絵文字を更新します。'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -4,11 +4,6 @@ import { deleteFile } from '../../../../../services/drive/delete-file';
import { DriveFiles } from '../../../../../models'; import { DriveFiles } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したドメインのファイルを全て削除します。',
'en-US': 'Deletes all files in the specified domain.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -4,11 +4,6 @@ import deleteFollowing from '../../../../../services/following/delete';
import { Followings, Users } from '../../../../../models'; import { Followings, Users } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したドメインの全ユーザーのフォローを全て解除します。',
'en-US': 'Unfollow all users in the specified domain.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -4,11 +4,6 @@ import { Instances } from '../../../../../models';
import { toPuny } from '@/misc/convert-host'; import { toPuny } from '@/misc/convert-host';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したドメインのアクティビティの配信を停止するかを選択します。',
'en-US': 'Select whether to undeliver the activity for the specified domain.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -5,11 +5,6 @@ export const meta = {
requireCredential: true as const, requireCredential: true as const,
requireModerator: true, requireModerator: true,
desc: {
'ja-JP': 'テーブル情報を取得します。',
'en-US': 'Get table stats'
},
tags: ['admin'], tags: ['admin'],
params: { params: {

View file

@ -4,11 +4,6 @@ import { RegistrationTickets } from '../../../../models';
import { genId } from '@/misc/gen-id'; import { genId } from '@/misc/gen-id';
export const meta = { export const meta = {
desc: {
'ja-JP': '招待コードを発行します。',
'en-US': 'Issue an invitation code.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -4,11 +4,6 @@ import { Logs } from '../../../../models';
import { Brackets } from 'typeorm'; import { Brackets } from 'typeorm';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ログを表示します。',
'en-US': 'Show logs.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -4,11 +4,6 @@ import define from '../../../define';
import { Users } from '../../../../../models'; import { Users } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーをモデレーターにします。',
'en-US': 'Mark a user as moderator.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,
@ -17,10 +12,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーID',
'en-US': 'The user ID'
}
}, },
} }
}; };

View file

@ -4,11 +4,6 @@ import define from '../../../define';
import { Users } from '../../../../../models'; import { Users } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーをモデレーター解除します。',
'en-US': 'Unmark a user as moderator.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,
@ -17,10 +12,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーID',
'en-US': 'The user ID'
}
}, },
} }
}; };

View file

@ -6,11 +6,6 @@ import { getNote } from '../../../common/getters';
import { PromoNotes } from '../../../../../models'; import { PromoNotes } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': 'プロモーションを作成します。',
'en-US': 'Create a promotion.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -3,11 +3,6 @@ import { destroy } from '../../../../../queue';
import { insertModerationLog } from '../../../../../services/insert-moderation-log'; import { insertModerationLog } from '../../../../../services/insert-moderation-log';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ジョブキューを全て削除します。',
'en-US': 'Delete all job queues.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -3,11 +3,6 @@ import { URL } from 'url';
import define from '../../../define'; import define from '../../../define';
export const meta = { export const meta = {
desc: {
'ja-JP': '他サーバーへ送るキューの遅延一覧を返します。',
'en-US': 'Returns a list of delays in queues sent to other servers.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -3,11 +3,6 @@ import define from '../../../define';
import { inboxQueue } from '../../../../../queue'; import { inboxQueue } from '../../../../../queue';
export const meta = { export const meta = {
desc: {
'ja-JP': 'このサーバーへのキューの遅延一覧を返します。',
'en-US': 'Returns a list of queue delays to this server.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -3,11 +3,6 @@ import $ from 'cafy';
import define from '../../../define'; import define from '../../../define';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ジョブ一覧を表示します。',
'en-US': 'Display the job list.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -2,11 +2,6 @@ import { deliverQueue, inboxQueue, dbQueue, objectStorageQueue } from '@/queue/q
import define from '../../../define'; import define from '../../../define';
export const meta = { export const meta = {
desc: {
'ja-JP': 'キューの状態を返します。',
'en-US': 'Returns the status of the queue.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -5,11 +5,6 @@ import { addRelay } from '../../../../../services/relay';
import { ApiError } from '../../../error'; import { ApiError } from '../../../error';
export const meta = { export const meta = {
desc: {
'ja-JP': 'リレーを追加します。',
'en-US': 'Add relay'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -2,11 +2,6 @@ import define from '../../../define';
import { listRelay } from '../../../../../services/relay'; import { listRelay } from '../../../../../services/relay';
export const meta = { export const meta = {
desc: {
'ja-JP': 'リレー一覧を表示します。',
'en-US': 'List relay'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -3,11 +3,6 @@ import define from '../../../define';
import { removeRelay } from '../../../../../services/relay'; import { removeRelay } from '../../../../../services/relay';
export const meta = { export const meta = {
desc: {
'ja-JP': 'リレーを削除します。',
'en-US': 'Remove relay'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -6,11 +6,6 @@ import rndstr from 'rndstr';
import { Users, UserProfiles } from '../../../../models'; import { Users, UserProfiles } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーのパスワードをリセットします。',
'en-US': 'Reset password to specified user.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,
@ -19,10 +14,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーID',
'en-US': 'The user ID which you want to suspend'
}
}, },
}, },

View file

@ -4,11 +4,6 @@ import define from '../../define';
import { AbuseUserReports } from '../../../../models'; import { AbuseUserReports } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定した通報を解決済みにします。',
'en-US': 'Marks the specified report as resolved.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -3,11 +3,6 @@ import { driveChart, notesChart, usersChart, instanceChart } from '../../../../s
import { insertModerationLog } from '../../../../services/insert-moderation-log'; import { insertModerationLog } from '../../../../services/insert-moderation-log';
export const meta = { export const meta = {
desc: {
'ja-JP': 'チャートを再同期します。',
'en-US': 'Resync the chart.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -3,11 +3,6 @@ import define from '../../define';
import { sendEmail } from '../../../../services/send-email'; import { sendEmail } from '../../../../services/send-email';
export const meta = { export const meta = {
desc: {
'ja-JP': 'メールを送信します。',
'en-US': 'Send a mail.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -8,11 +8,6 @@ export const meta = {
requireCredential: true as const, requireCredential: true as const,
requireModerator: true, requireModerator: true,
desc: {
'ja-JP': 'サーバー情報を表示します。',
'en-US': 'Show server information.'
},
tags: ['admin', 'meta'], tags: ['admin', 'meta'],
params: { params: {

View file

@ -5,11 +5,6 @@ import { ModerationLogs } from '../../../../models';
import { makePaginationQuery } from '../../common/make-pagination-query'; import { makePaginationQuery } from '../../common/make-pagination-query';
export const meta = { export const meta = {
desc: {
'ja-JP': 'モデレーションログ一覧を表示します。',
'en-US': 'Display the moderation log list.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -4,11 +4,6 @@ import define from '../../define';
import { Users } from '../../../../models'; import { Users } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーの情報を取得します(管理者向け)。',
'en-US': 'Gets the information of the specified user (for administrators).'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,
@ -17,10 +12,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーID',
'en-US': 'The user ID which you want to suspend'
}
}, },
}, },

View file

@ -3,11 +3,6 @@ import define from '../../define';
import { Users } from '../../../../models'; import { Users } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '管理者用のユーザー一覧を表示します。',
'en-US': 'Displays a list of users for administrators.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -5,11 +5,6 @@ import { Users } from '../../../../models';
import { insertModerationLog } from '../../../../services/insert-moderation-log'; import { insertModerationLog } from '../../../../services/insert-moderation-log';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーをサイレンスにします。',
'en-US': 'Make silence a user.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,
@ -18,10 +13,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーID',
'en-US': 'The user ID which you want to make silence'
}
}, },
} }
}; };

View file

@ -8,11 +8,6 @@ import { insertModerationLog } from '../../../../services/insert-moderation-log'
import { doPostSuspend } from '../../../../services/suspend-user'; import { doPostSuspend } from '../../../../services/suspend-user';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーを凍結します。',
'en-US': 'Suspend a user.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,
@ -21,10 +16,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーID',
'en-US': 'The user ID which you want to suspend'
}
}, },
} }
}; };

View file

@ -5,11 +5,6 @@ import { Users } from '../../../../models';
import { insertModerationLog } from '../../../../services/insert-moderation-log'; import { insertModerationLog } from '../../../../services/insert-moderation-log';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーのサイレンスを解除します。',
'en-US': 'Unsilence a user.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,
@ -18,10 +13,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーID',
'en-US': 'The user ID which you want to unsilence'
}
}, },
} }
}; };

View file

@ -6,11 +6,6 @@ import { insertModerationLog } from '../../../../services/insert-moderation-log'
import { doPostUnsuspend } from '../../../../services/unsuspend-user'; import { doPostUnsuspend } from '../../../../services/unsuspend-user';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーの凍結を解除します。',
'en-US': 'Unsuspend a user.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,
@ -19,10 +14,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーID',
'en-US': 'The user ID which you want to unsuspend'
}
}, },
} }
}; };

View file

@ -7,10 +7,6 @@ import { DB_MAX_NOTE_TEXT_LENGTH } from '@/misc/hard-limits';
import { ID } from '@/misc/cafy-id'; import { ID } from '@/misc/cafy-id';
export const meta = { export const meta = {
desc: {
'ja-JP': 'インスタンスの設定を更新します。'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,
@ -19,79 +15,46 @@ export const meta = {
params: { params: {
disableRegistration: { disableRegistration: {
validator: $.optional.nullable.bool, validator: $.optional.nullable.bool,
desc: {
'ja-JP': '招待制か否か'
}
}, },
disableLocalTimeline: { disableLocalTimeline: {
validator: $.optional.nullable.bool, validator: $.optional.nullable.bool,
desc: {
'ja-JP': 'ローカルタイムライン(とソーシャルタイムライン)を無効にするか否か'
}
}, },
disableGlobalTimeline: { disableGlobalTimeline: {
validator: $.optional.nullable.bool, validator: $.optional.nullable.bool,
desc: {
'ja-JP': 'グローバルタイムラインを無効にするか否か'
}
}, },
useStarForReactionFallback: { useStarForReactionFallback: {
validator: $.optional.nullable.bool, validator: $.optional.nullable.bool,
desc: {
'ja-JP': '不明なリアクションのフォールバックに star リアクションを使うか'
}
}, },
pinnedUsers: { pinnedUsers: {
validator: $.optional.nullable.arr($.str), validator: $.optional.nullable.arr($.str),
desc: {
'ja-JP': 'ピン留めユーザー'
}
}, },
hiddenTags: { hiddenTags: {
validator: $.optional.nullable.arr($.str), validator: $.optional.nullable.arr($.str),
desc: {
'ja-JP': '統計などで無視するハッシュタグ'
}
}, },
blockedHosts: { blockedHosts: {
validator: $.optional.nullable.arr($.str), validator: $.optional.nullable.arr($.str),
desc: {
'ja-JP': 'ブロックするホスト'
}
}, },
mascotImageUrl: { mascotImageUrl: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'インスタンスキャラクター画像のURL'
}
}, },
bannerUrl: { bannerUrl: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'インスタンスのバナー画像URL'
}
}, },
errorImageUrl: { errorImageUrl: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'インスタンスのエラー画像URL'
}
}, },
iconUrl: { iconUrl: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'インスタンスのアイコンURL'
}
}, },
backgroundImageUrl: { backgroundImageUrl: {
@ -104,116 +67,66 @@ export const meta = {
name: { name: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'インスタンス名'
}
}, },
description: { description: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'インスタンスの紹介文'
}
}, },
maxNoteTextLength: { maxNoteTextLength: {
validator: $.optional.num.min(0).max(DB_MAX_NOTE_TEXT_LENGTH), validator: $.optional.num.min(0).max(DB_MAX_NOTE_TEXT_LENGTH),
desc: {
'ja-JP': '投稿の最大文字数'
}
}, },
localDriveCapacityMb: { localDriveCapacityMb: {
validator: $.optional.num.min(0), validator: $.optional.num.min(0),
desc: {
'ja-JP': 'ローカルユーザーひとりあたりのドライブ容量 (メガバイト単位)',
'en-US': 'Drive capacity of a local user (MB)'
}
}, },
remoteDriveCapacityMb: { remoteDriveCapacityMb: {
validator: $.optional.num.min(0), validator: $.optional.num.min(0),
desc: {
'ja-JP': 'リモートユーザーひとりあたりのドライブ容量 (メガバイト単位)',
'en-US': 'Drive capacity of a remote user (MB)'
}
}, },
cacheRemoteFiles: { cacheRemoteFiles: {
validator: $.optional.bool, validator: $.optional.bool,
desc: {
'ja-JP': 'リモートのファイルをキャッシュするか否か'
}
}, },
proxyRemoteFiles: { proxyRemoteFiles: {
validator: $.optional.bool, validator: $.optional.bool,
desc: {
'ja-JP': 'ローカルにないリモートのファイルをプロキシするか否か'
}
}, },
enableHcaptcha: { enableHcaptcha: {
validator: $.optional.bool, validator: $.optional.bool,
desc: {
'ja-JP': 'hCaptchaを使用するか否か'
}
}, },
hcaptchaSiteKey: { hcaptchaSiteKey: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'hCaptcha site key'
}
}, },
hcaptchaSecretKey: { hcaptchaSecretKey: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'hCaptcha secret key'
}
}, },
enableRecaptcha: { enableRecaptcha: {
validator: $.optional.bool, validator: $.optional.bool,
desc: {
'ja-JP': 'reCAPTCHAを使用するか否か'
}
}, },
recaptchaSiteKey: { recaptchaSiteKey: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'reCAPTCHA site key'
}
}, },
recaptchaSecretKey: { recaptchaSecretKey: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'reCAPTCHA secret key'
}
}, },
proxyAccountId: { proxyAccountId: {
validator: $.optional.nullable.type(ID), validator: $.optional.nullable.type(ID),
desc: {
'ja-JP': 'プロキシアカウントのID'
}
}, },
maintainerName: { maintainerName: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'インスタンスの管理者名'
}
}, },
maintainerEmail: { maintainerEmail: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'インスタンス管理者の連絡先メールアドレス'
}
}, },
pinnedPages: { pinnedPages: {
@ -226,170 +139,98 @@ export const meta = {
langs: { langs: {
validator: $.optional.arr($.str), validator: $.optional.arr($.str),
desc: {
'ja-JP': 'インスタンスの対象言語'
}
}, },
summalyProxy: { summalyProxy: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'summalyプロキシURL'
}
}, },
enableTwitterIntegration: { enableTwitterIntegration: {
validator: $.optional.bool, validator: $.optional.bool,
desc: {
'ja-JP': 'Twitter連携機能を有効にするか否か'
}
}, },
twitterConsumerKey: { twitterConsumerKey: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'TwitterアプリのConsumer key'
}
}, },
twitterConsumerSecret: { twitterConsumerSecret: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'TwitterアプリのConsumer secret'
}
}, },
enableGithubIntegration: { enableGithubIntegration: {
validator: $.optional.bool, validator: $.optional.bool,
desc: {
'ja-JP': 'GitHub連携機能を有効にするか否か'
}
}, },
githubClientId: { githubClientId: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'GitHubアプリのClient ID'
}
}, },
githubClientSecret: { githubClientSecret: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'GitHubアプリのClient Secret'
}
}, },
enableDiscordIntegration: { enableDiscordIntegration: {
validator: $.optional.bool, validator: $.optional.bool,
desc: {
'ja-JP': 'Discord連携機能を有効にするか否か'
}
}, },
discordClientId: { discordClientId: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'DiscordアプリのClient ID'
}
}, },
discordClientSecret: { discordClientSecret: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'DiscordアプリのClient Secret'
}
}, },
enableEmail: { enableEmail: {
validator: $.optional.bool, validator: $.optional.bool,
desc: {
'ja-JP': 'メール配信を有効にするか否か'
}
}, },
email: { email: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'メール配信する際に利用するメールアドレス'
}
}, },
smtpSecure: { smtpSecure: {
validator: $.optional.bool, validator: $.optional.bool,
desc: {
'ja-JP': 'SMTPサーバがSSLを使用しているか否か'
}
}, },
smtpHost: { smtpHost: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'SMTPサーバのホスト'
}
}, },
smtpPort: { smtpPort: {
validator: $.optional.nullable.num, validator: $.optional.nullable.num,
desc: {
'ja-JP': 'SMTPサーバのポート'
}
}, },
smtpUser: { smtpUser: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'SMTPサーバのユーザー名'
}
}, },
smtpPass: { smtpPass: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'SMTPサーバのパスワード'
}
}, },
enableServiceWorker: { enableServiceWorker: {
validator: $.optional.bool, validator: $.optional.bool,
desc: {
'ja-JP': 'ServiceWorkerを有効にするか否か'
}
}, },
swPublicKey: { swPublicKey: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'ServiceWorkerのVAPIDキーペアの公開鍵'
}
}, },
swPrivateKey: { swPrivateKey: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': 'ServiceWorkerのVAPIDキーペアの秘密鍵'
}
}, },
tosUrl: { tosUrl: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
desc: {
'ja-JP': '利用規約のURL'
}
}, },
repositoryUrl: { repositoryUrl: {
validator: $.optional.str, validator: $.optional.str,
desc: {
'ja-JP': 'リポジトリのURL'
}
}, },
feedbackUrl: { feedbackUrl: {
validator: $.optional.str, validator: $.optional.str,
desc: {
'ja-JP': 'フィードバックのURL'
}
}, },
useObjectStorage: { useObjectStorage: {

View file

@ -4,11 +4,6 @@ import { getConnection } from 'typeorm';
import { insertModerationLog } from '../../../../services/insert-moderation-log'; import { insertModerationLog } from '../../../../services/insert-moderation-log';
export const meta = { export const meta = {
desc: {
'ja-JP': 'データベースのメンテナンスを行います。',
'en-US': 'Perform database maintenance.'
},
tags: ['admin'], tags: ['admin'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -5,11 +5,6 @@ import { Announcements, AnnouncementReads } from '../../../models';
import { makePaginationQuery } from '../common/make-pagination-query'; import { makePaginationQuery } from '../common/make-pagination-query';
export const meta = { export const meta = {
desc: {
'ja-JP': 'アナウンスを表示します。',
'en-US': 'Show announcements.'
},
tags: ['meta'], tags: ['meta'],
requireCredential: false as const, requireCredential: false as const,

View file

@ -7,11 +7,6 @@ import { ApiError } from '../../error';
import { publishInternalEvent } from '../../../../services/stream'; import { publishInternalEvent } from '../../../../services/stream';
export const meta = { export const meta = {
desc: {
'ja-JP': 'アンテナを作成します。',
'en-US': 'Create a antenna.'
},
tags: ['antennas'], tags: ['antennas'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -6,11 +6,6 @@ import { Antennas } from '../../../../models';
import { publishInternalEvent } from '../../../../services/stream'; import { publishInternalEvent } from '../../../../services/stream';
export const meta = { export const meta = {
desc: {
'ja-JP': 'アンテナを削除します。',
'en-US': 'Delete a antenna.'
},
tags: ['antennas'], tags: ['antennas'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -2,11 +2,6 @@ import define from '../../define';
import { Antennas } from '../../../../models'; import { Antennas } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': 'アンテナの一覧を取得します。',
'en-US': 'Get a list of antennas.'
},
tags: ['antennas', 'account'], tags: ['antennas', 'account'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -8,11 +8,6 @@ import { generateMutedUserQuery } from '../../common/generate-muted-user-query';
import { ApiError } from '../../error'; import { ApiError } from '../../error';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したアンテナのノート一覧を表示します。',
'en-US': 'Displays a list of notes for the specified antenna.'
},
tags: ['antennas', 'account', 'notes'], tags: ['antennas', 'account', 'notes'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -5,11 +5,6 @@ import { ApiError } from '../../error';
import { Antennas } from '../../../../models'; import { Antennas } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したアンテナの情報を取得します。',
'en-US': 'Acquires the information of the specified antenna.'
},
tags: ['antennas', 'account'], tags: ['antennas', 'account'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -6,11 +6,6 @@ import { Antennas, UserLists, UserGroupJoinings } from '../../../../models';
import { publishInternalEvent } from '../../../../services/stream'; import { publishInternalEvent } from '../../../../services/stream';
export const meta = { export const meta = {
desc: {
'ja-JP': 'アンテナの情報を更新します。',
'en-US': 'Updates the information of the specified antenna.'
},
tags: ['antennas'], tags: ['antennas'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -6,19 +6,11 @@ import { ApiError } from '../../error';
export const meta = { export const meta = {
tags: ['federation'], tags: ['federation'],
desc: {
'ja-JP': 'URIを指定してActivityPubオブジェクトを参照します。',
'en-US': 'Browse to the ActivityPub object by specifying the URI.'
},
requireCredential: false as const, requireCredential: false as const,
params: { params: {
uri: { uri: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': 'ActivityPubオブジェクトのURI'
}
}, },
}, },

View file

@ -15,19 +15,11 @@ import { isActor, isPost, getApId } from '../../../../remote/activitypub/type';
export const meta = { export const meta = {
tags: ['federation'], tags: ['federation'],
desc: {
'ja-JP': 'URIを指定してActivityPubオブジェクトを参照します。',
'en-US': 'Browse to the ActivityPub object by specifying the URI.'
},
requireCredential: false as const, requireCredential: false as const,
params: { params: {
uri: { uri: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': 'ActivityPubオブジェクトのURI'
}
}, },
}, },

View file

@ -10,44 +10,23 @@ export const meta = {
requireCredential: false as const, requireCredential: false as const,
desc: {
'ja-JP': 'アプリを作成します。',
'en-US': 'Create a application.'
},
params: { params: {
name: { name: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': 'アプリの名前',
'en-US': 'Name of application'
}
}, },
description: { description: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': 'アプリの説明',
'en-US': 'Description of application'
}
}, },
permission: { permission: {
validator: $.arr($.str).unique(), validator: $.arr($.str).unique(),
desc: {
'ja-JP': 'このアプリに割り当てる権限(権限については"Permissions"を参照)',
'en-US': 'Permissions assigned to this app (see "Permissions" for the permissions)'
}
}, },
// TODO: Check it is valid url // TODO: Check it is valid url
callbackUrl: { callbackUrl: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
default: null as any, default: null as any,
desc: {
'ja-JP': 'アプリ認証時にコールバックするURL',
'en-US': 'URL to call back at app authentication'
}
}, },
}, },

View file

@ -11,18 +11,9 @@ export const meta = {
requireCredential: false as const, requireCredential: false as const,
desc: {
'ja-JP': 'アプリを認証するためのトークンを作成します。',
'en-US': 'Generate a token for authorize application.'
},
params: { params: {
appSecret: { appSecret: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': 'アプリケーションのシークレットキー',
'en-US': 'The secret key of your application.'
}
} }
}, },

View file

@ -11,10 +11,6 @@ export const meta = {
params: { params: {
token: { token: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': 'セッションのトークン',
'en-US': 'The token of a session.'
}
} }
}, },

View file

@ -11,18 +11,10 @@ export const meta = {
params: { params: {
appSecret: { appSecret: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': 'アプリケーションのシークレットキー',
'en-US': 'The secret key of your application.'
}
}, },
token: { token: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': 'セッションのトークン',
'en-US': 'The token of a session.'
}
} }
}, },

View file

@ -8,11 +8,6 @@ import { getUser } from '../../common/getters';
import { Blockings, NoteWatchings, Users } from '../../../../models'; import { Blockings, NoteWatchings, Users } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーをブロックします。',
'en-US': 'Block a user.'
},
tags: ['account'], tags: ['account'],
limit: { limit: {
@ -27,10 +22,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
} }
}, },

View file

@ -8,11 +8,6 @@ import { getUser } from '../../common/getters';
import { Blockings, Users } from '../../../../models'; import { Blockings, Users } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーのブロックを解除します。',
'en-US': 'Unblock a user.'
},
tags: ['account'], tags: ['account'],
limit: { limit: {
@ -27,10 +22,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
} }
}, },

View file

@ -5,11 +5,6 @@ import { Blockings } from '../../../../models';
import { makePaginationQuery } from '../../common/make-pagination-query'; import { makePaginationQuery } from '../../common/make-pagination-query';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ブロックしているユーザー一覧を取得します。',
'en-US': 'Get blocking users.'
},
tags: ['account'], tags: ['account'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -14,45 +14,27 @@ export const meta = {
params: { params: {
channelId: { channelId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': 'チャンネルのID'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 100), validator: $.optional.num.range(1, 100),
default: 10, default: 10,
desc: {
'ja-JP': '最大数'
}
}, },
sinceId: { sinceId: {
validator: $.optional.type(ID), validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより新しい投稿を取得します'
}
}, },
untilId: { untilId: {
validator: $.optional.type(ID), validator: $.optional.type(ID),
desc: {
'ja-JP': '指定すると、その投稿を基点としてより古い投稿を取得します'
}
}, },
sinceDate: { sinceDate: {
validator: $.optional.num, validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより新しい投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
}, },
untilDate: { untilDate: {
validator: $.optional.num, validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより古い投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
}, },
}, },

View file

@ -4,26 +4,16 @@ import { convertLog } from '../../../../services/chart/core';
import { activeUsersChart } from '../../../../services/chart'; import { activeUsersChart } from '../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'アクティブユーザーのチャートを取得します。'
},
tags: ['charts', 'users'], tags: ['charts', 'users'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {

View file

@ -4,26 +4,16 @@ import { convertLog } from '../../../../services/chart/core';
import { driveChart } from '../../../../services/chart'; import { driveChart } from '../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ドライブのチャートを取得します。'
},
tags: ['charts', 'drive'], tags: ['charts', 'drive'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {

View file

@ -4,26 +4,16 @@ import { convertLog } from '../../../../services/chart/core';
import { federationChart } from '../../../../services/chart'; import { federationChart } from '../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'フェデレーションのチャートを取得します。'
},
tags: ['charts'], tags: ['charts'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {

View file

@ -4,26 +4,16 @@ import { convertLog } from '../../../../services/chart/core';
import { hashtagChart } from '../../../../services/chart'; import { hashtagChart } from '../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ハッシュタグごとのチャートを取得します。'
},
tags: ['charts', 'hashtags'], tags: ['charts', 'hashtags'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {
@ -33,9 +23,6 @@ export const meta = {
tag: { tag: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': '対象のハッシュタグ'
}
}, },
}, },

View file

@ -4,26 +4,16 @@ import { convertLog } from '../../../../services/chart/core';
import { instanceChart } from '../../../../services/chart'; import { instanceChart } from '../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'インスタンスごとのチャートを取得します。'
},
tags: ['charts'], tags: ['charts'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {
@ -33,10 +23,6 @@ export const meta = {
host: { host: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': '対象のインスタンスのホスト',
'en-US': 'Target instance host'
}
} }
}, },

View file

@ -4,26 +4,16 @@ import { convertLog } from '../../../../services/chart/core';
import { networkChart } from '../../../../services/chart'; import { networkChart } from '../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ネットワークのチャートを取得します。'
},
tags: ['charts'], tags: ['charts'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {

View file

@ -4,26 +4,16 @@ import { convertLog } from '../../../../services/chart/core';
import { notesChart } from '../../../../services/chart'; import { notesChart } from '../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': '投稿のチャートを取得します。'
},
tags: ['charts', 'notes'], tags: ['charts', 'notes'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {

View file

@ -5,26 +5,16 @@ import { convertLog } from '../../../../../services/chart/core';
import { perUserDriveChart } from '../../../../../services/chart'; import { perUserDriveChart } from '../../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ユーザーごとのドライブのチャートを取得します。'
},
tags: ['charts', 'drive', 'users'], tags: ['charts', 'drive', 'users'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {
@ -34,10 +24,6 @@ export const meta = {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
} }
}, },

View file

@ -5,26 +5,16 @@ import { convertLog } from '../../../../../services/chart/core';
import { perUserFollowingChart } from '../../../../../services/chart'; import { perUserFollowingChart } from '../../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ユーザーごとのフォロー/フォロワーのチャートを取得します。'
},
tags: ['charts', 'users', 'following'], tags: ['charts', 'users', 'following'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {
@ -34,10 +24,6 @@ export const meta = {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
} }
}, },

View file

@ -5,26 +5,16 @@ import { convertLog } from '../../../../../services/chart/core';
import { perUserNotesChart } from '../../../../../services/chart'; import { perUserNotesChart } from '../../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ユーザーごとの投稿のチャートを取得します。'
},
tags: ['charts', 'users', 'notes'], tags: ['charts', 'users', 'notes'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {
@ -34,10 +24,6 @@ export const meta = {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
} }
}, },

View file

@ -5,26 +5,16 @@ import { convertLog } from '../../../../../services/chart/core';
import { perUserReactionsChart } from '../../../../../services/chart'; import { perUserReactionsChart } from '../../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ユーザーごとの被リアクション数のチャートを取得します。'
},
tags: ['charts', 'users', 'reactions'], tags: ['charts', 'users', 'reactions'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {
@ -34,10 +24,6 @@ export const meta = {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
} }
}, },

View file

@ -4,26 +4,16 @@ import { convertLog } from '../../../../services/chart/core';
import { usersChart } from '../../../../services/chart'; import { usersChart } from '../../../../services/chart';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ユーザーのチャートを取得します。'
},
tags: ['charts', 'users'], tags: ['charts', 'users'],
params: { params: {
span: { span: {
validator: $.str.or(['day', 'hour']), validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
}, },
limit: { limit: {
validator: $.optional.num.range(1, 500), validator: $.optional.num.range(1, 500),
default: 30, default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
}, },
offset: { offset: {

View file

@ -3,11 +3,6 @@ import { fetchMeta } from '@/misc/fetch-meta';
import { DriveFiles } from '../../../models'; import { DriveFiles } from '../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ドライブの情報を取得します。',
'en-US': 'Get drive information.'
},
tags: ['drive', 'account'], tags: ['drive', 'account'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -5,11 +5,6 @@ import { DriveFiles } from '../../../../models';
import { makePaginationQuery } from '../../common/make-pagination-query'; import { makePaginationQuery } from '../../common/make-pagination-query';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ドライブのファイル一覧を取得します。',
'en-US': 'Get files of drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -5,11 +5,6 @@ import { ApiError } from '../../../error';
import { DriveFiles, Notes } from '../../../../../models'; import { DriveFiles, Notes } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したドライブのファイルが添付されている投稿一覧を取得します。',
'en-US': 'Get the notes that specified file of drive attached.'
},
tags: ['drive', 'notes'], tags: ['drive', 'notes'],
requireCredential: true as const, requireCredential: true as const,
@ -19,10 +14,6 @@ export const meta = {
params: { params: {
fileId: { fileId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のファイルID',
'en-US': 'Target file ID'
}
} }
}, },

View file

@ -3,11 +3,6 @@ import define from '../../../define';
import { DriveFiles } from '../../../../../models'; import { DriveFiles } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '与えられたMD5ハッシュ値を持つファイルがドライブに存在するかどうかを返します。',
'en-US': 'Returns whether the file with the given MD5 hash exists in the user\'s drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,
@ -17,9 +12,6 @@ export const meta = {
params: { params: {
md5: { md5: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': 'ファイルのMD5ハッシュ'
}
} }
}, },

View file

@ -8,11 +8,6 @@ import { ApiError } from '../../../error';
import { DriveFiles } from '../../../../../models'; import { DriveFiles } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ドライブにファイルをアップロードします。',
'en-US': 'Upload a file to drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,
@ -30,36 +25,23 @@ export const meta = {
folderId: { folderId: {
validator: $.optional.nullable.type(ID), validator: $.optional.nullable.type(ID),
default: null as any, default: null as any,
desc: {
'ja-JP': 'フォルダID'
}
}, },
name: { name: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
default: null as any, default: null as any,
desc: {
'ja-JP': 'ファイル名(拡張子があるなら含めて)'
}
}, },
isSensitive: { isSensitive: {
validator: $.optional.either($.bool, $.str), validator: $.optional.either($.bool, $.str),
default: false, default: false,
transform: (v: any): boolean => v === true || v === 'true', transform: (v: any): boolean => v === true || v === 'true',
desc: {
'ja-JP': 'このメディアが「閲覧注意」(NSFW)かどうか',
'en-US': 'Whether this media is NSFW'
}
}, },
force: { force: {
validator: $.optional.either($.bool, $.str), validator: $.optional.either($.bool, $.str),
default: false, default: false,
transform: (v: any): boolean => v === true || v === 'true', transform: (v: any): boolean => v === true || v === 'true',
desc: {
'ja-JP': 'true にすると、同じハッシュを持つファイルが既にアップロードされていても強制的にファイルを作成します。',
}
} }
}, },

View file

@ -7,11 +7,6 @@ import { ApiError } from '../../../error';
import { DriveFiles } from '../../../../../models'; import { DriveFiles } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ドライブのファイルを削除します。',
'en-US': 'Delete a file of drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,
@ -21,10 +16,6 @@ export const meta = {
params: { params: {
fileId: { fileId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のファイルID',
'en-US': 'Target file ID'
}
} }
}, },

View file

@ -3,10 +3,6 @@ import define from '../../../define';
import { DriveFiles } from '../../../../../models'; import { DriveFiles } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '与えられたMD5ハッシュ値を持つファイルを取得します。',
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,
@ -16,9 +12,6 @@ export const meta = {
params: { params: {
md5: { md5: {
validator: $.str, validator: $.str,
desc: {
'ja-JP': 'ファイルのMD5ハッシュ'
}
} }
}, },

View file

@ -18,9 +18,6 @@ export const meta = {
folderId: { folderId: {
validator: $.optional.nullable.type(ID), validator: $.optional.nullable.type(ID),
default: null as any, default: null as any,
desc: {
'ja-JP': 'フォルダID'
}
}, },
}, },

View file

@ -6,11 +6,6 @@ import { DriveFile } from '../../../../../models/entities/drive-file';
import { DriveFiles } from '../../../../../models'; import { DriveFiles } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したドライブのファイルの情報を取得します。',
'en-US': 'Get specified file of drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,
@ -20,18 +15,10 @@ export const meta = {
params: { params: {
fileId: { fileId: {
validator: $.optional.type(ID), validator: $.optional.type(ID),
desc: {
'ja-JP': '対象のファイルID',
'en-US': 'Target file ID'
}
}, },
url: { url: {
validator: $.optional.str, validator: $.optional.str,
desc: {
'ja-JP': '対象のファイルのURL',
'en-US': 'Target file URL'
}
} }
}, },

View file

@ -6,11 +6,6 @@ import { ApiError } from '../../../error';
import { DriveFiles, DriveFolders } from '../../../../../models'; import { DriveFiles, DriveFolders } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したドライブのファイルの情報を更新します。',
'en-US': 'Update specified file of drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,
@ -20,43 +15,26 @@ export const meta = {
params: { params: {
fileId: { fileId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のファイルID'
}
}, },
folderId: { folderId: {
validator: $.optional.nullable.type(ID), validator: $.optional.nullable.type(ID),
default: undefined as any, default: undefined as any,
desc: {
'ja-JP': 'フォルダID'
}
}, },
name: { name: {
validator: $.optional.str.pipe(DriveFiles.validateFileName), validator: $.optional.str.pipe(DriveFiles.validateFileName),
default: undefined as any, default: undefined as any,
desc: {
'ja-JP': 'ファイル名',
'en-US': 'Name of the file'
}
}, },
isSensitive: { isSensitive: {
validator: $.optional.bool, validator: $.optional.bool,
default: undefined as any, default: undefined as any,
desc: {
'ja-JP': 'このメディアが「閲覧注意」(NSFW)かどうか',
'en-US': 'Whether this media is NSFW'
}
}, },
comment: { comment: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
default: undefined as any, default: undefined as any,
desc: {
'ja-JP': 'コメント'
}
} }
}, },

View file

@ -7,10 +7,6 @@ import { DriveFiles } from '../../../../../models';
import { publishMainStream } from '../../../../../services/stream'; import { publishMainStream } from '../../../../../services/stream';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ドライブに指定されたURLに存在するファイルをアップロードします。'
},
tags: ['drive'], tags: ['drive'],
limit: { limit: {
@ -36,10 +32,6 @@ export const meta = {
isSensitive: { isSensitive: {
validator: $.optional.bool, validator: $.optional.bool,
default: false, default: false,
desc: {
'ja-JP': 'このメディアが「閲覧注意」(NSFW)かどうか',
'en-US': 'Whether this media is NSFW'
}
}, },
comment: { comment: {
@ -55,9 +47,6 @@ export const meta = {
force: { force: {
validator: $.optional.bool, validator: $.optional.bool,
default: false, default: false,
desc: {
'ja-JP': 'true にすると、同じハッシュを持つファイルが既にアップロードされていても強制的にファイルを作成します。',
}
} }
} }
}; };

View file

@ -5,11 +5,6 @@ import { DriveFolders } from '../../../../models';
import { makePaginationQuery } from '../../common/make-pagination-query'; import { makePaginationQuery } from '../../common/make-pagination-query';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ドライブのフォルダ一覧を取得します。',
'en-US': 'Get folders of drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,

View file

@ -7,11 +7,6 @@ import { DriveFolders } from '../../../../../models';
import { genId } from '@/misc/gen-id'; import { genId } from '@/misc/gen-id';
export const meta = { export const meta = {
desc: {
'ja-JP': 'ドライブのフォルダを作成します。',
'en-US': 'Create a folder of drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,
@ -22,18 +17,10 @@ export const meta = {
name: { name: {
validator: $.optional.str.pipe(DriveFolders.validateFolderName), validator: $.optional.str.pipe(DriveFolders.validateFolderName),
default: 'Untitled', default: 'Untitled',
desc: {
'ja-JP': 'フォルダ名',
'en-US': 'Folder name'
}
}, },
parentId: { parentId: {
validator: $.optional.nullable.type(ID), validator: $.optional.nullable.type(ID),
desc: {
'ja-JP': '親フォルダID',
'en-US': 'Parent folder ID'
}
} }
}, },

View file

@ -6,11 +6,6 @@ import { ApiError } from '../../../error';
import { DriveFolders, DriveFiles } from '../../../../../models'; import { DriveFolders, DriveFiles } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したドライブのフォルダを削除します。',
'en-US': 'Delete specified folder of drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,
@ -20,10 +15,6 @@ export const meta = {
params: { params: {
folderId: { folderId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のフォルダID',
'en-US': 'Target folder ID'
}
} }
}, },

View file

@ -18,9 +18,6 @@ export const meta = {
parentId: { parentId: {
validator: $.optional.nullable.type(ID), validator: $.optional.nullable.type(ID),
default: null as any, default: null as any,
desc: {
'ja-JP': 'フォルダID'
}
}, },
}, },

View file

@ -5,11 +5,6 @@ import { ApiError } from '../../../error';
import { DriveFolders } from '../../../../../models'; import { DriveFolders } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したドライブのフォルダの情報を取得します。',
'en-US': 'Get specified folder of drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,
@ -19,10 +14,6 @@ export const meta = {
params: { params: {
folderId: { folderId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のフォルダID',
'en-US': 'Target folder ID'
}
} }
}, },

View file

@ -6,11 +6,6 @@ import { ApiError } from '../../../error';
import { DriveFolders } from '../../../../../models'; import { DriveFolders } from '../../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したドライブのフォルダの情報を更新します。',
'en-US': 'Update specified folder of drive.'
},
tags: ['drive'], tags: ['drive'],
requireCredential: true as const, requireCredential: true as const,
@ -20,26 +15,14 @@ export const meta = {
params: { params: {
folderId: { folderId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のフォルダID',
'en-US': 'Target folder ID'
}
}, },
name: { name: {
validator: $.optional.str.pipe(DriveFolders.validateFolderName), validator: $.optional.str.pipe(DriveFolders.validateFolderName),
desc: {
'ja-JP': 'フォルダ名',
'en-US': 'Folder name'
}
}, },
parentId: { parentId: {
validator: $.optional.nullable.type(ID), validator: $.optional.nullable.type(ID),
desc: {
'ja-JP': '親フォルダID',
'en-US': 'Parent folder ID'
}
} }
}, },

View file

@ -2,11 +2,6 @@ import define from '../define';
import endpoints from '../endpoints'; import endpoints from '../endpoints';
export const meta = { export const meta = {
desc: {
'ja-JP': '使用できるAPI一覧を返します。',
'en-US': 'Returns a list of available APIs.'
},
requireCredential: false as const, requireCredential: false as const,
tags: ['meta'], tags: ['meta'],

View file

@ -5,11 +5,6 @@ import { getRemoteUser } from '../../common/getters';
import { updatePerson } from '../../../../remote/activitypub/models/person'; import { updatePerson } from '../../../../remote/activitypub/models/person';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定されたリモートユーザーの情報を更新します。',
'en-US': 'Update specified remote user information.'
},
tags: ['federation'], tags: ['federation'],
requireCredential: true as const, requireCredential: true as const,
@ -17,10 +12,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーID',
'en-US': 'The user ID which you want to update'
}
}, },
} }
}; };

View file

@ -8,11 +8,6 @@ import { getUser } from '../../common/getters';
import { Followings, Users } from '../../../../models'; import { Followings, Users } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーをフォローします。',
'en-US': 'Follow a user.'
},
tags: ['following', 'users'], tags: ['following', 'users'],
limit: { limit: {
@ -27,10 +22,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
} }
}, },

View file

@ -8,11 +8,6 @@ import { getUser } from '../../common/getters';
import { Followings, Users } from '../../../../models'; import { Followings, Users } from '../../../../models';
export const meta = { export const meta = {
desc: {
'ja-JP': '指定したユーザーのフォローを解除します。',
'en-US': 'Unfollow a user.'
},
tags: ['following', 'users'], tags: ['following', 'users'],
limit: { limit: {
@ -27,10 +22,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
} }
}, },

View file

@ -6,11 +6,6 @@ import { ApiError } from '../../../error';
import { getUser } from '../../../common/getters'; import { getUser } from '../../../common/getters';
export const meta = { export const meta = {
desc: {
'ja-JP': '自分に届いた、指定したフォローリクエストを承認します。',
'en-US': 'Accept a follow request.'
},
tags: ['following', 'account'], tags: ['following', 'account'],
requireCredential: true as const, requireCredential: true as const,
@ -20,10 +15,6 @@ export const meta = {
params: { params: {
userId: { userId: {
validator: $.type(ID), validator: $.type(ID),
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
} }
}, },

Some files were not shown because too many files have changed in this diff Show more