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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
import {
extendZodWithOpenApi,
OpenAPIRegistry,
} from "@asteasolutions/zod-to-openapi";
import { z } from "zod";
import {
zBookmarkListSchema,
zEditBookmarkListSchema,
zNewBookmarkListSchema,
} from "@karakeep/shared/types/lists";
import { BookmarkIdSchema } from "./bookmarks";
import { BearerAuth } from "./common";
import { PaginatedBookmarksSchema, PaginationSchema } from "./pagination";
export const registry = new OpenAPIRegistry();
extendZodWithOpenApi(z);
export const ListIdSchema = registry.registerParameter(
"ListId",
z.string().openapi({
param: {
name: "listId",
in: "path",
},
example: "ieidlxygmwj87oxz5hxttoc8",
}),
);
export const ListSchema = zBookmarkListSchema.openapi("List");
registry.registerPath({
method: "get",
path: "/lists",
description: "Get all lists",
summary: "Get all lists",
tags: ["Lists"],
security: [{ [BearerAuth.name]: [] }],
request: {},
responses: {
200: {
description: "Object with all lists data.",
content: {
"application/json": {
schema: z.object({
lists: z.array(ListSchema),
}),
},
},
},
},
});
registry.registerPath({
method: "post",
path: "/lists",
description: "Create a new list",
summary: "Create a new list",
tags: ["Lists"],
security: [{ [BearerAuth.name]: [] }],
request: {
body: {
description: "The list to create",
content: {
"application/json": {
schema: zNewBookmarkListSchema,
},
},
},
},
responses: {
201: {
description: "The created list",
content: {
"application/json": {
schema: ListSchema,
},
},
},
},
});
registry.registerPath({
method: "get",
path: "/lists/{listId}",
description: "Get list by its id",
summary: "Get a single list",
tags: ["Lists"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ listId: ListIdSchema }),
},
responses: {
200: {
description: "Object with list data.",
content: {
"application/json": {
schema: ListSchema,
},
},
},
},
});
registry.registerPath({
method: "delete",
path: "/lists/{listId}",
description: "Delete list by its id",
summary: "Delete a list",
tags: ["Lists"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ listId: ListIdSchema }),
},
responses: {
204: {
description: "No content - the bookmark was deleted",
},
},
});
registry.registerPath({
method: "patch",
path: "/lists/{listId}",
description: "Update list by its id",
summary: "Update a list",
tags: ["Lists"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ listId: ListIdSchema }),
body: {
description:
"The data to update. Only the fields you want to update need to be provided.",
content: {
"application/json": {
schema: zEditBookmarkListSchema.omit({ listId: true }),
},
},
},
},
responses: {
200: {
description: "The updated list",
content: {
"application/json": {
schema: ListSchema,
},
},
},
},
});
registry.registerPath({
method: "get",
path: "/lists/{listId}/bookmarks",
description: "Get the bookmarks in a list",
summary: "Get a bookmarks in a list",
tags: ["Lists"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ listId: ListIdSchema }),
query: PaginationSchema,
},
responses: {
200: {
description: "Object with list data.",
content: {
"application/json": {
schema: PaginatedBookmarksSchema,
},
},
},
},
});
registry.registerPath({
method: "put",
path: "/lists/{listId}/bookmarks/{bookmarkId}",
description: "Add the bookmarks to a list",
summary: "Add a bookmark to a list",
tags: ["Lists"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ listId: ListIdSchema, bookmarkId: BookmarkIdSchema }),
},
responses: {
204: {
description: "No content - the bookmark was added",
},
},
});
registry.registerPath({
method: "delete",
path: "/lists/{listId}/bookmarks/{bookmarkId}",
description: "Remove the bookmarks from a list",
summary: "Remove a bookmark from a list",
tags: ["Lists"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ listId: ListIdSchema, bookmarkId: BookmarkIdSchema }),
},
responses: {
204: {
description: "No content - the bookmark was added",
},
},
});
|
