From 6b312f755eb171df0afd95a2d4e51cfd7300fa16 Mon Sep 17 00:00:00 2001 From: syuilo Date: Tue, 8 Jun 2021 14:09:32 +0900 Subject: Remove endpoint descriptions #6627 --- src/server/api/endpoints/drive/files.ts | 5 ----- .../api/endpoints/drive/files/attached-notes.ts | 9 --------- .../api/endpoints/drive/files/check-existence.ts | 8 -------- src/server/api/endpoints/drive/files/create.ts | 18 ------------------ src/server/api/endpoints/drive/files/delete.ts | 9 --------- .../api/endpoints/drive/files/find-by-hash.ts | 7 ------- src/server/api/endpoints/drive/files/find.ts | 3 --- src/server/api/endpoints/drive/files/show.ts | 13 ------------- src/server/api/endpoints/drive/files/update.ts | 22 ---------------------- .../api/endpoints/drive/files/upload-from-url.ts | 11 ----------- src/server/api/endpoints/drive/folders.ts | 5 ----- src/server/api/endpoints/drive/folders/create.ts | 13 ------------- src/server/api/endpoints/drive/folders/delete.ts | 9 --------- src/server/api/endpoints/drive/folders/find.ts | 3 --- src/server/api/endpoints/drive/folders/show.ts | 9 --------- src/server/api/endpoints/drive/folders/update.ts | 17 ----------------- 16 files changed, 161 deletions(-) (limited to 'src/server/api/endpoints/drive') diff --git a/src/server/api/endpoints/drive/files.ts b/src/server/api/endpoints/drive/files.ts index 85dc07cc16..60cb8c5134 100644 --- a/src/server/api/endpoints/drive/files.ts +++ b/src/server/api/endpoints/drive/files.ts @@ -5,11 +5,6 @@ import { DriveFiles } from '../../../../models'; import { makePaginationQuery } from '../../common/make-pagination-query'; export const meta = { - desc: { - 'ja-JP': 'ドライブのファイル一覧を取得します。', - 'en-US': 'Get files of drive.' - }, - tags: ['drive'], requireCredential: true as const, diff --git a/src/server/api/endpoints/drive/files/attached-notes.ts b/src/server/api/endpoints/drive/files/attached-notes.ts index ea09581ba9..dafbf30fbb 100644 --- a/src/server/api/endpoints/drive/files/attached-notes.ts +++ b/src/server/api/endpoints/drive/files/attached-notes.ts @@ -5,11 +5,6 @@ import { ApiError } from '../../../error'; import { DriveFiles, Notes } from '../../../../../models'; export const meta = { - desc: { - 'ja-JP': '指定したドライブのファイルが添付されている投稿一覧を取得します。', - 'en-US': 'Get the notes that specified file of drive attached.' - }, - tags: ['drive', 'notes'], requireCredential: true as const, @@ -19,10 +14,6 @@ export const meta = { params: { fileId: { validator: $.type(ID), - desc: { - 'ja-JP': '対象のファイルID', - 'en-US': 'Target file ID' - } } }, diff --git a/src/server/api/endpoints/drive/files/check-existence.ts b/src/server/api/endpoints/drive/files/check-existence.ts index f1741cf086..b20be44072 100644 --- a/src/server/api/endpoints/drive/files/check-existence.ts +++ b/src/server/api/endpoints/drive/files/check-existence.ts @@ -3,11 +3,6 @@ import define from '../../../define'; import { DriveFiles } from '../../../../../models'; 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'], requireCredential: true as const, @@ -17,9 +12,6 @@ export const meta = { params: { md5: { validator: $.str, - desc: { - 'ja-JP': 'ファイルのMD5ハッシュ' - } } }, diff --git a/src/server/api/endpoints/drive/files/create.ts b/src/server/api/endpoints/drive/files/create.ts index 82ff04e092..7da9a20f8f 100644 --- a/src/server/api/endpoints/drive/files/create.ts +++ b/src/server/api/endpoints/drive/files/create.ts @@ -8,11 +8,6 @@ import { ApiError } from '../../../error'; import { DriveFiles } from '../../../../../models'; export const meta = { - desc: { - 'ja-JP': 'ドライブにファイルをアップロードします。', - 'en-US': 'Upload a file to drive.' - }, - tags: ['drive'], requireCredential: true as const, @@ -30,36 +25,23 @@ export const meta = { folderId: { validator: $.optional.nullable.type(ID), default: null as any, - desc: { - 'ja-JP': 'フォルダID' - } }, name: { validator: $.optional.nullable.str, default: null as any, - desc: { - 'ja-JP': 'ファイル名(拡張子があるなら含めて)' - } }, isSensitive: { validator: $.optional.either($.bool, $.str), default: false, transform: (v: any): boolean => v === true || v === 'true', - desc: { - 'ja-JP': 'このメディアが「閲覧注意」(NSFW)かどうか', - 'en-US': 'Whether this media is NSFW' - } }, force: { validator: $.optional.either($.bool, $.str), default: false, transform: (v: any): boolean => v === true || v === 'true', - desc: { - 'ja-JP': 'true にすると、同じハッシュを持つファイルが既にアップロードされていても強制的にファイルを作成します。', - } } }, diff --git a/src/server/api/endpoints/drive/files/delete.ts b/src/server/api/endpoints/drive/files/delete.ts index 211afaaba1..520078948c 100644 --- a/src/server/api/endpoints/drive/files/delete.ts +++ b/src/server/api/endpoints/drive/files/delete.ts @@ -7,11 +7,6 @@ import { ApiError } from '../../../error'; import { DriveFiles } from '../../../../../models'; export const meta = { - desc: { - 'ja-JP': 'ドライブのファイルを削除します。', - 'en-US': 'Delete a file of drive.' - }, - tags: ['drive'], requireCredential: true as const, @@ -21,10 +16,6 @@ export const meta = { params: { fileId: { validator: $.type(ID), - desc: { - 'ja-JP': '対象のファイルID', - 'en-US': 'Target file ID' - } } }, diff --git a/src/server/api/endpoints/drive/files/find-by-hash.ts b/src/server/api/endpoints/drive/files/find-by-hash.ts index 336c85c444..ef0077392e 100644 --- a/src/server/api/endpoints/drive/files/find-by-hash.ts +++ b/src/server/api/endpoints/drive/files/find-by-hash.ts @@ -3,10 +3,6 @@ import define from '../../../define'; import { DriveFiles } from '../../../../../models'; export const meta = { - desc: { - 'ja-JP': '与えられたMD5ハッシュ値を持つファイルを取得します。', - }, - tags: ['drive'], requireCredential: true as const, @@ -16,9 +12,6 @@ export const meta = { params: { md5: { validator: $.str, - desc: { - 'ja-JP': 'ファイルのMD5ハッシュ' - } } }, diff --git a/src/server/api/endpoints/drive/files/find.ts b/src/server/api/endpoints/drive/files/find.ts index b3613ca01b..f95504a00a 100644 --- a/src/server/api/endpoints/drive/files/find.ts +++ b/src/server/api/endpoints/drive/files/find.ts @@ -18,9 +18,6 @@ export const meta = { folderId: { validator: $.optional.nullable.type(ID), default: null as any, - desc: { - 'ja-JP': 'フォルダID' - } }, }, diff --git a/src/server/api/endpoints/drive/files/show.ts b/src/server/api/endpoints/drive/files/show.ts index f4922bff13..33e88fa817 100644 --- a/src/server/api/endpoints/drive/files/show.ts +++ b/src/server/api/endpoints/drive/files/show.ts @@ -6,11 +6,6 @@ import { DriveFile } from '../../../../../models/entities/drive-file'; import { DriveFiles } from '../../../../../models'; export const meta = { - desc: { - 'ja-JP': '指定したドライブのファイルの情報を取得します。', - 'en-US': 'Get specified file of drive.' - }, - tags: ['drive'], requireCredential: true as const, @@ -20,18 +15,10 @@ export const meta = { params: { fileId: { validator: $.optional.type(ID), - desc: { - 'ja-JP': '対象のファイルID', - 'en-US': 'Target file ID' - } }, url: { validator: $.optional.str, - desc: { - 'ja-JP': '対象のファイルのURL', - 'en-US': 'Target file URL' - } } }, diff --git a/src/server/api/endpoints/drive/files/update.ts b/src/server/api/endpoints/drive/files/update.ts index f740fea67e..29b4ba7a45 100644 --- a/src/server/api/endpoints/drive/files/update.ts +++ b/src/server/api/endpoints/drive/files/update.ts @@ -6,11 +6,6 @@ import { ApiError } from '../../../error'; import { DriveFiles, DriveFolders } from '../../../../../models'; export const meta = { - desc: { - 'ja-JP': '指定したドライブのファイルの情報を更新します。', - 'en-US': 'Update specified file of drive.' - }, - tags: ['drive'], requireCredential: true as const, @@ -20,43 +15,26 @@ export const meta = { params: { fileId: { validator: $.type(ID), - desc: { - 'ja-JP': '対象のファイルID' - } }, folderId: { validator: $.optional.nullable.type(ID), default: undefined as any, - desc: { - 'ja-JP': 'フォルダID' - } }, name: { validator: $.optional.str.pipe(DriveFiles.validateFileName), default: undefined as any, - desc: { - 'ja-JP': 'ファイル名', - 'en-US': 'Name of the file' - } }, isSensitive: { validator: $.optional.bool, default: undefined as any, - desc: { - 'ja-JP': 'このメディアが「閲覧注意」(NSFW)かどうか', - 'en-US': 'Whether this media is NSFW' - } }, comment: { validator: $.optional.nullable.str, default: undefined as any, - desc: { - 'ja-JP': 'コメント' - } } }, diff --git a/src/server/api/endpoints/drive/files/upload-from-url.ts b/src/server/api/endpoints/drive/files/upload-from-url.ts index 1b33099aa4..65213be6ae 100644 --- a/src/server/api/endpoints/drive/files/upload-from-url.ts +++ b/src/server/api/endpoints/drive/files/upload-from-url.ts @@ -7,10 +7,6 @@ import { DriveFiles } from '../../../../../models'; import { publishMainStream } from '../../../../../services/stream'; export const meta = { - desc: { - 'ja-JP': 'ドライブに指定されたURLに存在するファイルをアップロードします。' - }, - tags: ['drive'], limit: { @@ -36,10 +32,6 @@ export const meta = { isSensitive: { validator: $.optional.bool, default: false, - desc: { - 'ja-JP': 'このメディアが「閲覧注意」(NSFW)かどうか', - 'en-US': 'Whether this media is NSFW' - } }, comment: { @@ -55,9 +47,6 @@ export const meta = { force: { validator: $.optional.bool, default: false, - desc: { - 'ja-JP': 'true にすると、同じハッシュを持つファイルが既にアップロードされていても強制的にファイルを作成します。', - } } } }; diff --git a/src/server/api/endpoints/drive/folders.ts b/src/server/api/endpoints/drive/folders.ts index 89453e6e09..014f986f9b 100644 --- a/src/server/api/endpoints/drive/folders.ts +++ b/src/server/api/endpoints/drive/folders.ts @@ -5,11 +5,6 @@ import { DriveFolders } from '../../../../models'; import { makePaginationQuery } from '../../common/make-pagination-query'; export const meta = { - desc: { - 'ja-JP': 'ドライブのフォルダ一覧を取得します。', - 'en-US': 'Get folders of drive.' - }, - tags: ['drive'], requireCredential: true as const, diff --git a/src/server/api/endpoints/drive/folders/create.ts b/src/server/api/endpoints/drive/folders/create.ts index d2c5e00a9f..e39f8f2cee 100644 --- a/src/server/api/endpoints/drive/folders/create.ts +++ b/src/server/api/endpoints/drive/folders/create.ts @@ -7,11 +7,6 @@ import { DriveFolders } from '../../../../../models'; import { genId } from '@/misc/gen-id'; export const meta = { - desc: { - 'ja-JP': 'ドライブのフォルダを作成します。', - 'en-US': 'Create a folder of drive.' - }, - tags: ['drive'], requireCredential: true as const, @@ -22,18 +17,10 @@ export const meta = { name: { validator: $.optional.str.pipe(DriveFolders.validateFolderName), default: 'Untitled', - desc: { - 'ja-JP': 'フォルダ名', - 'en-US': 'Folder name' - } }, parentId: { validator: $.optional.nullable.type(ID), - desc: { - 'ja-JP': '親フォルダID', - 'en-US': 'Parent folder ID' - } } }, diff --git a/src/server/api/endpoints/drive/folders/delete.ts b/src/server/api/endpoints/drive/folders/delete.ts index 2a418069c9..253563a3ef 100644 --- a/src/server/api/endpoints/drive/folders/delete.ts +++ b/src/server/api/endpoints/drive/folders/delete.ts @@ -6,11 +6,6 @@ import { ApiError } from '../../../error'; import { DriveFolders, DriveFiles } from '../../../../../models'; export const meta = { - desc: { - 'ja-JP': '指定したドライブのフォルダを削除します。', - 'en-US': 'Delete specified folder of drive.' - }, - tags: ['drive'], requireCredential: true as const, @@ -20,10 +15,6 @@ export const meta = { params: { folderId: { validator: $.type(ID), - desc: { - 'ja-JP': '対象のフォルダID', - 'en-US': 'Target folder ID' - } } }, diff --git a/src/server/api/endpoints/drive/folders/find.ts b/src/server/api/endpoints/drive/folders/find.ts index e3f6aa4a91..f99e2fe1d7 100644 --- a/src/server/api/endpoints/drive/folders/find.ts +++ b/src/server/api/endpoints/drive/folders/find.ts @@ -18,9 +18,6 @@ export const meta = { parentId: { validator: $.optional.nullable.type(ID), default: null as any, - desc: { - 'ja-JP': 'フォルダID' - } }, }, diff --git a/src/server/api/endpoints/drive/folders/show.ts b/src/server/api/endpoints/drive/folders/show.ts index ae00b9e367..fe1326da75 100644 --- a/src/server/api/endpoints/drive/folders/show.ts +++ b/src/server/api/endpoints/drive/folders/show.ts @@ -5,11 +5,6 @@ import { ApiError } from '../../../error'; import { DriveFolders } from '../../../../../models'; export const meta = { - desc: { - 'ja-JP': '指定したドライブのフォルダの情報を取得します。', - 'en-US': 'Get specified folder of drive.' - }, - tags: ['drive'], requireCredential: true as const, @@ -19,10 +14,6 @@ export const meta = { params: { folderId: { validator: $.type(ID), - desc: { - 'ja-JP': '対象のフォルダID', - 'en-US': 'Target folder ID' - } } }, diff --git a/src/server/api/endpoints/drive/folders/update.ts b/src/server/api/endpoints/drive/folders/update.ts index 066013287c..9dfe33517e 100644 --- a/src/server/api/endpoints/drive/folders/update.ts +++ b/src/server/api/endpoints/drive/folders/update.ts @@ -6,11 +6,6 @@ import { ApiError } from '../../../error'; import { DriveFolders } from '../../../../../models'; export const meta = { - desc: { - 'ja-JP': '指定したドライブのフォルダの情報を更新します。', - 'en-US': 'Update specified folder of drive.' - }, - tags: ['drive'], requireCredential: true as const, @@ -20,26 +15,14 @@ export const meta = { params: { folderId: { validator: $.type(ID), - desc: { - 'ja-JP': '対象のフォルダID', - 'en-US': 'Target folder ID' - } }, name: { validator: $.optional.str.pipe(DriveFolders.validateFolderName), - desc: { - 'ja-JP': 'フォルダ名', - 'en-US': 'Folder name' - } }, parentId: { validator: $.optional.nullable.type(ID), - desc: { - 'ja-JP': '親フォルダID', - 'en-US': 'Parent folder ID' - } } }, -- cgit v1.2.3-freya From 56600ba1df2186bd3b0d5d30b4f1fd53bf5efd5d Mon Sep 17 00:00:00 2001 From: syuilo Date: Tue, 8 Jun 2021 14:14:58 +0900 Subject: refactor type --- src/server/api/endpoints/admin/emoji/list-remote.ts | 4 ++-- src/server/api/endpoints/admin/emoji/list.ts | 2 +- src/server/api/endpoints/admin/logs.ts | 4 ++-- src/server/api/endpoints/app/create.ts | 2 +- src/server/api/endpoints/drive/files.ts | 2 +- src/server/api/endpoints/drive/files/create.ts | 4 ++-- src/server/api/endpoints/drive/files/find.ts | 2 +- src/server/api/endpoints/drive/files/upload-from-url.ts | 6 +++--- src/server/api/endpoints/drive/folders.ts | 2 +- src/server/api/endpoints/drive/folders/find.ts | 2 +- src/server/api/endpoints/notes/create.ts | 2 +- src/server/api/endpoints/notes/search-by-tag.ts | 6 +++--- 12 files changed, 19 insertions(+), 19 deletions(-) (limited to 'src/server/api/endpoints/drive') diff --git a/src/server/api/endpoints/admin/emoji/list-remote.ts b/src/server/api/endpoints/admin/emoji/list-remote.ts index bd0b3dfc30..f1cfbdd3e2 100644 --- a/src/server/api/endpoints/admin/emoji/list-remote.ts +++ b/src/server/api/endpoints/admin/emoji/list-remote.ts @@ -14,12 +14,12 @@ export const meta = { params: { query: { validator: $.optional.nullable.str, - default: null as any + default: null }, host: { validator: $.optional.nullable.str, - default: null as any + default: null }, limit: { diff --git a/src/server/api/endpoints/admin/emoji/list.ts b/src/server/api/endpoints/admin/emoji/list.ts index 4473fbdd1f..3f3e49396b 100644 --- a/src/server/api/endpoints/admin/emoji/list.ts +++ b/src/server/api/endpoints/admin/emoji/list.ts @@ -14,7 +14,7 @@ export const meta = { params: { query: { validator: $.optional.nullable.str, - default: null as any + default: null }, limit: { diff --git a/src/server/api/endpoints/admin/logs.ts b/src/server/api/endpoints/admin/logs.ts index cb49bf6021..e719ce19c7 100644 --- a/src/server/api/endpoints/admin/logs.ts +++ b/src/server/api/endpoints/admin/logs.ts @@ -17,12 +17,12 @@ export const meta = { level: { validator: $.optional.nullable.str, - default: null as any + default: null }, domain: { validator: $.optional.nullable.str, - default: null as any + default: null } }, diff --git a/src/server/api/endpoints/app/create.ts b/src/server/api/endpoints/app/create.ts index b5629e4436..500567bf29 100644 --- a/src/server/api/endpoints/app/create.ts +++ b/src/server/api/endpoints/app/create.ts @@ -26,7 +26,7 @@ export const meta = { // TODO: Check it is valid url callbackUrl: { validator: $.optional.nullable.str, - default: null as any, + default: null, }, }, diff --git a/src/server/api/endpoints/drive/files.ts b/src/server/api/endpoints/drive/files.ts index 60cb8c5134..1e821b0085 100644 --- a/src/server/api/endpoints/drive/files.ts +++ b/src/server/api/endpoints/drive/files.ts @@ -27,7 +27,7 @@ export const meta = { folderId: { validator: $.optional.nullable.type(ID), - default: null as any, + default: null, }, type: { diff --git a/src/server/api/endpoints/drive/files/create.ts b/src/server/api/endpoints/drive/files/create.ts index 7da9a20f8f..a8f6b92014 100644 --- a/src/server/api/endpoints/drive/files/create.ts +++ b/src/server/api/endpoints/drive/files/create.ts @@ -24,12 +24,12 @@ export const meta = { params: { folderId: { validator: $.optional.nullable.type(ID), - default: null as any, + default: null, }, name: { validator: $.optional.nullable.str, - default: null as any, + default: null, }, isSensitive: { diff --git a/src/server/api/endpoints/drive/files/find.ts b/src/server/api/endpoints/drive/files/find.ts index f95504a00a..b7f2571453 100644 --- a/src/server/api/endpoints/drive/files/find.ts +++ b/src/server/api/endpoints/drive/files/find.ts @@ -17,7 +17,7 @@ export const meta = { folderId: { validator: $.optional.nullable.type(ID), - default: null as any, + default: null, }, }, diff --git a/src/server/api/endpoints/drive/files/upload-from-url.ts b/src/server/api/endpoints/drive/files/upload-from-url.ts index 65213be6ae..8dfc86e660 100644 --- a/src/server/api/endpoints/drive/files/upload-from-url.ts +++ b/src/server/api/endpoints/drive/files/upload-from-url.ts @@ -26,7 +26,7 @@ export const meta = { folderId: { validator: $.optional.nullable.type(ID), - default: null as any, + default: null, }, isSensitive: { @@ -36,12 +36,12 @@ export const meta = { comment: { validator: $.optional.nullable.str, - default: null as any, + default: null, }, marker: { validator: $.optional.nullable.str, - default: null as any, + default: null, }, force: { diff --git a/src/server/api/endpoints/drive/folders.ts b/src/server/api/endpoints/drive/folders.ts index 014f986f9b..c446d546cc 100644 --- a/src/server/api/endpoints/drive/folders.ts +++ b/src/server/api/endpoints/drive/folders.ts @@ -27,7 +27,7 @@ export const meta = { folderId: { validator: $.optional.nullable.type(ID), - default: null as any, + default: null, } }, diff --git a/src/server/api/endpoints/drive/folders/find.ts b/src/server/api/endpoints/drive/folders/find.ts index f99e2fe1d7..c8e7639e63 100644 --- a/src/server/api/endpoints/drive/folders/find.ts +++ b/src/server/api/endpoints/drive/folders/find.ts @@ -17,7 +17,7 @@ export const meta = { parentId: { validator: $.optional.nullable.type(ID), - default: null as any, + default: null, }, }, diff --git a/src/server/api/endpoints/notes/create.ts b/src/server/api/endpoints/notes/create.ts index 7410d28cb0..beeacb5374 100644 --- a/src/server/api/endpoints/notes/create.ts +++ b/src/server/api/endpoints/notes/create.ts @@ -50,7 +50,7 @@ export const meta = { && length(text.trim()) <= maxNoteTextLength && Array.from(text.trim()).length <= DB_MAX_NOTE_TEXT_LENGTH // DB limit ), - default: null as any, + default: null, }, cw: { diff --git a/src/server/api/endpoints/notes/search-by-tag.ts b/src/server/api/endpoints/notes/search-by-tag.ts index b7d41d9e71..bbada17613 100644 --- a/src/server/api/endpoints/notes/search-by-tag.ts +++ b/src/server/api/endpoints/notes/search-by-tag.ts @@ -23,12 +23,12 @@ export const meta = { reply: { validator: $.optional.nullable.bool, - default: null as any, + default: null, }, renote: { validator: $.optional.nullable.bool, - default: null as any, + default: null, }, withFiles: { @@ -37,7 +37,7 @@ export const meta = { poll: { validator: $.optional.nullable.bool, - default: null as any, + default: null, }, sinceId: { -- cgit v1.2.3-freya