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
|
import {
extendZodWithOpenApi,
OpenAPIRegistry,
} from "@asteasolutions/zod-to-openapi";
import { z } from "zod";
import {
zHighlightSchema,
zNewHighlightSchema,
zUpdateHighlightSchema,
} from "@karakeep/shared/types/highlights";
import { BearerAuth } from "./common";
import { ErrorSchema } from "./errors";
import { PaginationSchema } from "./pagination";
export const registry = new OpenAPIRegistry();
extendZodWithOpenApi(z);
export const HighlightSchema = zHighlightSchema.openapi("Highlight");
export const PaginatedHighlightsSchema = z
.object({
highlights: z.array(HighlightSchema),
nextCursor: z.string().nullable(),
})
.openapi("PaginatedHighlights");
export const HighlightIdSchema = registry.registerParameter(
"HighlightId",
z.string().openapi({
param: {
name: "highlightId",
in: "path",
},
example: "ieidlxygmwj87oxz5hxttoc8",
}),
);
registry.registerPath({
method: "get",
path: "/highlights",
description: "Get all highlights",
summary: "Get all highlights",
tags: ["Highlights"],
security: [{ [BearerAuth.name]: [] }],
request: {
query: PaginationSchema,
},
responses: {
200: {
description: "Object with all highlights data.",
content: {
"application/json": {
schema: PaginatedHighlightsSchema,
},
},
},
},
});
registry.registerPath({
method: "post",
path: "/highlights",
description: "Create a new highlight",
summary: "Create a new highlight",
tags: ["Highlights"],
security: [{ [BearerAuth.name]: [] }],
request: {
body: {
description: "The highlight to create",
content: {
"application/json": {
schema: zNewHighlightSchema,
},
},
},
},
responses: {
201: {
description: "The created highlight",
content: {
"application/json": {
schema: HighlightSchema,
},
},
},
400: {
description: "Bad highlight request",
content: {
"application/json": {
schema: ErrorSchema,
},
},
},
404: {
description: "Bookmark not found",
content: {
"application/json": {
schema: ErrorSchema,
},
},
},
},
});
registry.registerPath({
method: "get",
path: "/highlights/{highlightId}",
description: "Get highlight by its id",
summary: "Get a single highlight",
tags: ["Highlights"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ highlightId: HighlightIdSchema }),
},
responses: {
200: {
description: "Object with highlight data.",
content: {
"application/json": {
schema: HighlightSchema,
},
},
},
404: {
description: "Highlight not found",
content: {
"application/json": {
schema: ErrorSchema,
},
},
},
},
});
registry.registerPath({
method: "delete",
path: "/highlights/{highlightId}",
description: "Delete highlight by its id",
summary: "Delete a highlight",
tags: ["Highlights"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ highlightId: HighlightIdSchema }),
},
responses: {
200: {
description: "The deleted highlight",
content: {
"application/json": {
schema: HighlightSchema,
},
},
},
404: {
description: "Highlight not found",
content: {
"application/json": {
schema: ErrorSchema,
},
},
},
},
});
registry.registerPath({
method: "patch",
path: "/highlights/{highlightId}",
description: "Update highlight by its id",
summary: "Update a highlight",
tags: ["Highlights"],
security: [{ [BearerAuth.name]: [] }],
request: {
params: z.object({ highlightId: HighlightIdSchema }),
body: {
description:
"The data to update. Only the fields you want to update need to be provided.",
content: {
"application/json": {
schema: zUpdateHighlightSchema.omit({ highlightId: true }),
},
},
},
},
responses: {
200: {
description: "The updated highlight",
content: {
"application/json": {
schema: HighlightSchema,
},
},
},
404: {
description: "Highlight not found",
content: {
"application/json": {
schema: ErrorSchema,
},
},
},
},
});
|
