mirror of
https://github.com/karakeep-app/karakeep.git
synced 2026-10-26 09:15:12 +01:00
Mohamed BassemandClaude
dd2c6cc087
* docs(open-api): improve OpenAPI documentation across all endpoints - Add rich API-level description with authentication, pagination, and bookmark type documentation - Add tag descriptions for all endpoint groups (Bookmarks, Lists, Tags, Highlights, Assets, Users, Admin, Backups) - Add operationId to all 27+ endpoints for better SDK generation - Add 401 Unauthorized responses to all authenticated endpoints - Add descriptions to all path parameters (bookmarkId, listId, tagId, highlightId, assetId, backupId) - Add descriptions to query parameters (archived, favourited, sortOrder, q, url, includeContent, limit, cursor) - Add descriptions to response fields (nextCursor, assetId, contentType, etc.) - Improve endpoint descriptions to differentiate summary (short) from description (detailed with behavior notes) - Fix copy-paste errors: "list data" -> "tag data" in tag endpoints, "bookmark was deleted" -> "tag/list was deleted" in delete endpoints, "list of highlights" -> "lists" in bookmark lists endpoint, "bookmark was added" -> "bookmark was removed" in remove endpoint - Use shared ErrorSchema and UnauthorizedResponse for consistent error formatting across admin endpoints - Regenerate karakeep-openapi-spec.json https://claude.ai/code/session_018vMw4uU3TUbR9uueHSR4kP * update api --------- Co-authored-by: Claude <noreply@anthropic.com>