summaryrefslogtreecommitdiff
path: root/packages/backend/src/models/json-schema/announcement.ts
blob: b9352bd31e61744adde56515932ccc0d80aa1d3b (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
/*
 * SPDX-FileCopyrightText: syuilo and misskey-project
 * SPDX-License-Identifier: AGPL-3.0-only
 */

export const packedAnnouncementSchema = {
	type: 'object',
	properties: {
		id: {
			type: 'string',
			optional: false, nullable: false,
			format: 'id',
			example: 'xxxxxxxxxx',
		},
		createdAt: {
			type: 'string',
			optional: false, nullable: false,
			format: 'date-time',
		},
		updatedAt: {
			type: 'string',
			optional: false, nullable: true,
			format: 'date-time',
		},
		text: {
			type: 'string',
			optional: false, nullable: false,
		},
		title: {
			type: 'string',
			optional: false, nullable: false,
		},
		imageUrl: {
			type: 'string',
			optional: false, nullable: true,
		},
		icon: {
			type: 'string',
			optional: false, nullable: false,
			enum: ['info', 'warning', 'error', 'success'],
		},
		display: {
			type: 'string',
			optional: false, nullable: false,
			enum: ['dialog', 'normal', 'banner'],
		},
		needConfirmationToRead: {
			type: 'boolean',
			optional: false, nullable: false,
		},
		silence: {
			type: 'boolean',
			optional: false, nullable: false,
		},
		forYou: {
			type: 'boolean',
			optional: false, nullable: false,
		},
		isRead: {
			type: 'boolean',
			optional: true, nullable: false,
		},
	},
} as const;