From a07d753da84191bc8c185a7bcd6d73fab9529b5d Mon Sep 17 00:00:00 2001 From: YuzuRyo61 Date: Sat, 6 Mar 2021 22:34:11 +0900 Subject: APIドキュメントの改善 (#6757) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update api document in admin/announcements * Update api document in announcements * Update api document in i/read-announcements * Update api document in username/available * Update api document & Fix typo in API 403 error * Update api document * Update api document * Update api document * Fix API permission definition * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Fix bug in users (api) * Apply reviews #6757 * Apply reviews #6757 Co-authored-by: syuilo --- src/server/api/endpoints/admin/emoji/copy.ts | 18 ++++++++ .../api/endpoints/admin/emoji/list-remote.ts | 49 +++++++++++++++++++++- src/server/api/endpoints/admin/emoji/list.ts | 49 +++++++++++++++++++++- 3 files changed, 114 insertions(+), 2 deletions(-) (limited to 'src/server/api/endpoints/admin/emoji') diff --git a/src/server/api/endpoints/admin/emoji/copy.ts b/src/server/api/endpoints/admin/emoji/copy.ts index 5d4e57a28f..5c3c4f6fc5 100644 --- a/src/server/api/endpoints/admin/emoji/copy.ts +++ b/src/server/api/endpoints/admin/emoji/copy.ts @@ -9,6 +9,11 @@ import { ID } from '../../../../../misc/cafy-id'; import uploadFromUrl from '../../../../../services/drive/upload-from-url'; export const meta = { + desc: { + 'ja-JP': '選択したカスタム絵文字をコピーします。', + 'en-US': 'Copies the selected custom emoji.' + }, + tags: ['admin'], requireCredential: true as const, @@ -26,6 +31,19 @@ export const meta = { code: 'NO_SUCH_EMOJI', id: 'e2785b66-dca3-4087-9cac-b93c541cc425' } + }, + + res: { + type: 'object' as const, + optional: false as const, nullable: false as const, + properties: { + id: { + type: 'string' as const, + optional: false as const, nullable: false as const, + format: 'id', + description: 'New copied emoji ID' + } + } } }; diff --git a/src/server/api/endpoints/admin/emoji/list-remote.ts b/src/server/api/endpoints/admin/emoji/list-remote.ts index cbdcaa681c..81029fbbba 100644 --- a/src/server/api/endpoints/admin/emoji/list-remote.ts +++ b/src/server/api/endpoints/admin/emoji/list-remote.ts @@ -7,7 +7,8 @@ import { ID } from '../../../../../misc/cafy-id'; export const meta = { desc: { - 'ja-JP': 'カスタム絵文字を取得します。' + 'ja-JP': 'リモートのカスタム絵文字一覧を取得します。', + 'en-US': 'Gets a list of remote custom emojis.' }, tags: ['admin'], @@ -38,6 +39,52 @@ export const meta = { untilId: { validator: $.optional.type(ID), } + }, + + res: { + type: 'array' as const, + optional: false as const, nullable: false as const, + items: { + type: 'object' as const, + optional: false as const, nullable: false as const, + properties: { + id: { + type: 'string' as const, + optional: false as const, nullable: false as const, + format: 'id', + description: 'The unique identifier for this Emoji.' + }, + aliases: { + type: 'array' as const, + optional: false as const, nullable: false as const, + description: 'List to make it easier to be displayed as a candidate when entering emoji.', + items: { + type: 'string' as const, + optional: false as const, nullable: false as const + } + }, + name: { + type: 'string' as const, + optional: false as const, nullable: false as const, + description: 'Official name of custom emoji.' + }, + category: { + type: 'string' as const, + optional: false as const, nullable: true as const, + description: 'Names categorized in the emoji list.' + }, + host: { + type: 'string' as const, + optional: false as const, nullable: true as const, + description: 'If it is another server, the FQDN will be returned here.' + }, + url: { + type: 'string' as const, + optional: false as const, nullable: false as const, + description: 'Image URL of emoji.' + } + } + } } }; diff --git a/src/server/api/endpoints/admin/emoji/list.ts b/src/server/api/endpoints/admin/emoji/list.ts index bd3e294851..6d042b0afd 100644 --- a/src/server/api/endpoints/admin/emoji/list.ts +++ b/src/server/api/endpoints/admin/emoji/list.ts @@ -7,7 +7,8 @@ import { Emoji } from '../../../../../models/entities/emoji'; export const meta = { desc: { - 'ja-JP': 'カスタム絵文字を取得します。' + 'ja-JP': 'カスタム絵文字一覧を取得します。', + 'en-US': 'List custom emojis.' }, tags: ['admin'], @@ -33,6 +34,52 @@ export const meta = { untilId: { validator: $.optional.type(ID), } + }, + + res: { + type: 'array' as const, + optional: false as const, nullable: false as const, + items: { + type: 'object' as const, + optional: false as const, nullable: false as const, + properties: { + id: { + type: 'string' as const, + optional: false as const, nullable: false as const, + format: 'id', + description: 'The unique identifier for this Emoji.' + }, + aliases: { + type: 'array' as const, + optional: false as const, nullable: false as const, + description: 'List to make it easier to be displayed as a candidate when entering emoji.', + items: { + type: 'string' as const, + optional: false as const, nullable: false as const + } + }, + name: { + type: 'string' as const, + optional: false as const, nullable: false as const, + description: 'Official name of custom emoji.' + }, + category: { + type: 'string' as const, + optional: false as const, nullable: true as const, + description: 'Names categorized in the emoji list.' + }, + host: { + type: 'string' as const, + optional: false as const, nullable: true as const, + description: 'If it is another server, the FQDN will be returned here.' + }, + url: { + type: 'string' as const, + optional: false as const, nullable: false as const, + description: 'Image URL of emoji.' + } + } + } } }; -- cgit v1.2.3-freya