From 7f138b99d4cbb3495dd25d59df2fa767dacc1d35 Mon Sep 17 00:00:00 2001 From: Mohamed Bassem Date: Sat, 11 Oct 2025 18:16:06 +0000 Subject: fix(api): Document the API for getting lists of a bookmark. fixes #2030 --- packages/open-api/lib/pagination.ts | 40 +++++++------------------------------ 1 file changed, 7 insertions(+), 33 deletions(-) (limited to 'packages/open-api/lib/pagination.ts') 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"; -- cgit v1.2.3-70-g09d2