aboutsummaryrefslogtreecommitdiffstats
path: root/packages/open-api/lib/pagination.ts
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-10-11 18:16:06 +0000
committerMohamed Bassem <me@mbassem.com>2025-10-11 18:16:06 +0000
commit7f138b99d4cbb3495dd25d59df2fa767dacc1d35 (patch)
tree84ef68cc2a044064b054b5af5d5fc1ebc5897496 /packages/open-api/lib/pagination.ts
parent87053d2e76a362da9ee417110195ec02673080fd (diff)
downloadkarakeep-7f138b99d4cbb3495dd25d59df2fa767dacc1d35.tar.zst
fix(api): Document the API for getting lists of a bookmark. fixes #2030
Diffstat (limited to 'packages/open-api/lib/pagination.ts')
-rw-r--r--packages/open-api/lib/pagination.ts40
1 files changed, 7 insertions, 33 deletions
diff --git a/packages/open-api/lib/pagination.ts b/packages/open-api/lib/pagination.ts
index 382f00ef..40d440f0 100644
--- a/packages/open-api/lib/pagination.ts
+++ b/packages/open-api/lib/pagination.ts
@@ -1,33 +1,7 @@
-import { extendZodWithOpenApi } from "@asteasolutions/zod-to-openapi";
-import { z } from "zod";
-
-import { zBookmarkSchema } from "@karakeep/shared/types/bookmarks";
-
-extendZodWithOpenApi(z);
-
-export const BookmarkSchema = zBookmarkSchema.openapi("Bookmark");
-
-export const PaginatedBookmarksSchema = z
- .object({
- bookmarks: z.array(BookmarkSchema),
- nextCursor: z.string().nullable(),
- })
- .openapi("PaginatedBookmarks");
-
-export const CursorSchema = z.string().openapi("Cursor");
-
-export const PaginationSchema = z
- .object({
- limit: z.number().optional(),
- cursor: CursorSchema.optional(),
- })
- .openapi("Pagination");
-
-export const IncludeContentSearchParamSchema = z.object({
- includeContent: z
- .boolean()
- .default(true)
- .describe(
- "If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks.",
- ),
-});
+export {
+ BookmarkSchema,
+ CursorSchema,
+ IncludeContentSearchParamSchema,
+ PaginatedBookmarksSchema,
+ PaginationSchema,
+} from "./types";