summaryrefslogtreecommitdiff
path: root/packages/backend/src/server/api/endpoints/admin/queue/queues.ts
blob: 8d27e38c8438be235fbc4bcb3e8a4cc2677a53f7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
 * SPDX-FileCopyrightText: syuilo and misskey-project
 * SPDX-License-Identifier: AGPL-3.0-only
 */

import { Injectable } from '@nestjs/common';
import { Endpoint } from '@/server/api/endpoint-base.js';
import { QUEUE_TYPES, QueueService } from '@/core/QueueService.js';

export const meta = {
	tags: ['admin'],

	requireCredential: true,
	requireModerator: true,
	kind: 'read:admin:queue',

	res: {
		type: 'array',
		optional: false, nullable: false,
		items: {
			type: 'object',
			optional: false, nullable: false,
			properties: {
				name: {
					type: 'string',
					optional: false, nullable: false,
					enum: QUEUE_TYPES,
				},
				counts: {
					type: 'object',
					optional: false, nullable: false,
					additionalProperties: {
						type: 'number',
					},
				},
				isPaused: {
					type: 'boolean',
					optional: false, nullable: false,
				},
				metrics: {
					type: 'object',
					optional: false, nullable: false,
					properties: {
						completed: {
							optional: false, nullable: false,
							ref: 'QueueMetrics',
						},
						failed: {
							optional: false, nullable: false,
							ref: 'QueueMetrics',
						},
					},
				},
			},
		},
	},
} as const;

export const paramDef = {
	type: 'object',
	properties: {
	},
	required: [],
} as const;

@Injectable()
export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-disable-line import/no-default-export
	constructor(
		private queueService: QueueService,
	) {
		super(meta, paramDef, async (ps, me) => {
			return this.queueService.queueGetQueues();
		});
	}
}