diff options
| author | syuilo <Syuilotan@yahoo.co.jp> | 2021-06-08 14:24:21 +0900 |
|---|---|---|
| committer | syuilo <Syuilotan@yahoo.co.jp> | 2021-06-08 14:24:21 +0900 |
| commit | 55c549a9f83f25ac67fba888223faa9f98749b48 (patch) | |
| tree | 09aba86b913d1ab4fd7049fe1e7961493e08c305 /src/server/api | |
| parent | refactor type (diff) | |
| download | sharkey-55c549a9f83f25ac67fba888223faa9f98749b48.tar.gz sharkey-55c549a9f83f25ac67fba888223faa9f98749b48.tar.bz2 sharkey-55c549a9f83f25ac67fba888223faa9f98749b48.zip | |
Remove entity descriptions
#6627
Diffstat (limited to 'src/server/api')
22 files changed, 0 insertions, 95 deletions
diff --git a/src/server/api/endpoints/admin/abuse-user-reports.ts b/src/server/api/endpoints/admin/abuse-user-reports.ts index d09c9d0efb..02291a3edd 100644 --- a/src/server/api/endpoints/admin/abuse-user-reports.ts +++ b/src/server/api/endpoints/admin/abuse-user-reports.ts @@ -59,43 +59,36 @@ export const meta = { type: 'string' as const, nullable: false as const, optional: false as const, format: 'id', - description: 'The unique identifier for this User.', example: 'xxxxxxxxxx', }, createdAt: { type: 'string' as const, nullable: false as const, optional: false as const, format: 'date-time', - description: 'The date that the abuse user report was created on Misskey.' }, comment: { type: 'string' as const, nullable: false as const, optional: false as const, - description: 'The content of the report.', }, resolved: { type: 'boolean' as const, nullable: false as const, optional: false as const, - description: 'Returns whether this report has been resolved', example: false }, reporterId: { type: 'string' as const, nullable: false as const, optional: false as const, format: 'id', - description: 'Reporter\'s user ID.' }, targetUserId: { type: 'string' as const, nullable: false as const, optional: false as const, format: 'id', - description: 'User ID of the person to be reported.' }, assigneeId: { type: 'string' as const, nullable: true as const, optional: false as const, format: 'id', - description: 'User ID of the person who responded to the report.' }, reporter: { type: 'object' as const, diff --git a/src/server/api/endpoints/admin/accounts/create.ts b/src/server/api/endpoints/admin/accounts/create.ts index e232031d35..bceb210a82 100644 --- a/src/server/api/endpoints/admin/accounts/create.ts +++ b/src/server/api/endpoints/admin/accounts/create.ts @@ -23,7 +23,6 @@ export const meta = { token: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Token to access this user.' } } } diff --git a/src/server/api/endpoints/admin/announcements/create.ts b/src/server/api/endpoints/admin/announcements/create.ts index 8d121c4843..794c35023b 100644 --- a/src/server/api/endpoints/admin/announcements/create.ts +++ b/src/server/api/endpoints/admin/announcements/create.ts @@ -29,35 +29,29 @@ export const meta = { type: 'string' as const, optional: false as const, nullable: false as const, format: 'id', - description: 'The unique identifier for this Announcement.', example: 'xxxxxxxxxx', }, createdAt: { type: 'string' as const, optional: false as const, nullable: false as const, format: 'date-time', - description: 'The date that the Announcement was created.' }, updatedAt: { type: 'string' as const, optional: false as const, nullable: true as const, format: 'date-time', - description: 'The date that the Announcement was updated.' }, title: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Announcement title.' }, text: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Announcement text.' }, imageUrl: { type: 'string' as const, optional: false as const, nullable: true as const, - description: 'Announcement image.' } } } diff --git a/src/server/api/endpoints/admin/announcements/list.ts b/src/server/api/endpoints/admin/announcements/list.ts index 94a830dbae..a14f0c0bdc 100644 --- a/src/server/api/endpoints/admin/announcements/list.ts +++ b/src/server/api/endpoints/admin/announcements/list.ts @@ -36,40 +36,33 @@ export const meta = { type: 'string' as const, optional: false as const, nullable: false as const, format: 'id', - description: 'The unique identifier for this Announcement.', example: 'xxxxxxxxxx', }, createdAt: { type: 'string' as const, optional: false as const, nullable: false as const, format: 'date-time', - description: 'The date that the Announcement was created.' }, updatedAt: { type: 'string' as const, optional: false as const, nullable: true as const, format: 'date-time', - description: 'The date that the Announcement was updated.' }, text: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Announcement text.' }, title: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Announcement title.' }, imageUrl: { type: 'string' as const, optional: false as const, nullable: true as const, - description: 'Announcement image.' }, reads: { type: 'number' as const, optional: false as const, nullable: false as const, - description: 'Number of people who read this announcement.' } } } diff --git a/src/server/api/endpoints/admin/drive/show-file.ts b/src/server/api/endpoints/admin/drive/show-file.ts index cfe25306c2..3489e5c816 100644 --- a/src/server/api/endpoints/admin/drive/show-file.ts +++ b/src/server/api/endpoints/admin/drive/show-file.ts @@ -36,20 +36,17 @@ export const meta = { type: 'string' as const, optional: false as const, nullable: false as const, format: 'id', - description: 'The unique identifier for this Drive file.', example: 'xxxxxxxxxx', }, createdAt: { type: 'string' as const, optional: false as const, nullable: false as const, format: 'date-time', - description: 'The date that the Drive file was created on Misskey.' }, userId: { type: 'string' as const, optional: false as const, nullable: true as const, format: 'id', - description: 'Owner ID of this Drive file.', example: 'xxxxxxxxxx', }, userHost: { @@ -60,25 +57,21 @@ export const meta = { type: 'string' as const, optional: false as const, nullable: false as const, format: 'md5', - description: 'The MD5 hash of this Drive file.', example: '15eca7fba0480996e2245f5185bf39f2' }, name: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'The file name with extension.', example: 'lenna.jpg' }, type: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'The MIME type of this Drive file.', example: 'image/jpeg' }, size: { type: 'number' as const, optional: false as const, nullable: false as const, - description: 'The size of this Drive file. (bytes)', example: 51469 }, comment: { @@ -113,41 +106,34 @@ export const meta = { storedInternal: { type: 'boolean' as const, optional: false as const, nullable: true as const, - description: 'Indicates whether this file is stored in the same location as Misskey itself', example: true }, url: { type: 'string' as const, optional: false as const, nullable: true as const, format: 'url', - description: 'The URL of this Drive file.', }, thumbnailUrl: { type: 'string' as const, optional: false as const, nullable: true as const, format: 'url', - description: 'The thumbnail URL of this Drive file.', }, webpublicUrl: { type: 'string' as const, optional: false as const, nullable: true as const, format: 'url', - description: 'The public URL of this Drive file.', }, accessKey: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Access key to access this file' }, thumbnailAccessKey: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Access key to access this file for thumbnail' }, webpublicAccessKey: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Access key to access this file for webpublic' }, uri: { type: 'string' as const, @@ -161,13 +147,11 @@ export const meta = { type: 'string' as const, optional: false as const, nullable: true as const, format: 'id', - description: 'The parent folder ID of this Drive file.', example: 'xxxxxxxxxx', }, isSensitive: { type: 'boolean' as const, optional: false as const, nullable: false as const, - description: 'Whether this Drive file is sensitive.', }, isLink: { type: 'boolean' as const, diff --git a/src/server/api/endpoints/admin/emoji/copy.ts b/src/server/api/endpoints/admin/emoji/copy.ts index 7807809720..1a784f4061 100644 --- a/src/server/api/endpoints/admin/emoji/copy.ts +++ b/src/server/api/endpoints/admin/emoji/copy.ts @@ -36,7 +36,6 @@ export const meta = { 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 f1cfbdd3e2..570db064ec 100644 --- a/src/server/api/endpoints/admin/emoji/list-remote.ts +++ b/src/server/api/endpoints/admin/emoji/list-remote.ts @@ -47,12 +47,10 @@ export const meta = { 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 @@ -61,22 +59,18 @@ export const meta = { 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 3f3e49396b..b864fed4b0 100644 --- a/src/server/api/endpoints/admin/emoji/list.ts +++ b/src/server/api/endpoints/admin/emoji/list.ts @@ -42,12 +42,10 @@ export const meta = { 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 @@ -56,22 +54,18 @@ export const meta = { 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/invite.ts b/src/server/api/endpoints/admin/invite.ts index 8ce6415218..141f27d95e 100644 --- a/src/server/api/endpoints/admin/invite.ts +++ b/src/server/api/endpoints/admin/invite.ts @@ -18,7 +18,6 @@ export const meta = { code: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Give this code to the applicant for registration.', example: '2ERUA5VR', maxLength: 8, minLength: 8 diff --git a/src/server/api/endpoints/admin/logs.ts b/src/server/api/endpoints/admin/logs.ts index e719ce19c7..1ec7320399 100644 --- a/src/server/api/endpoints/admin/logs.ts +++ b/src/server/api/endpoints/admin/logs.ts @@ -37,14 +37,12 @@ export const meta = { type: 'string' as const, optional: false as const, nullable: false as const, format: 'id', - description: 'The unique identifier for this log.', example: 'xxxxxxxxxx', }, createdAt: { type: 'string' as const, optional: false as const, nullable: false as const, format: 'date-time', - description: 'The date that the Drive file was created on Misskey.' }, domain: { type: 'array' as const, @@ -65,12 +63,10 @@ export const meta = { machine: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'The name of the running machine.' }, message: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Log body.' }, data: { type: 'object' as const, diff --git a/src/server/api/endpoints/admin/queue/deliver-delayed.ts b/src/server/api/endpoints/admin/queue/deliver-delayed.ts index 8b70fa6680..cd7b640983 100644 --- a/src/server/api/endpoints/admin/queue/deliver-delayed.ts +++ b/src/server/api/endpoints/admin/queue/deliver-delayed.ts @@ -21,11 +21,9 @@ export const meta = { anyOf: [ { type: 'string' as const, - description: 'FQDN to fediverse server' }, { type: 'number' as const, - description: 'Delayed queue counts' } ] } diff --git a/src/server/api/endpoints/admin/queue/inbox-delayed.ts b/src/server/api/endpoints/admin/queue/inbox-delayed.ts index 437027eea8..119976c680 100644 --- a/src/server/api/endpoints/admin/queue/inbox-delayed.ts +++ b/src/server/api/endpoints/admin/queue/inbox-delayed.ts @@ -21,11 +21,9 @@ export const meta = { anyOf: [ { type: 'string' as const, - description: 'FQDN to fediverse server' }, { type: 'number' as const, - description: 'Delayed queue counts' } ] } diff --git a/src/server/api/endpoints/admin/server-info.ts b/src/server/api/endpoints/admin/server-info.ts index 1373802f3e..bb2d35e397 100644 --- a/src/server/api/endpoints/admin/server-info.ts +++ b/src/server/api/endpoints/admin/server-info.ts @@ -20,23 +20,19 @@ export const meta = { machine: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'The name of the running server' }, os: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'OS used by the server', example: 'linux' }, node: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Version of Node.js' }, psql: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Version of Postgresql' }, cpu: { type: 'object' as const, @@ -45,12 +41,10 @@ export const meta = { model: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'The name of the CPU you are using' }, cores: { type: 'number' as const, optional: false as const, nullable: false as const, - description: 'Number of CPU cores used (number of logical processors)' } } }, @@ -62,7 +56,6 @@ export const meta = { type: 'number' as const, optional: false as const, nullable: false as const, format: 'bytes', - description: 'RAM capacity.' } } }, @@ -74,13 +67,11 @@ export const meta = { type: 'number' as const, optional: false as const, nullable: false as const, format: 'bytes', - description: 'Total storage capacity.' }, used: { type: 'number' as const, optional: false as const, nullable: false as const, format: 'bytes', - description: 'Amount of storage used' } } }, @@ -91,7 +82,6 @@ export const meta = { interface: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'The interface name of your network.', example: 'eth0' } } diff --git a/src/server/api/endpoints/announcements.ts b/src/server/api/endpoints/announcements.ts index f5d07d8080..124682909c 100644 --- a/src/server/api/endpoints/announcements.ts +++ b/src/server/api/endpoints/announcements.ts @@ -40,40 +40,33 @@ export const meta = { type: 'string' as const, optional: false as const, nullable: false as const, format: 'id', - description: 'The unique identifier for this Announcement.', example: 'xxxxxxxxxx', }, createdAt: { type: 'string' as const, optional: false as const, nullable: false as const, format: 'date-time', - description: 'The date that the Announcement was created.' }, updatedAt: { type: 'string' as const, optional: false as const, nullable: true as const, format: 'date-time', - description: 'The date that the Announcement was updated.' }, text: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Announcement text.' }, title: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'Announcement title.' }, imageUrl: { type: 'string' as const, optional: false as const, nullable: true as const, - description: 'Announcement image.' }, isRead: { type: 'boolean' as const, optional: false as const, nullable: false as const, - description: 'Indicates that you have read this announcement' } } } diff --git a/src/server/api/endpoints/auth/session/generate.ts b/src/server/api/endpoints/auth/session/generate.ts index ca004e9b19..42f9e25c78 100644 --- a/src/server/api/endpoints/auth/session/generate.ts +++ b/src/server/api/endpoints/auth/session/generate.ts @@ -24,13 +24,11 @@ export const meta = { token: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'セッションのトークン' }, url: { type: 'string' as const, optional: false as const, nullable: false as const, format: 'url', - description: 'セッションのURL' }, } }, diff --git a/src/server/api/endpoints/auth/session/userkey.ts b/src/server/api/endpoints/auth/session/userkey.ts index e015be20eb..7059aacbea 100644 --- a/src/server/api/endpoints/auth/session/userkey.ts +++ b/src/server/api/endpoints/auth/session/userkey.ts @@ -25,14 +25,12 @@ export const meta = { accessToken: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'ユーザーのアクセストークン', }, user: { type: 'object' as const, optional: false as const, nullable: false as const, ref: 'User', - description: '認証したユーザー' }, } }, diff --git a/src/server/api/endpoints/blocking/delete.ts b/src/server/api/endpoints/blocking/delete.ts index 71927fa727..28776727a5 100644 --- a/src/server/api/endpoints/blocking/delete.ts +++ b/src/server/api/endpoints/blocking/delete.ts @@ -53,7 +53,6 @@ export const meta = { type: 'string' as const, optional: false as const, nullable: false as const, format: 'id', - description: 'The unique identifier for this blocking.', example: 'xxxxxxxxxx', }, name: { diff --git a/src/server/api/endpoints/meta.ts b/src/server/api/endpoints/meta.ts index e7a6a401d8..dd75149ad2 100644 --- a/src/server/api/endpoints/meta.ts +++ b/src/server/api/endpoints/meta.ts @@ -33,13 +33,11 @@ export const meta = { version: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'The version of Misskey of this instance.', example: config.version }, name: { type: 'string' as const, optional: false as const, nullable: false as const, - description: 'The name of this instance.', }, uri: { type: 'string' as const, @@ -50,7 +48,6 @@ export const meta = { description: { type: 'string' as const, optional: false as const, nullable: true as const, - description: 'The description of this instance.', }, langs: { type: 'array' as const, @@ -82,17 +79,14 @@ export const meta = { disableRegistration: { type: 'boolean' as const, optional: false as const, nullable: false as const, - description: 'Whether disabled open registration.', }, disableLocalTimeline: { type: 'boolean' as const, optional: false as const, nullable: false as const, - description: 'Whether disabled LTL and STL.', }, disableGlobalTimeline: { type: 'boolean' as const, optional: false as const, nullable: false as const, - description: 'Whether disabled GTL.', }, driveCapacityPerLocalUserMb: { type: 'number' as const, diff --git a/src/server/api/endpoints/notes/create.ts b/src/server/api/endpoints/notes/create.ts index beeacb5374..ddb5c953ec 100644 --- a/src/server/api/endpoints/notes/create.ts +++ b/src/server/api/endpoints/notes/create.ts @@ -125,7 +125,6 @@ export const meta = { type: 'object' as const, optional: false as const, nullable: false as const, ref: 'Note', - description: '作成した投稿' } } }, diff --git a/src/server/api/endpoints/room/show.ts b/src/server/api/endpoints/room/show.ts index 7b2526c313..85cd57aef4 100644 --- a/src/server/api/endpoints/room/show.ts +++ b/src/server/api/endpoints/room/show.ts @@ -59,7 +59,6 @@ export const meta = { props: { type: 'object' as const, optional: true as const, nullable: false as const, - description: 'Properties vary depending on the furniture' }, position: { type: 'object' as const, diff --git a/src/server/api/endpoints/stats.ts b/src/server/api/endpoints/stats.ts index 748c612564..f9c17f86eb 100644 --- a/src/server/api/endpoints/stats.ts +++ b/src/server/api/endpoints/stats.ts @@ -17,27 +17,22 @@ export const meta = { notesCount: { type: 'number' as const, optional: false as const, nullable: false as const, - description: 'The count of all (local/remote) notes of this instance.', }, originalNotesCount: { type: 'number' as const, optional: false as const, nullable: false as const, - description: 'The count of all local notes of this instance.', }, usersCount: { type: 'number' as const, optional: false as const, nullable: false as const, - description: 'The count of all (local/remote) accounts of this instance.', }, originalUsersCount: { type: 'number' as const, optional: false as const, nullable: false as const, - description: 'The count of all local accounts of this instance.', }, instances: { type: 'number' as const, optional: false as const, nullable: false as const, - description: 'The count of federated instances.', }, driveUsageLocal: { type: 'number' as const, diff --git a/src/server/api/endpoints/username/available.ts b/src/server/api/endpoints/username/available.ts index 5b51d7e176..cd434b582e 100644 --- a/src/server/api/endpoints/username/available.ts +++ b/src/server/api/endpoints/username/available.ts @@ -20,7 +20,6 @@ export const meta = { available: { type: 'boolean' as const, optional: false as const, nullable: false as const, - description: 'Returns true if the username is not used.' } } } |