summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/admin/queue/jobs.ts
diff options
context:
space:
mode:
authorYuzuRyo61 <yuzuryo61@yuzulia.work>2021-03-06 22:34:11 +0900
committerGitHub <noreply@github.com>2021-03-06 22:34:11 +0900
commita07d753da84191bc8c185a7bcd6d73fab9529b5d (patch)
tree085bc62b1f979020796a73373c3050f4948ed2bd /src/server/api/endpoints/admin/queue/jobs.ts
parentfeat: video play inline (using video tag) (#7242) (diff)
downloadsharkey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.tar.gz
sharkey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.tar.bz2
sharkey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.zip
APIドキュメントの改善 (#6757)
* 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 <Syuilotan@yahoo.co.jp>
Diffstat (limited to 'src/server/api/endpoints/admin/queue/jobs.ts')
-rw-r--r--src/server/api/endpoints/admin/queue/jobs.ts37
1 files changed, 37 insertions, 0 deletions
diff --git a/src/server/api/endpoints/admin/queue/jobs.ts b/src/server/api/endpoints/admin/queue/jobs.ts
index 0cd3f40d4e..5ab78e3c48 100644
--- a/src/server/api/endpoints/admin/queue/jobs.ts
+++ b/src/server/api/endpoints/admin/queue/jobs.ts
@@ -3,6 +3,11 @@ import define from '../../../define';
import { deliverQueue, inboxQueue, dbQueue, objectStorageQueue } from '../../../../../queue';
export const meta = {
+ desc: {
+ 'ja-JP': 'ジョブ一覧を表示します。',
+ 'en-US': 'Display the job list.'
+ },
+
tags: ['admin'],
requireCredential: true as const,
@@ -21,6 +26,38 @@ export const meta = {
validator: $.optional.num,
default: 50
},
+ },
+
+ 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'
+ },
+ data: {
+ type: 'object' as const,
+ optional: false as const, nullable: false as const
+ },
+ attempts: {
+ type: 'number' as const,
+ optional: false as const, nullable: false as const
+ },
+ maxAttempts: {
+ type: 'number' as const,
+ optional: false as const, nullable: false as const
+ },
+ timestamp: {
+ type: 'number' as const,
+ optional: false as const, nullable: false as const
+ }
+ }
+ }
}
};