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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
import {
extendZodWithOpenApi,
OpenAPIRegistry,
} from "@asteasolutions/zod-to-openapi";
import { z } from "zod";
import { zBackupSchema } from "@karakeep/shared/types/backups";
import { BearerAuth } from "./common";
import { ErrorSchema } from "./errors";
export const registry = new OpenAPIRegistry();
extendZodWithOpenApi(z);
export const BackupIdSchema = registry.registerParameter(
"BackupId",
z.string().openapi({
param: {
name: "backupId",
in: "path",
},
example: "ieidlxygmwj87oxz5hxttoc8",
}),
);
registry.registerPath({
method: "get",
path: "/backups",
description: "Get all backups",
summary: "Get all backups",
tags: ["Backups"],
security: [{ [BearerAuth.name]: [] }],
responses: {
200: {
description: "Object with all backups data.",
content: {
"application/json": {
schema: z.object({
backups: z.array(zBackupSchema),
}),
},
},
},
},
});
registry.registerPath({
method: "post",
path: "/backups",
description: "Trigger a new backup",
summary: "Trigger a new backup",
tags: ["Backups"],
security: [{ [BearerAuth.name]: [] }],
responses: {
201: {
description: "Backup created successfully",
content: {
"application/json": {
schema: zBackupSchema,
},
},
},
},
});
registry.registerPath({
method: "get",
path: "/backups/{backupId}",
description: "Get backup by its id",
summary: "Get a single backup",
tags: ["Backups"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ backupId: BackupIdSchema }),
},
responses: {
200: {
description: "Object with backup data.",
content: {
"application/json": {
schema: zBackupSchema,
},
},
},
404: {
description: "Backup not found",
content: {
"application/json": {
schema: ErrorSchema,
},
},
},
},
});
registry.registerPath({
method: "get",
path: "/backups/{backupId}/download",
description: "Download backup file",
summary: "Download a backup",
tags: ["Backups"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ backupId: BackupIdSchema }),
},
responses: {
200: {
description: "Backup file (zip archive)",
content: {
"application/zip": {
schema: z.instanceof(Blob),
},
},
},
404: {
description: "Backup not found",
content: {
"application/json": {
schema: ErrorSchema,
},
},
},
},
});
registry.registerPath({
method: "delete",
path: "/backups/{backupId}",
description: "Delete backup by its id",
summary: "Delete a backup",
tags: ["Backups"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ backupId: BackupIdSchema }),
},
responses: {
204: {
description: "No content - the backup was deleted",
},
404: {
description: "Backup not found",
content: {
"application/json": {
schema: ErrorSchema,
},
},
},
},
});
|
