diff options
Diffstat (limited to 'docs/versioned_docs/version-v0.24.0/API')
35 files changed, 2633 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.24.0/API/add-a-bookmark-to-a-list.api.mdx b/docs/versioned_docs/version-v0.24.0/API/add-a-bookmark-to-a-list.api.mdx new file mode 100644 index 00000000..45420ed5 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/add-a-bookmark-to-a-list.api.mdx @@ -0,0 +1,71 @@ +--- +id: add-a-bookmark-to-a-list +title: "Add a bookmark to a list" +description: "Add the bookmarks to a list" +sidebar_label: "Add a bookmark to a list" +hide_title: true +hide_table_of_contents: true +api: eJzNVE1v2zAM/SsCTxug1enQYYVv2WFAt2EothQ7BD4wFhOrsS1Vkttkhv77QNnNR5t1l2HYybb8KD4+PrIHRb502gZtWshhqpQIFYmFMesG3dqLYASKWvsAEgKuPORz+KJ98FBI8FR2Toct5PMeFoSO3LQLFeTzIhYSLDpsKJDzCeDLihqEvIewtQQ5+OB0uwIJtMHG1nykSat6s101D7eX783m57tqE4IpLzm7DgnC2a8URAmO7jrtSEEeXEcSWmwYUA8ACZpLshgqiPKvpf8wSvMihcUedESj4AhvTevJM5O3kwt+HDfhqxGlaQO1Qbw56oZ4QC9QKUqpLyaT57GP7ATWjlBthW4fuzfeyTFoba1L5Jjs1nPgCXnM4pZKDrTOWHJBD5RLo+i5iFFCQ97j6tS/I53mww17fBFjTOWckIJ7LYzbK9CaIJama9X/XlCKD5VR3PsuZWUH5JBxO3zWDy6N2W7Usn7vmgg8XO7+cXQ6V0MOPSrlyPuYodXZ/TlIuEencVEPlYy/BxmX2NUBcqhCsD7PsuC2Z2t0uCayZ2gtyCdazyoS4w3CLJPxPo94MXCBGOPB1H9ngYfMh7O/U4szcx0JxkORQCDHl4/GNcgMP/2YJUl1uzQczlUPlM7PJmeTg9nb8ZleX53kP72+EkvjjslzsVGCNT40mKwxTilvO9x763DVHV3d7632pw05VB5oEzJbo245cWpeP/Z/ntaTBwn5bk/t7uLTg9VRSKiMDxzU9wv0dOPqGPn4riPHW7fYOyD5RGnP7wryJdaeXqjj1bfRwK/F73iPh9huk9Hqjr9Awpq2+y3Lm/UfZj1QJxZRQkWoyKXaB8C0LMmGg9Bnq4EtvBvN65sZSMBj4z4xarr9JK2+HxAzs6Y2xh3LwN9MMMZf8DSFoA== +sidebar_class_name: "put api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Add a bookmark to a list"} +> +</Heading> + +<MethodEndpoint + method={"put"} + path={"/lists/{listId}/bookmarks/{bookmarkId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Add the bookmarks to a list + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"},{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"204":{"description":"No content - the bookmark was added"},"400":{"description":"Bookmark already in list","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}},"404":{"description":"List or bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/attach-asset.api.mdx b/docs/versioned_docs/version-v0.24.0/API/attach-asset.api.mdx new file mode 100644 index 00000000..00146e1f --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/attach-asset.api.mdx @@ -0,0 +1,71 @@ +--- +id: attach-asset +title: "Attach asset" +description: "Attach a new asset to a bookmark" +sidebar_label: "Attach asset" +hide_title: true +hide_table_of_contents: true +api: eJztVcFu2zgQ/RVhTi3AjZJFF1vo5hYtkN3DBo2LHgwdxuLYYiyRLEnF9gr892IoOZIbN+ihx14EafQ4nPf4ZtiDJF85ZYMyGgpYhIBVnWGmaZ+h9xSyYDLM1sbsWnQ7EBBw66FYwbsx5KEU4KnqnApHKFY9rAkduUUXaihWZSwFWHTYUiDnE8BXNbUIRQ/haAkK8MEpvQUBdMDWNhxSpGRzOG7b/cPbv83h/7/qQwimessVqJAgpwpuJUQBjr52ypGEIriOBGhsGbSeQAIUc7QYauCqeAX58M7II9dyrsSyppkASRYQUBkdSAeGo7WNqpDh+YPnNReImfUDVQEEWGcsuaDI818ln5OPAtJ+yxS9II3uWtbdV45I+9pw2rTifh5Zo9bkblvcEgjYdE1zh1tauKpWjxx5VJIM40ZdFpwhFUiVw31DcsJ2eqfNXkMZz/Rdcf3zassYB4S3RvuB4p/XNz8QNWlJclD3t6Yva/rm+s1zGU/Gz7QJ2cZ0Wv46GSsjL0gVBbTkPQvw/N93RFKGCZ+IpPWhNpL7z/i0LbdhAflJNJ/3U6/GPCnhgUeLezwNjs41UECPUjryPuZoVf54wyeATuG6GSiMvwfdNtg1AQqoQ7C+yPPgjlc7dLgjsldoLYhLHh0yZGaThZqyf0d8NtQCMcbZzLtnZYed55PvSSbemXkkGE+kBGK7pJePxrXIFf7zZZm05BP7NI2mD6eROFh8Mu/M2XMDRx5zG8N41m0gdXN1fXU9G51PjBZ3txcVWNzdZhvjzumzXFGkA2wxuWocsqdrY/T9Wbp+cuZPXS8DoUCHkNsGleYd07n3o2VWT33G9ijOBvzomlJAzS4rVtD3a/T02TUxcvhrR45vqXLyTHKWVJ7fJRQbbDy9wOHVp9Hrr7MflTsGUR+TNZuOv0DAjo7nN1Iso4CaUJJLVQyA98Nef6SznRI86+ooTisWVUU2vIgtZx1499/9Mo2r4eJrU8uDwz2I9EzFmsQ92TrFemhQb7s0AmDIyW7Fc7N/Z+7E6qIcfT8glmZHOsYndQJ/szAxfgPFevk9 +sidebar_class_name: "post api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Attach asset"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/bookmarks/{bookmarkId}/assets"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Attach a new asset to a bookmark + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The asset to attach","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"The attached asset","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/attach-tags-to-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.24.0/API/attach-tags-to-a-bookmark.api.mdx new file mode 100644 index 00000000..426301a6 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/attach-tags-to-a-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +id: attach-tags-to-a-bookmark +title: "Attach tags to a bookmark" +description: "Attach tags to a bookmark" +sidebar_label: "Attach tags to a bookmark" +hide_title: true +hide_table_of_contents: true +api: eJytVU2P0zAQ/SvRnEAyTUEgUG4FgbQgwQqKOFQ9TJNp420SG3uytET572icr5aWFUL0UCXO83jmzZvnBjLyqdOWtakggQUzpnnEuPMRmwijjTH7Et0eFMgiJCt43S95WCvwlNZO8xGSVQMbQkduUXMOyWrdrhVYdFgSk/MB4NOcSoSkAT5aggQ8O13tQAEdsLSFLGnSWXE47sofd69emsPPF/mB2aSvJAPNATJkcJNBq8DR91o7yiBhV5OCCksBbSaQAi3FWeQcJCvZQZ5fm+wouZxTsMxpqj/QMQMFqamYKhY4WlvoFAUe33nZc6Uws7mjlEGBdcaSY00+fA0cjih0Do+SHlPp/2r3TXbJXht68zGUffFNfqccrboc1sO6t6byXfhn8/l1OgrtOTLbng7KhJ9IZ/7/8TJE/gtu/k0yy0DdBRfjuT0fz+fPLykY5BZVhqOtqavs/xWemuxa1xSU5D3urnb0vIQQYcKv+46XxLnJRPXGh2NF/AnEw1j4uJkmpI2DKGSc3f0wrLUrIIEGs8yR922MVsf3T0HBPTqNm6LvXPe5Y22LdcGQQM5sfRLH7I6zPTrcE9kZWgvqirr6CCIwzin60OOjLhfp2YnPfBFeu5NP3WYkSU6WOgJMXCCAQPUP74wrUTJ8/20ZmJR+fZ7s4O2gqWFUV+PUTcIbh21syboVi9ka2Sf8dcU9nc1n8xMNjpUtbm+uMrG4vYm2xp3TILS1KrSxxKCt3uAe8uqz2M0k1ocNvqOQ6cCxLVBXcm5QQdPLZzW6qoglObPYzlYU5KK3ZAVNs0FPX13RtrL8vSYnt8R60k9gN9NenjNItlh4eiD1R5971T+O/pTsYB3VMci0qOUNFOzpeH4jhI7lhBm5kEUHeNOd9WQpYaYAF/PdqmHHIk3J8oPY9cks3n76shQt9hdPGYYfHP4AFf5DsibUHiQe1hoosNrVwQygiynKxXPh/yb0TrnX6GiaDrE0e6radmSH5V2IadtfmYTHdA== +sidebar_class_name: "post api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Attach tags to a bookmark"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/bookmarks/{bookmarkId}/tags"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Attach tags to a bookmark + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The tags to attach.","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"tagId":{"type":"string"},"tagName":{"type":"string"}}}}},"required":["tags"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The list of attached tag ids","content":{"application/json":{"schema":{"type":"object","properties":{"attached":{"type":"array","items":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"}}},"required":["attached"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/create-a-new-bookmark.api.mdx b/docs/versioned_docs/version-v0.24.0/API/create-a-new-bookmark.api.mdx new file mode 100644 index 00000000..e34accec --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/create-a-new-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +id: create-a-new-bookmark +title: "Create a new bookmark" +description: "Create a new bookmark" +sidebar_label: "Create a new bookmark" +hide_title: true +hide_table_of_contents: true +api: eJzVWMFu4zYQ/RVjzmrsLHrSzVl0gXTbbtCk6MHQYSyNLa4lUktSTlxB/14MyUiyIydysyhaBAhkcYYcPr4ZvlEDGZlUi8oKJSGGj5rQ0gxnkh5na6V2JeodRGBxayBewU14ZSCJwFBaa2EPEK8aWBNq0sva5hCvkjaJQNO3moy9UdkB4uZkoYecuvlnVs1StzBEkCppSVr2wKoqRIrsMf9q2K0Bk+ZUohstii8bt7Q9VAQxqPVXSi1EUGlVkbaCDNtZYQtyD97MWC3kFiKQdVHgmsesrimCEp9+IbnlDVwvFos2AtRpLvaUDbzXShWEEtoINrhXvP9z41LZkXXbCExdlqgPo2Meh2xp3464bduoASVpGgxu9OWcJOuST7YQcgdJG0GtizG7jdIlWoih1oIDrTSlGh8LypYepdtsZEOtp4HQDNLKj/olEg7+fSFberIuZPcwirSqdUp/jO3oTGjPc743NjSGfHDu6eENc1Hilpevsk3vNIpoBBtR0G9YnuHWxTvu4+uXTVr+a72HqZQ0ftcfFtfjqRxoOywZkxP5daDFOAiv5EkbQakysRET0yiaWiLeXREsbrdCbu8t2tpMKUnP9DB1mpIxnIYoilo7qpDM2Cs5W2pG4j9besZQcTW/M0St8QARCEul+cfnJs8RF63FNKfsZjS4Lq0ERJDXJUpITvksMgjzH83m7AZk/HcK5kWsOsqnCfauWozm+Dnj5bl6MsaRVBNJkyt7idemLoo7XslnyCWuL66SS5z3IiN1UaC4F+lEoHNbFh976rxp/7yNadZY21zpaRDV60KYnKZZZ2jpLnhMA4U9fg1Fc4ry+M9e6xND/V9f82M5ewEiERjx13BaWZdr0qN8nsz9S7TFu1Gv5U6qx5ErwDmwdAnLff/7a9Ix9xX0ed/3wzdrlJL0beDCSeGEUNLYLogpV91gpE5yzp2Dwt2GfbRJO2rQy6gj0TQQOkeq5lTCBJHQE6XDPenuv65nBC8of1wsXmrIG8xmoV/8ftIxVdm41ijJGAb/TYnsZujtnSR2/jZXGcRQKRdvhdw0wnzddcfcHOs9aeOEhlMI0GCWaTKmnWMl5vtrPmnUgpPIhRuGPTgbrAvutnJrKxPP51YfrnaocUdUXWFVQTSiwsMMM7WZ2Zxmn4P9zMfC+A+69ntG0a887N07SHhl3oczYx3rjJiW7uHTcz/4858PDjc+nd/7lv+nJyyroH8CEbo86VW0l7lD3ezfeEHbe3S6tX816AD6lyF2p82CMusHR1vWAS2E3CiOl8/Ng3p9tbhaQE/lDtHl3e3oCSzvbmcbpY/h5+PiO1wZy8I1boIKPvu15UQPdulw/vOM3zbfavOqQOG6jaBLPTlXsB5+usmZuPEKmmaNhu+NtuXX32pikFdJT033NSeCnDBj9bFqYEd8DkEW/RCq+x6L2lXZ03zlau89lmlKlX3VNhnk1t2X+wdXBP3no9IlM2h8hMj9jwEiUA4kR2L3roEC5bZ2yQ1+zjYorWFLdkzlYTOA8jCIsGm8xYPakWxbiMJWLP8G1yL/DT9YpU4= +sidebar_class_name: "post api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Create a new bookmark"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/bookmarks"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Create a new bookmark + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The bookmark to create","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"title":{"type":"string","nullable":true,"maxLength":1000},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"note":{"type":"string"},"summary":{"type":"string"},"createdAt":{"type":"string","nullable":true}}},{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string","format":"uri"},"precrawledArchiveId":{"type":"string"}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["type","assetType","assetId"]}]}]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"The created bookmark","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/create-a-new-highlight.api.mdx b/docs/versioned_docs/version-v0.24.0/API/create-a-new-highlight.api.mdx new file mode 100644 index 00000000..b5340d69 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/create-a-new-highlight.api.mdx @@ -0,0 +1,71 @@ +--- +id: create-a-new-highlight +title: "Create a new highlight" +description: "Create a new highlight" +sidebar_label: "Create a new highlight" +hide_title: true +hide_table_of_contents: true +api: eJztVj1v2zAQ/SvCzaztFJm4uUWLph0SNC46GB7O0tlSLJEMSSUxBP734ig5khwl6JChQzdbd7yPd+8e2UBGLrWF8YVWIOGzJfSUYKLoMcmLfV4W+9yDAI97B3IN307fHGwEOEprW/gjyHUDW0JLdln7HOR6EzYCLN3X5PwnnR1BNmepVjn1GRKvkzTmBgGpVp6U5yNoTFmkyEfmd47PNeDSnCrkX/5oCCTo7R2lXKSx2pD1BTm2brU+VGgPV9nA13lbqD0EAc6j9de7nSM/sKu62pJlO6nsDWuqS21fxuVjdcVAHaks9SMwCBkI2FsiBQK2ZU2MXEY7rEsP8uQYBHh68lMhVV2WuC0JpLc1BQFKe/oLx9BOoOAK5HqIx7j7Ya9dFV2OTQhtFGe0ci2sHxcX08Ns55eNaPN/lO8zSgHFdOu1I/sKKt08lhOFvAM1YkXP+YfZNgJ84bn0Xi2gJdLlYvGSO59wwJmk04z3406qswmEg4CKnMP9lO0MnRih99+cermc6KUDMlHaJztdq+xfbySe97nOQILREXiDLOEwz3utZ6m3D2RdVPraliChwSyz5FyYoynmDxcg4AFtwayN9XbmFqTTiuTeGyfnc2+PswNaPBCZGRoDYkJRugiJ3iU+p+RH55+0tTCnBnfQLcPYycXgJnrGhDNzH9ENZOfEexx/fNW2Qq7w++9VBI7H87O/wL48YWVKOlejfmNHIrQYic7iWWR6LWkVYrDwUQgGUy3UTnM2Rr2F5GK2mC2g365nPJY3V5P4LW+ukp22Y/AY7CDirCuMBFQYAXn17h8Fbno6v/FaaCHnHuemxEJFqWLWNB271pCPXhI5U0+uoWm26OiXLUPgz/c1WX5dbHpuxceFgJwwIxvpeKAjF9OW9WHFudmd5Vm+3LggTieWaUrGv+m7GWzHzfXtiunSvWaquI5gMd4M+AgSQICOMEUWxm8NlKj2dVxPaGMyuXDMzTMuxq46E6rjoMKmaT1W+kAqBBBdK57/Q+CN/gPpI19E +sidebar_class_name: "post api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Create a new highlight"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/highlights"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Create a new highlight + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The highlight to create","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true}},"required":["bookmarkId","startOffset","endOffset","text","note"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"The created highlight","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}}}},"400":{"description":"Bad highlight request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/create-a-new-list.api.mdx b/docs/versioned_docs/version-v0.24.0/API/create-a-new-list.api.mdx new file mode 100644 index 00000000..c4ecdf3c --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/create-a-new-list.api.mdx @@ -0,0 +1,71 @@ +--- +id: create-a-new-list +title: "Create a new list" +description: "Create a new list" +sidebar_label: "Create a new list" +hide_title: true +hide_table_of_contents: true +api: eJy1VU1v2zAM/SsGz1o+hp58S4sN6FZgxZphhyAHxmYSNbakSnLbwNB/Hyg7sZN6KQZ0F8OSSJF875GqISeXWWm81ApSuLGEnhJMFL0khXQeBHjcOEgXcCedd7AU4CirrPR7SBc1rAgt2Vnlt5AulmEpwNJTRc5f63wPaX0WYL6leG/idZLFYCAg08qT8myNxhQyQ7YePzp2qcFlWyqR//zeEKSgV4+UcWrGakPWS3J8qrCknpXzVqoNCCiluiO14QynAkp8PayuJkGc5nfReXLiPJ2wt8yG3IJoN97eR6oqGc0SVYUFCHAlWs+w5rTGqvCQHs6CgKeK7P69moIAg5aUv82HTFVVFLgqCFJvKwqhYUhayjmPCFpbxzKE5tgZrVwD6ufJdJjFhr38oJIP4lAOlBDEX6h9n72z2i/w9Q8I/ndyLzMmcxAntPWSXwrw0rNnbFdoCL2aTN5yeI150rbqx9GX6XyYp5Kcw83Q2Vl18YbOPkoy+vutziEFo2O+Bln6MC7iUOKZZJ/JujiSKltACjXmuSXnwhiNHD9PQcAzWsm4xlTb4waYAzlb741Lx2Nv96MdWtwRmREaA2KgA9obEr1O/JaS76190uTC2PeG5QMj2ETuj8wjHByZ64hmkLZGINqfr9qWyBl++z2PmDEzP7tJ++UVS1NQNwY7NZ0mftxuOqFbt3kcpduqszPoOqTHq1RrzUEZ/CbAdDQZTaDT4RGW2f3tIIyz+9tkre0phow5d6V2vkTVK2vohTobAkctDz9nTZ2eXv3YFCgVx4mSqVtVLaA4PHVbVlu6gLpeoaNftgiBt1tsFstOU/H1E7AlzMlGGe6I4btpkvk057BsXlQc/k2TBXHwmGUZGX/RdtlriPsfD3OWSfvclrEDweILiPhNAQToCE5UX9yroUC1qWJHQnMniwpPNXmmwVhVe4Rq38uwrhuLud6RCgFEW4rnNQRu4j9RGN5l +sidebar_class_name: "post api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Create a new list"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/lists"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Create a new list + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The list to create","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","minLength":0,"maxLength":100},"icon":{"type":"string"},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","minLength":1},"parentId":{"type":"string","nullable":true}},"required":["name","icon"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"The created list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true}},"required":["id","name","icon","parentId"],"title":"List"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/delete-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.24.0/API/delete-a-bookmark.api.mdx new file mode 100644 index 00000000..2efd161f --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/delete-a-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +id: delete-a-bookmark +title: "Delete a bookmark" +description: "Delete bookmark by its id" +sidebar_label: "Delete a bookmark" +hide_title: true +hide_table_of_contents: true +api: eJx9U01v2zAM/SsCTxugxe3QYYNvGdoB3Yah2DLsEORA20ysxrZUiW6TGfrvA23nq83qi/XxKD4+PnZQUMi9cWxsAylcU0VMKrN2XaNfq2yrDAdlCtDAuAqQzuHzeBlgoSFQ3nrDW0jnHWSEnvy05RLS+SIuNDj0WBOTDz0g5CXVCGkHvHUEKQT2plmBBtpg7So5MmSKarNd1U/3nz7azd8P5YbZ5p+EgeEesmNwW0DU4OmhNZ4KSNm3pKHBWkDZAaTBSHEOuQRh5Sk42wQKwuT9xZX8TnX4YVVuG6aG1TvF5ZEiTxhU0avUJ786F73jpxrLamnbRiiM7wkanatMjoJO7oOEnJHGZveUM2hw3jrybAa6uS3opYBRQ00h4Orc3YlG8+GFA34R5ZM9l7aAFIbqJLHolUKyqz0k3UHUCNJ8/7hrbesrSKHDovAUQkzQmeTxEjQ8ojeYVQP78XqQbIltxZBCyexCmiTst5M1elwTuQk6B/qZrrOS1PiCssu+L99GvBq4QIzxyJW/RNQh87E39wpJZqmjh4lnehDocfHF+hqF4dc/s15G0yythEvVA6XLycXk4siaez7Tu9uz/Kd3t2pp/Sl5KTZqcDZwjb0dRhOP84h7/z1/szv46vXhHQpm2nDiKjSN5Ot71o19nu8nJoCG9Gh8FhpKG1ggXZdhoN++ilGOH1ryMvqLQ5t7MxQmyLqAdIlVoFc4v/k5OvOt+h/L8RCbbe+mqpUdaFjT9nTM4yJqKAkL8j2LATDNc3J8FPpi+sQxe/df33y/md2ABjy1yjNr9AnOMuu6ATGza2pi3BNl2QvHGP8BgxHeWQ== +sidebar_class_name: "delete api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Delete a bookmark"} +> +</Heading> + +<MethodEndpoint + method={"delete"} + path={"/bookmarks/{bookmarkId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Delete bookmark by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"204":{"description":"No content - the bookmark was deleted"},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/delete-a-highlight.api.mdx b/docs/versioned_docs/version-v0.24.0/API/delete-a-highlight.api.mdx new file mode 100644 index 00000000..6b41831c --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/delete-a-highlight.api.mdx @@ -0,0 +1,71 @@ +--- +id: delete-a-highlight +title: "Delete a highlight" +description: "Delete highlight by its id" +sidebar_label: "Delete a highlight" +hide_title: true +hide_table_of_contents: true +api: eJytVcFu2zAM/RWDpw0QknTosMK3AO2wbANWbBl2CHJQLCZWY0uqRLfJDP37QNtJnNbtdtgpjvkkPj4+0jUoDJnXjrQ1kMI1FkiY5HqTF3qTU7LaJ5pCohUIILkJkC7g0yEaYCkgYFZ5TXtIFzWsUHr004pySBfLuBTgpJclEvrQAEKWYykhrYH2DiGFQF6bDQjAnSxdwa80alXs9pvy8e7qg939fp/viGx2xRQ0NZAjhZmCKMDjfaU9KkjJVyjAyJJReQ8lQHOBTlIOzMtjcNYEDMzl3WTCP+dazHNMVKOHOgkCAjJrCA3xAelcoTPJB8Z3gU8NVGhXd5jxQeetQ0+6zbmydltKv52p52pEAYGkp2/rdUDqxU1VrtBzHI16JZrZwvpBlU1Vcg/3WBT2EVgH1mbjEQ0IWBUVclMVrmVVEKQHYBRAuKOhK01VFHLFbWHxowBjCf8JqIdLrwL6F1TJPEpCNR0gEs98sOjre65mX7uuqo5zw+iYv59tOWA9iJFzXk4un3vnCEqMpWRtK6P+n3Myqwb0jQJKDEFuhmJPtGluOOGXsS2lRMqtghRa23NiHpcUxkf/h3Hdm6rI0qJ/OEx35QtIoZZKeQwhjqXT44cLEPAgvebWN/y7cKvawWc5kQvpeEx+P9pKL7eIbiSdAzEwlt0NiV0nlGPypcMnLRduTG8x/WBZu5nrraejRpyZ62hgkHYgHobm4aP1pWSGn3/NGyG1WVs+zlW3lC5Gk9Gkt52OfKa3s0H+09tZsrb+nDwXGwU4G6iUjSG6NdYtZXm2hc4urU/W+ssKb0tm049dIbVp5o27Vne9Xpy2ZgABaX+HLgXkNhCD6nolA/70RYz8+r5Cz1+A5anVjSGUDvysIF3LIuArtN987/z5NnmJZ/dSmn3jKF5VKYCALe6fLPu4jAJylAp9Q6NFTLMMHfXOPhtCts1xCK5vvt7Mb0CAPPfLE380CQap1XWLmNstmhiPTIn/M8cY/wCwMJE0 +sidebar_class_name: "delete api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Delete a highlight"} +> +</Heading> + +<MethodEndpoint + method={"delete"} + path={"/highlights/{highlightId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Delete highlight by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"HighlightId"},"required":true,"name":"highlightId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The deleted highlight","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}}}},"404":{"description":"Highlight not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/delete-a-list.api.mdx b/docs/versioned_docs/version-v0.24.0/API/delete-a-list.api.mdx new file mode 100644 index 00000000..86c83140 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/delete-a-list.api.mdx @@ -0,0 +1,71 @@ +--- +id: delete-a-list +title: "Delete a list" +description: "Delete list by its id" +sidebar_label: "Delete a list" +hide_title: true +hide_table_of_contents: true +api: eJx9U8tu2zAQ/BViTy3ARkmRooFuBpICaYMiaF30YPiwltYWY0lkyFViV+C/F0upfiROfbFIDjmzs7M9lBQKbxwb20IO11QTk6pNYLXYKsNBmRI0MK4C5DO4M4EDzDUEKjpveAv5rIcFoSc/6biCfDaPcw0OPTbE5EMChKKiBiHvgbeOIIfA3rQr0EAbbFwtW4ZMWW+2q+b54eqz3fz5VG2YbXEl7IYTRNhvS4gaPD12xlMJOfuONLTYCKAeABqMFOOQKxA1noKzbaAgCj6eX8rfcd3frSpsy9Sy+qC4IrWwdt2gX6tnDKpMriTiy1O3RZdqLaul7VqhH98SJDpXmwIFmT0EgZ+wwy4eqGDQ4Lx15NkMUgtb0mvTooaGQsDVqbMjb2bDC3v8PMpP1lzZEnIYKhNi8SqHTBwMWT8YGUEa7Z/+tbHzNeTQY1l6CiFm6Ez2dAEantAbXNSD6vF4sGmJXc2QQ8XsQp5l7Ldna/S4JnJn6BzoF15OK1LjC8ouUy++jXg1aIEY40ECf4qZA/NhDnfOCLPUkWCQjyDQ48cX6xsUhV9/T5N9pl1auS5VD5Iuzs7Pzg9iuNMzub89qX9yf6uW1h+Ll2KjBmcDN5hiMIZ2nDlMU/fyvX6fpbeHcyiUacOZq9G0wpN61Y99naXJCKAhH0dkrqGygeWo7xcY6JevY5Ttx468jPV839bU/NIE+S4hX2Id6D863/0YE/hevaVu3MR2m9JTd7ICDWva7sc4zqOGirAknxQMh5OiIMcH115NmKRjl/Drm7ub6Q1owONYvIhBIjipqu8HxNSuqY1xJ5JlLRpj/AuPmMsh +sidebar_class_name: "delete api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Delete a list"} +> +</Heading> + +<MethodEndpoint + method={"delete"} + path={"/lists/{listId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Delete list by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"204":{"description":"No content - the bookmark was deleted"},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/delete-a-tag.api.mdx b/docs/versioned_docs/version-v0.24.0/API/delete-a-tag.api.mdx new file mode 100644 index 00000000..0ca6fba3 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/delete-a-tag.api.mdx @@ -0,0 +1,71 @@ +--- +id: delete-a-tag +title: "Delete a tag" +description: "Delete tag by its id" +sidebar_label: "Delete a tag" +hide_title: true +hide_table_of_contents: true +api: eJx9U01v2zAM/SsCTxugxe3QYYNvAdoB3Yah2DLsEOTA2EysxrZUiW6TGfrvA2UvH206X2SJT+Lj42MPJYXCG8fGtpDDNdXEpBjXarlThoMyJWhgXAfI5zCTdaEhUNF5wzvI5z0sCT35accV5PNFXGhw6LEhJh8SIBQVNQh5D7xzBDkE9qZdgwbaYuNqOTJkynq7WzdP958+2u2fD9WW2RafJLnhBJnh+raEqMHTQ2c8lZCz70hDi43EOcU1GCnEIVcgXDwFZ9tAQfK/v7iS5bTm71YVtmVqWb1TXJFaWrtp0G/UEwZVJkVS3qtzt2e4Vq1ltbJdK9nHpwSIztWmQAFm90HQZ7Swy3sqGDQ4bx15NgPTwpb0UrGooaEQcH0udqLMfHjhgF9E+WTPlS0hh6EwSSxS5ZBJk7M+qRhBeuwf/3Ww8zXk0GNZegohZuhM9ngJGh7RG1zWA+cxPGi0wq5myKFidiHPMva7yQY9bojcBJ0D/VzIitT4grKr1IivI14NXCDGeGS+nyLlkPnYgntdJLPUkWCQjyDQ489n6xsUhl9+z5J4pl1ZuS5VD5QuJxeTiyMH7vlM727P8p/e3aqV9afkpdiowdnADSYTjIYdhw1l3J4/1x+M9OpQDmUybTlzNZpWsqRO9WNP58PgasiH2VhoqGxgCfT9EgP98nWMcvzQkZdpXhxamhpfmiD/JeQrrAP9h+SbH6P33qrXuI2H2O6Sc+pOdqBhQ7v9+MZF1FARluQTgSE2LQpyfHTrxWiJMfbWvr75djO7AQ146ohnDkgJzpLq+wExsxtqYzxwlL1wjPEvTTHFIQ== +sidebar_class_name: "delete api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Delete a tag"} +> +</Heading> + +<MethodEndpoint + method={"delete"} + path={"/tags/{tagId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Delete tag by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"},"required":true,"name":"tagId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"204":{"description":"No content - the bookmark was deleted"},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/detach-asset.api.mdx b/docs/versioned_docs/version-v0.24.0/API/detach-asset.api.mdx new file mode 100644 index 00000000..694ebff8 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/detach-asset.api.mdx @@ -0,0 +1,71 @@ +--- +id: detach-asset +title: "Detach asset" +description: "Detach an asset from a bookmark" +sidebar_label: "Detach asset" +hide_title: true +hide_table_of_contents: true +api: eJy9VE1v2zAM/SsCTxugxe3QYYVvGdoB3Yah2DLsEPjA2HTsxrZUiW6TGfrvA23nq82KHYblEkt6oh4fH9lBRj51peXSNBDDFTGmhcJGoffEKnemVqgWxqxqdCvQwLj0EM/hw7jlIdHgKW1dyRuI5x0sCB25acsFxPMkJBosOqyJyfke4NOCaoS4A95Yghg8u7JZggZaY20r2SqpzKr1Zlk/3l2+N+tf74o1s0kvhUHJPWTL4CaDoMHRfVs6yiBm15KGBmsBLfYgDaWkaJELCPqf0ZiKUC9ywBFxRCARuLem8eSFw9uzC/k7LsdXo1LTMDWs3owVeUSvsr5KlCnfpil5n7dVtRECF6eCbHVSjWGVm7YRJmNYQaO1VZmioKM7L1dOaGMWd5QyaLDOWHJcDqxTk9FzBYOGmrzH5amzI53mQ4Q9PgnykzUXJoMYMqqIBdHLFkO0raiPun1xQ9Sr46NuFDuAuNI9bD3Xugpi6DDLHHkfIrRl9HAOGh7QlbiohnTG40HDHNuKIYaC2fo4ithtJit0uCKyE7QW9BOhZwWpMYIyueKC1OcRrwYuEEI4aJfvovLw8mHT7CSTlyWPHiZm7kGgx4+PxtUoDD/9nPW6lk1u5LpkPVA6n5xNzg7MuuMzvb05yX96e6Ny447JS7JBgzWea+z9MTp7Oy5E86fhur3H/masDBkzrTmyFZaNPNgXrRsrP9/1sgcN8VFjD8WX7W2vJRoK41mudd0CPf1wVQiyfd+Sk0GV7GvfOyQrvXxnEOdYeXohm1ffRv++Vn9iPm5is+ktVrWyAg0r2hwPJRlE//HlrTwhCRoKwoxcn/xwOk1Tsnxw79loEPfuWvPq+sv17FrkP7btE5v2D5yk1XUDYmZW1ISwY8myFo4h/Abov0RX +sidebar_class_name: "delete api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Detach asset"} +> +</Heading> + +<MethodEndpoint + method={"delete"} + path={"/bookmarks/{bookmarkId}/assets/{assetId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Detach an asset from a bookmark + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"},{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"AssetId"},"required":true,"name":"assetId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"204":{"description":"No content - asset was detached successfully"},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/detach-tags-from-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.24.0/API/detach-tags-from-a-bookmark.api.mdx new file mode 100644 index 00000000..4ba9ae53 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/detach-tags-from-a-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +id: detach-tags-from-a-bookmark +title: "Detach tags from a bookmark" +description: "Detach tags from a bookmark" +sidebar_label: "Detach tags from a bookmark" +hide_title: true +hide_table_of_contents: true +api: eJytVV2v0zgQ/SvRPLGStykrVovydoG70gWEEBTxUPVhGk8b3yaxsSeXdqP8dzTOR1taLmhFH6rEOR7PnDlz3IKmkHvj2NgaMnhFjHmRMG5DsvG2SjBZW7ur0O9AgSxDtoQXw1KAlYJAeeMNHyBbtrAm9ORvGi4gW666lQKHHiti8iECQl5QhZC1wAdHkEFgb+otKKA9Vq6UJUNGl/vDtvp6//wfu//v72LPbPPnkoHhCBkzuNPQKfD0pTGeNGTsG1JQYyWg9RGkwEh5DrkAyUp2UOAXVh8kl3MSFgX1DLBNdCRkBgpyWzPVLHB0rjQ5Cjy9D7LnSmF2fU85gwLnrSPPhkL8GjmcUOg9HiQ9pir80u47fcleF3vzLpZ98U1+pxwt+xxW43pwtg59+L/m8+t0lCZwYjcDHaSFn8To8Pt4GSP/Ajf/TzKLSN0FF9O5Ax/P5s8uKRjlltSWk41tav37Cs+tvtY1BRWFgNurHT0vIUY44ldDxyviwmrIQFNJLIgo/wzScTBC2h5npEujLGSg/cM4ro0vIYMWtfYUQpeiM+nDU1DwgN7guuxLGD73vG2wKRkyKJhdyNKU/WG2Q487IjdD50Bd0dcQQSTGBSVvBnzS5yJdO3Gaj8Jsf/Kp30w0yclSR4SJD0QQqOHhX+srlAxff15ELqVjH46GcDuqahzW5TR3R+lN4zY1ZdWJyWys7BP++uKezuaz+YkKp8pu3t9dZeLm/V2ysf6cBqGtU+Bs4AqjugaLe9yvz6K3R8H+zOZ7Gpn2nLoSTS1nRyW0g4SWk7eKYLIzo+3NRUFhAwuybdcY6JMvu06WvzTk5a5YHTUUGdYmyLOGbINloEeSf/Jh0P4fyY+SHQ2kPkSplo28gYIdHc7vhdi1glCTj1n0gJf9WX8uJMwxwMWUd2rccZPn5PhR7OpkIl/dvr1d3IoihwuoiiYAHr+Civ8xXRurj0KPay2UWG+baArQRxX94rn8v5N7r99rhLRtj1jYHdVdN/HD8i7UdN03RJTKrQ== +sidebar_class_name: "delete api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Detach tags from a bookmark"} +> +</Heading> + +<MethodEndpoint + method={"delete"} + path={"/bookmarks/{bookmarkId}/tags"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Detach tags from a bookmark + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The tags to detach.","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"tagId":{"type":"string"},"tagName":{"type":"string"}}}}},"required":["tags"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The list of detached tag ids","content":{"application/json":{"schema":{"type":"object","properties":{"detached":{"type":"array","items":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"}}},"required":["detached"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-in-a-list.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-in-a-list.api.mdx new file mode 100644 index 00000000..da168ceb --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-in-a-list.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-a-bookmarks-in-a-list +title: "Get a bookmarks in a list" +description: "Get the bookmarks in a list" +sidebar_label: "Get a bookmarks in a list" +hide_title: true +hide_table_of_contents: true +api: eJzNWEtv4zYQ/ivCXNoCQpwttujCNydoF+ljN2hS9BD4MBbHFtcUqSUpJ15D/30xlCzJDp0o3QDtKY44j2+enOEOBLnMytJLo2EK78knPqdkYcy6QLt2idQJJko6Dyl4XDmY3sEf0nkH8xQcZZWVfgvTux0sCC3ZWeVzmN7N63kKJVosyJN1gcBlORUI0x34bUkwBeet1CtIgR6wKBV/kiSFetiuivtP7342D19+yh+8N9k71i59IGHtVwLqFCx9rqQlAVNvK0pBY8EEqiFIQbJJJfoc6jSiXlfFguyhoCUqN5RUSL8X9Lkiu41L6gzZY7ysrDNPis4aiudlL4xRhBpSELTESvm9tYeRu1omjoNnknDaRfA7l2RGe9I+uZdKJQtKpM5UJUhwbDnYllxptKOz5IPxlCY+lz1Thpp5FNoVJUtjE2eKQX6cRW38n0DrnN2KvWwYj5w+ZwMaNY79/uP5Of85tOHj4hNljNPnoRoSgR5ZQwuGObAslcyQOSafHLNFwmmCIEihtKYk62WjtEM9IEVrcctgPRXueRFSPM7IOoXMEnoSMx89LYyQSxk/TkFXSuGCM5ojV3f5PYISbZbLDYlIJtcpLHFjuHOcOve4Wkm9uvHoK/e8vhRIVwW3JldlGTkHrEKqyhK7ibRgrnmdgjZ+HH5XFQXa7TivhL74ynFrUjdygN5jlpO4iILbOwIlpJBXBWqY1wc1escaW/kH0gLdIJ+Npo/L0LmfNqA5PQ1FSb0Ozq+silo0PqsOinIEvSxwRX/H1J4injlHfHuMypHMEmmXG/8SrmWl1DVrairkJaylpczivSLxL5g3UpB5EVDcyGyko3NfqMs+dZ6l35sxjhornxs7zkXVQkmX0zhqgZ6uW45xTmGOP9umOYLhqPICdVMIc77tv62wPD34UFjhR6yynKlsNrIA4lD3Or4VK3LiBbDh1+0z5KEWWYlY9kyxvOU8lYo+RLtlrGZf4JEUnPwyFNtOjLF8Hp37cTf3TultfQWvV3qtzX3kCggM87pz7evfX6PC3HfQvd03wy8L1JrsVZsLR40T2pbGdO30FLobRPok19wpV4TbsEc7r6ME/Rh1MDQNBp2DqeZ4hGmHhD5ROr/P+63hojUDGIGmB9+uES9Oqn6aPJAzUHWNK6nZoIuOtA6Gvz1/+3j65ZUr0cYnS1Np8XpTb2ZEfMYpyDkO+uOzI0uDhJ6eg1cHfp8bAVNYNfnAO+AUJjy5u8muWRDrydBNjuxmv6iGOQV2KIQl5+oJlnKyecP5hlay1wP49rjxVruZQe596aaTibfbszVaXBOVZ1iWcLwU3eaUtBISswzLzu8tfdJg4YAMduwb9mm7LAw27c5BrJntCGQ8TQciLo7w41djC2SEv/1zG7wo9dIwO1vdQHpzdn52PlhiOzyz66so/tn1Vdi7DsCzsXwPG+d5+Jzu9ksYvy3giZeFo7muS6/nHiQa0/mOmpQKZdgd2imzifldeA3gAE+7Z4E+7PMUcuM8k+12C3R8L9Q1f252Q04GIR2HvF9u17QdPA1sUFWMISzvJ2i7Xf9p4pNO+A8X6KiHG6seLdW9dfO+VOI+PGnq93+1xf1Dckr7/pbS26HOPi7N6xDfbDmh4EHwbtcezrKMyiHUR82LoXfN4/0vt9AMn8Mt9bCuhvvRIaTdrqG4NWvSdd0h9Pw/A6zrrx6euwY= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get a bookmarks in a list"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/lists/{listId}/bookmarks"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get the bookmarks in a list + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"boolean","default":true,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks."},"required":false,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks.","name":"includeContent","in":"query"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-with-the-tag.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-with-the-tag.api.mdx new file mode 100644 index 00000000..58bcdf45 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-with-the-tag.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-a-bookmarks-with-the-tag +title: "Get a bookmarks with the tag" +description: "Get the bookmarks with the tag" +sidebar_label: "Get a bookmarks with the tag" +hide_title: true +hide_table_of_contents: true +api: eJzNWN1v2zYQ/1cEvmwDhDgdOqzwW1JsRTasDVYPewj8cBbPFmuKVMmTE9fQ/z4c9WmHbpQ1wPZkWbyP333yTgch0WdOlaSsEXPxDimhHJOVtdsC3NYn94ry8IpgI1JBsPFificW/LtMhcescor2Yn53ECsEh+6qolzM75b1MhUlOCiQ0PlA4LMcCxDzg6B9iWIuPDllWC4+QFFqfqVQSf2w3xT3n978bB++/JQ/ENnsDStXFEgWsLmRok6Fw8+VcijFnFyFqTBQ8DmF81QoNqkEykWdRpSbqlihO5azBu0HQVoVijpBnyt0+7ik3owO4dvKeftV0VlD8bTslbUawYhUSFxDpakz9jhyN+vEc/BsEk77CH7nk8waQkPJvdI6WWGiTKYriTJRJkTWoS+t8XiRvLeEaUK5GpgyMMyjwW0wWVuXeFuM8uMiauP/BFrv7Fbs24bxxOlLNqBR49nvP15e8s+xDR9WnzCjphq08pRIIGANLRjmgLLUKgPmmH3yzBYJpw2CRCpKZ0t0pBqlPeoRKTgHewZLWPinRSj5OCPrVGQOgVBeUfS0sFKtVfw4FabSGlac0Ry5us/vCZTgslztUEYyuU7FGnaW+8a5c4LNRpnNRwKq/NP6UoGmKrgv+SrL0HvBKpSuHLKb0EjmWtapMJam4fdVUYDbT/NKaIovHLcmdSMHQARZjvI6Cq5zBCiRirwqwIhlfVSjd6yxlX8kLdCN8tka/LAOffvrBjSn56FoZbbB+ZXTUYumZ9VRUU6gVwVs8K+Y2nPEV94j3URCEsuRzCEan1t6Dte60vqWNTUV8hzW0mHm4F6j/BfMOyXRPgso7FQ20dE5FfrtkDpP0ndmTKOGinLrprmoWmnlc5xGLYHwtuWY5hTm+KNtmhMYTiovUDeFsOTb/tsKi/CBQmGFh1hleVu5bGIBxKF2Or4VK3DiBbDhafEEeahFViLXA1MsbzlPlcb30W4Zq9lneCQVXn0Zi20nxlg+T879uJsHpwy2voDXK7M19j5yBQSGZd279uXvr0lhHjpoZ/fH8ZsVGIPups2Fk8Yp2pbGdO30FLqbiPRJrrlzrgi34YB2WUcJhjHqaGgaDTpHU83pCNMOCUOi9H5fDlvDdWuGYAQGH6hdI56dVMM0eSRnpOoWNsqwQdc9aR0Mf335+vH0u4BNYiwla1sZ+XJDb2ZlfMQp0HuO+eOzE0ODhIGeY1cHfsqtFHOxadKBV8C5mHEIZoewHdazsY88ul23o4YhRRxASofe1zMo1Wz3ipMNnGKXB+jtceOqdi0TOVHp57MZuf3FFhxsEcsLKEtxuhEtckxaCYldh03n95Y+abBwNEbr9Uf2aLspjJbs3j2sme0IZDxKByKujPDwq3UFMMLf/l4EHyqztszOVjeQXl1cXlyONtgez9XtTRT/1e1NWLqOwLOxfAlbTzx5zg/dBsYfFuD8Z4WTua7PrwkfJBoH8DU1KzWosD60g2YT97uu9Obdd4Eh9MtU5NYTEx0OK/B8MdQ1v26WQ04IqTyHfdhut7gffRvYga4YQdjez9D2y/7Xic964T/coKP+bax6tFUP1i2Hcon78Kyp3//ZlvcPyTnt3TVl9mOdHaomyOFmyxEkD4J3h/bsKsuwHCN91L0Yed893v2yEM3wOd5Sj0trvB8dIzocGoqF3aKp6wEg/2eAdf0PHbq6VQ== +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get a bookmarks with the tag"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/tags/{tagId}/bookmarks"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get the bookmarks with the tag + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"},"required":true,"name":"tagId","in":"path"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"boolean","default":true,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks."},"required":false,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks.","name":"includeContent","in":"query"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-a-single-bookmark.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-a-single-bookmark.api.mdx new file mode 100644 index 00000000..9a8359e7 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-a-single-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-a-single-bookmark +title: "Get a single bookmark" +description: "Get bookmark by its id" +sidebar_label: "Get a single bookmark" +hide_title: true +hide_table_of_contents: true +api: eJzNV0tvGzcQ/ivEXNoCC8spUjTQzQnawC2aGLWLHgwdRsuRltYuuSG5shVh/3sw3KdkKl4nBtqT5eUM55tvHpzZgySXWlV6ZTTM4T15sTRmU6DdiOVOKO+EkpCAx7WD+S28bQ8dLBJwlFZW+R3Mb/ewJLRkLyqfwfx2US8SKNFiQZ6sCwIuzahAmO/B70qCOThvlV5DAvSARZnzJ0VK5g+7dXF/9+ZX8/D5l+zBe5O+YQTKB5EOwaWEOgFLnyplScLc24oS0Fiw0HIQSkCxZyX6DOokAmNpTE6oIQFJK6xy3911SM3lSjjywhsRTnuafnAiNdqT9uJe5blYklA6zStJUigtfEbCkiuNdnQmPhhPifCZGpRS1KyTo12TWBkrnCmov92dHXq5wtz9f6D1fLfXvmsUO84/VWR3wKnQmXHM+8/n5/zn0IePyztKGafPhgyU6JGttIBYC8syVymy1uzOsWokpCZcBgmU1pRkvWoMK/k4++oEUkvoSV746GlhpFqp+HECuspzXHJiMvV1n6YTJNGmmdqSjKRincAKt4aL69S5x/Va6fW1R1+5p+0lQLoquIJdlabkHLAJlVeWmCbSkrUWdQLa+Gn4XVUUaHfTWAntoxdEa3HHWeKpcN8ctyb3IgfoPaYZybdRcB0RqCCBrCpQw6I+KLJbCD0v3H9wW5AbJaPR9HEVmtvXHWhOT0PJld4E8iubRz2anlUHVTVBXhW4pn9iZk8JXzhH/jISkliOpJZIu8z452itqjy/YktNhTxHtbSUWrzPSX6D8lZJMs8CiluVTiQ680X+bkidJ+U7N6ZJY+UzY6dRVC1z5TKaJi3R01WrMY0U1virbZoTFI4qL0g3hbDg5/r7CsvTgw+FFX7EKsuZyqYTCyAOtbPxvViREy+ADb9unhAPtchG5GpQiuUt56nK6UO0W8Zq9hmMJODU5/G1uiqWZKP5PDn34zQPpAy+vgDrld5ocx95AoLCou6pffn3a1KYhw7a+X09/rJErcletrlw1DihbWks145UobtBpE9yzZ2iIryGA9pFHRUYxqiDoWk06BxMNccjTDskDInS8754PPxDHTC8Pn/9eJLsZIQ2XqxMpeXLTZCpkfGRoyDnOAaPz46oCjcM8sxlHfR9ZiTMYd2Eh7eVOcz6WXu2H1aaGnj1sttusQpDA+xRSkvO1TMs1Wz7ioOPVnFdBejtccNXu+dA5n3p5rOZt7uzDVrcEJVnWJZwvGLcZCTaG4RZhdXhz1ZeNFg4JKOd8JoZbSyPN8OeHrbMfgQxHm2DEGdq+PG7sQUywj/+vQkcKr0yrM5eN5BenZ2fnY8Wwx7PxdVlFP/F1WXYYg7As7P8KBrneRKc77uVhldhFE7pdT7sPMf37ofE+sru3HjM78SszFGF+b2d9JpA3/b1yQUwH22viwQy4zyL7PdLdNyX65o/N8sVx18qx1E+sR2OIf6Hi2KUhA3tYsvjFvOKhcPq2CXxM1398e+26H4Sp6x3zVzvxjY7VKMghEcgI5Q8M93uW4GLNKVyDPdRY2H4fWG//+0GmjltvNAdZv14lTiEtd83EjdmQ7que5Se/2eAdf0FYTooOg== +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get a single bookmark"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/bookmarks/{bookmarkId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get bookmark by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"},{"schema":{"type":"boolean","default":true,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks."},"required":false,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks.","name":"includeContent","in":"query"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with bookmark data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-a-single-highlight.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-a-single-highlight.api.mdx new file mode 100644 index 00000000..705ceb5a --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-a-single-highlight.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-a-single-highlight +title: "Get a single highlight" +description: "Get highlight by its id" +sidebar_label: "Get a single highlight" +hide_title: true +hide_table_of_contents: true +api: eJytVcFu2zAM/RWDpw0QknTosMK3HLau22HD1mGHIAfFYmw1tqRKdJvM0L8PVNzESd1ih53imE/U4+Mj3YHCUHjtSFsDOVwjZZUuq1qXFWWrXaYpZFqBAJJlgHwBn5+iAZYCAhat17SDfNHBCqVHP2+pgnyxjEsBTnrZIKEPCRCKChsJeQe0cwg5BPLalCAAt7JxNb/SqFW93ZXN493VB7v9877aEtniiiloSpADhRsFUYDH+1Z7VJCTb1GAkQ2jqgFKgObqnKQKmJfH4KwJGJjLu9mMf06F+La6w4KyR03VQBAlSU5AQGENoSE+Jp2rdSH52PQu8NmROm3KBgKctw496f3NK2s3jfSbG/VckyggkPT0bb0OSIO4aZsVeo6jUa9EC1tbP6q1aRvu5A7r2j4Cq8EKlR7RgIBV3SK3VuFatjVB/gSMAgi3NJbStHUtV9wcbkEUYCzhPwH1eOltQP+CKoVHSajmI0TiiRsWQ31P1Rxq11fVc06MDvcPb1uOGBBi5DsvZ5fPHXQAZcZStratUf/POYVVI/pGAQ2GIMux2Jk2KcMRv4z7UhqkyirIoUzSpInJYXoYgTDtBoMVWVf0D08D3voacuikUh5DiFPp9PThAgQ8SK+574l8H95L9mSyisiFfDolv5tspJcbRDeRzoE40/W2wqzPkNl1RhVmX3t8tufCXRnspp+saT9wgw11EIhv5joSDPIexJOQHj5Z30hm+OX3bVJRm7Xl41z1ntLFZDaZDRbUgc/8+80o//n3m2xt/Sl5LjYKcDZQI5Mb+k3GS1lmQZuyxuMyOk/cHb312hrf18yWn7paapOmjdvW9c1eHDdnAAH5cI8uBVQ2EIO6biUD/vJ1jPz6vkXPX4HlsdfJEUoHflaQr2Ud8BXOb3707nybvcSzfynNLlmKF1UOIGCDu7OFH5dRQIVSoU809oh5UaCjwdlnI8i+OYzA9cdbECBP3XLmjpR9lFfX7RG3doMmxgNN4v9MMMa/V8aQOg== +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get a single highlight"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/highlights/{highlightId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get highlight by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"HighlightId"},"required":true,"name":"highlightId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with highlight data.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}}}},"404":{"description":"Highlight not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-a-single-list.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-a-single-list.api.mdx new file mode 100644 index 00000000..75778a1d --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-a-single-list.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-a-single-list +title: "Get a single list" +description: "Get list by its id" +sidebar_label: "Get a single list" +hide_title: true +hide_table_of_contents: true +api: eJytVE1v2zAM/SsGTxsgJOnQYYVvPWxFtwErtg47BD4wNhOrtSVVottkhv77QNlN89Vhh538QYp8j++JPVQUSq8da2sghyvirNGBs8Um0xwyXYECxlWAfA5fdeAAhYJAZec1byCf97Ag9OQvO64hnxexUODQY0tMPqSEUNbUIuQ98MYR5BDYa7MCBbTG1jXyS5OumvVm1T7dXXyw69/v6zWzLS+ku+aUIt2vK4gKPD102lMFOfuOFBhsJaEZEhRoYeKQaxA0noKzJlAQBO9mM3nsk/62uKOSsyfN9UC+QsYJKCitYTIsJ9C5RpcoJ6Z3QY6dIGZTIVDgvHXkWQ9NdXVMPj7DPhHYQ3c8NdM1DS5kJkI/KtDlqcSYhCAjM/mXKkPCCZFM14r6LZoOG1AQWvQsNqhoiV3DkD/HooKHjvzmH/rtyTiH5LM0kJHODvhi3wMQo5w+n50fKynxzFjOlrYz1f9TsLTVaalaCgFXp2IHBFOFl/wiDixa4tpWkMOKUlcxbQ5TcWGY9oOjo8yc/OPzfep8Azn0WFWeQohTdHr6eAYKHtFrGXGCPIaHGT3rVDO7kE+n7DeTe/R4T+Qm6BwcmA5ua8rGCpldZlxT9mXMzwYsIsPOKvghkxw67y6E7Viks/BIaZCPSaDGl0/WtygIP/+6TbPTZmnluLAeIJ1NZpPZzj7Y4rm8uT6J//LmOltavw9eyMrNsIFbTB4Yt4dsPsyCNquG0hY4rNm/mOmVNTkwZVrz1DWojTRKYvWjsPO0owIoyMdlVSiobWAJ9f0CA/30TYzye7xI8+JF16R+pYO8V5AvsQn0F5Bvvo/+e5u9hm78iWaT7NN08gUK7mnzslBjERXUhBX5hGAIXpYlOd45dnS/xB5bf199vAUFuG+KAxOk6ich9f2QcWvvycS4RcjyLQBj/ANIcU9P +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get a single list"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/lists/{listId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get list by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true}},"required":["id","name","icon","parentId"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-a-single-tag.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-a-single-tag.api.mdx new file mode 100644 index 00000000..64c17ee7 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-a-single-tag.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-a-single-tag +title: "Get a single tag" +description: "Get tag by its id" +sidebar_label: "Get a single tag" +hide_title: true +hide_table_of_contents: true +api: eJytVMFu2zAM/RWBpw0QkmzosMK3FNiKbocVW4YdghwYm7HV2JYq0W0yw/8+UHbTJPW6y06WRYp85HtkCxmF1BvHxtaQwDWxYszVeq8MB2Uy0MCYB0iWsJDvSkOgtPGG95AsW1gTevLzhgtIlqtupcGhx4qYfIgOIS2oQkha4L0jSCCwN3UOGmiHlSvlypDJyt0+rx7vLj/a3e8PxY7ZppeS3HB0WWB+k0GnwdN9YzxlkLBvSEONldg52jUYqcIhFyBYPAVn60BB8r+fzeRzWvC39R2lrB4NF6o0gVWGjBPQkNqaqWZ5gc6VJkV5Mb0L8mykLBsDgQbnrSPPpk9qspeld0+oxwxNdWXttkK/DUcOdVOtyZ87XO3nzJgWlC2i27/AoBkNWTQV1iOWrjvp9xKiHCL0M6CvwlqdsDiEvZhdvCRjgbmqLauNbers/3GQ2my82RWFgPmY7azwGOHZf9X1RVTEhc0ggZxiVpFdAlMZmGkbFdmBzIt/eJqGxpeQQItZ5imEborOTB/egYYH9AbX5cBTb+4btMGmZEigYHYhmU7Z7ydb9LglchN0DvR5FwtSQwRlN4oLUl8Hf9VjEQ6OBvmH9LHPfDzOh6ZIZqkjukEyOIEeDp+tr1AQfvm1iJ0z9cbKc6m6h/RuMpvMjqb5gGd+ezOKf357ozbWn4KXYjsNzgYeBDsMv2wtVMHUeUmyvs5Dts9KGt9wfZ1MO566Ek0taSJV7UDqst+CGpJ+0aw0FDawGNp2jYF++rLr5Pq+IS+rcfXMaWQ+M0HOGSQbLAO9gvDN90F5b9XfsA2XWO+jdMpG/kDDlvaHXditZLQJM/IRQG+bpyk5Pnr1YrBEGQdhX39agAY81cMZ/zH6KKK27T0Wdkt11z0DlH8B2HV/ANg2NwA= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get a single tag"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/tags/{tagId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get tag by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"},"required":true,"name":"tagId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"numBookmarks":{"type":"number"},"numBookmarksByAttachedType":{"type":"object","properties":{"ai":{"type":"number"},"human":{"type":"number"}}}},"required":["id","name","numBookmarks","numBookmarksByAttachedType"],"title":"Tag"}}}},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-all-bookmarks.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-all-bookmarks.api.mdx new file mode 100644 index 00000000..bfd0a785 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-all-bookmarks.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-all-bookmarks +title: "Get all bookmarks" +description: "Get all bookmarks" +sidebar_label: "Get all bookmarks" +hide_title: true +hide_table_of_contents: true +api: eJzNWEtv3DYQ/ivCXHoRdp0eddsEbeAUTQzYRQ+GDrPSaMUsRSoktc52of9eDKXVY03bcmKgPVkm5/3ifHuCnGxmRO2EVpDAR3IRShlttd5XaPYWYnC4s5Dcw/vhLI3BUtYY4Y6Q3J9gS2jIbBpXQnKftmkMNRqsyJGxnsBmJVUIyQncsSZIYKu1JFTQxmDoWyMM5ZAUKC3FoLBiEjRZKQ6UQwyCTfvWkDlCG/+YtAIPmg1eJE811ZbMc+KkqIRbIMk6I9SOgyic5IMPjbH6WdFZR7Hc6xhyKrCRDhJnGoovUnpdRJZc5HTkb4fU/mKjTCtHykUPglNOkVCZbHLKI6EiV1JkyNZaWVpFn7WjOHKlGJkyVMwj0ewoKrSJrK5oLJxV0Mf/iWlDsHuxHzrGi6Cn7ECnxnLcf7264j9zH75sv1LGdrpy3jlRjg5ZVW8Vs2JdS5Ehs66/WuYP5FV7iRBDbXRNxolO+9iSIykag0e22lFlXxYh8sel2caQGUJH+cYFbyudi0KEr2NQjZS45dLmFLZDoS+gHBo82MiThg3eO9zthNrdOnSNfVlfDKSaiseYbbKMLA+2AoVsDHGYSOXMlbYxKO2W2W+bqkJzXBYVP0PfOG9dDQcu0DnMSsrfB407BwIFxFA2FSpI21mz3rPGXv5Mmqeb1LNW9KXwE/55B7rbp02RQu198Bsjgx4tr6pZdy6gFxXu6K+Q2qeIN9aSuw6kJFQjmSFSttTuNVxFI+UNa+o65DWstaHM4IOk/AeYDyIn/SpD8SCyhYEuXSU/jKXzIv3ZjWXU2LhSm2UharZS2JKWUefo6KbnWBYU5vizH5oLGC46z1N3jZDys/9zjeXou/ON5T9CnWV1Y7KFDRA29azjZ21FLjxvrP+6e4Hc9yIryYuRKVS3XKdC0ufgtAz17CsiEoMV/0zF9qtjqJ4X1344zGNQRl/fIOqN2iv9EHgCPEPaDqF9+/drUZrHCXr2+3Z6skWlyFz3tXAxOKEfaUzXb09+ukFgTnLPPRUK/xqO1qZtkGBco2ZLUzxFMjMYMl9h+iVhLJQh7ukIH84YDNgCRd9djydeXVRTgDeRM1F1gzuh2KER97Wt97wiV+ocEth1oUTGfbCeirRkDmfw5990OGGeG7K2XWMt1od3nBs0gi30NdJfdwt2D2egdK62yXrtzHG1R4N7onqFdQ2XSOKupKiXEOnCI4Q/evqos4WNn+DWW966+8V6gl6HMLJm9sOT8ebpibiQ/Mfv2lTIFn76+87nQqhCMzt73Zn0bnW1upogv8Gezc110P7NzbUHKzPj2Vl+s7R1vKglpzNyCSH1i91nmDhhWN85ytN7XUsUfqvu968updMqSWMotXV8eDpt0fJ8bFs+7sASJzoXltM5or09HedA/oCyYaUe0D5BPmuRJQxnLL6EdgDXzxM/Gcj/ELEG89V59QjFjt6lY5v532ZiKAlz3n3uTz33JsuonnI9QqksZWj6j7/dQbdvTYHZvD2mkADVcSL7dOoo7vSeVNvC2QXH/0PLo/VfqoVqsg== +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get all bookmarks"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/bookmarks"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get all bookmarks + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"boolean"},"required":false,"name":"archived","in":"query"},{"schema":{"type":"boolean"},"required":false,"name":"favourited","in":"query"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"boolean","default":true,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks."},"required":false,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks.","name":"includeContent","in":"query"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with all bookmarks data.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-all-highlights.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-all-highlights.api.mdx new file mode 100644 index 00000000..dc484071 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-all-highlights.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-all-highlights +title: "Get all highlights" +description: "Get all highlights" +sidebar_label: "Get all highlights" +hide_title: true +hide_table_of_contents: true +api: eJyNVU2P2zYQ/SvCnAl706NuRtGm2x6yQLfoYeHDWBpbjCmSGY42MQT+92Ik2ZY22qS+2KYe37z5euqhplSxjWKDhxI+khToXNHYU+PsqZEEBgRPCcoX+ON+uDeQqOrYygXKlx4OhEy866SB8mWf9wYiMrYkxGkApKqhFqHsQS6RoATftQdiyAaYvnSWqYbyiC6RAY+tIpxtrYABq8K+dMQXyGaFKQlbf1KdVpwe/NpxCj+krkbEknuv+BSDT5SU/peHB/1aFujT4TNVUny10rwpVFGj4AYMVMELedG7GKOzFerd7eekBCv6w0AJBiKHSCx2DD9rwR2LzHhR3UJt+jnHIYRzi3x+rL+vVzaQBFk+HY+JZLUz5OsfPK2CC7zWB/Jdq/NyIefCV9Cy1mDgxEQeDBxcRzpANR2xcwLlFZgNCH2TNUrfOYcH7a5wR9mAD0L/C2jXU+8S8TtVqZhQqN6tCMmLmXqZ13dZzXntpqwmzYOiW/x5tP19gm+bNkT09E2mmf55xm8ULhZ5RjQL9oQn61XDbL+zfgy0JE2ooYTTkEdE3W/YLkgT8et1yzt2UEKPdc2UUt5itNvXD2DgFdmqyGEqp8fjcl1noBGJqdxuhS+bMzKeieIGYwTzZgOfGyomhiIcC2mo+GvCF6MWVT8zqL914aZ9mNnUrZIaWfMYYFBOIB3U4cfvgVtUhX/++zy0w/pj0Oua9Sjpw+Zh8zAzoJue3dPjqv7d02NxDLwUr8lmAzEkaXGwismtVk15QdrfTecdCx9T1UHcRofWDzug3eqnri5GZW+gCUn0tO8PmOgfdjnr8eiV2uvaJu3o3VvPdJm59ivqmpcwePY72JsN38H7+6wMbxIDDWFNPIQcb+2qiuI8xHcuqyy30f342zMYwGXP3/R4YL9arL/MuPt+RDyHM/mc4Spd9D/kfc75P+nqe/Y= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get all highlights"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/highlights"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get all highlights + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with all highlights data.","content":{"application/json":{"schema":{"type":"object","properties":{"highlights":{"type":"array","items":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}},"nextCursor":{"type":"string","nullable":true}},"required":["highlights","nextCursor"],"title":"PaginatedHighlights"}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-all-lists.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-all-lists.api.mdx new file mode 100644 index 00000000..8a3bef1c --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-all-lists.api.mdx @@ -0,0 +1,63 @@ +--- +id: get-all-lists +title: "Get all lists" +description: "Get all lists" +sidebar_label: "Get all lists" +hide_title: true +hide_table_of_contents: true +api: eJyNVMtu2zAQ/BVhzoTl9qibD22QtkAD1EUPhg9raR0xliiGXKUVBP57QUp+xkB7EsV9ze7MckTFvnTaiu4MCjywZNQ0WaO9eCgIPXsUG3xL/1sFz2XvtAwoNiN2TI7dqpcaxWYbtgqOve2MZ49ixMflMn6uK3zfvXAp2W8t9blSVpHQAgplZ4SNxDCyttElxbD8xcfYEb6suaV4ksEyCnQpGxSs6yw70VPlCf7ZjZyjAQpauPX/DtfVhY8Xp80zgoKhlu8arjq8tSuYvmlo1zAKcT0HBV3ecwwKlhwbebxT/k6WyeG9I5u+jZy1ZHpqoOBbchLJq3hPfSMojrag8NqzG/6jXojkvvbacRWT6wrzQOZ2LsBvFURLjEy6QbgNnujZhpAsLUvdVSjwzIkKinJCfpSgZ/fGzifB9a5BgZGqyrH3ISer87cPUHgjpyPYRN9snrR37LgWsb7Ic3HD4kCODsx2Qdbihj6sa87mDFm3z6Tm7Ovsn01YYkMXq/AjinKqfLkQp4nGyrGP5IZidoKaD58711JE+OXXGnEe2uy7GB67niB9WCwXS5ynesKzenq8i3/19JjtO3cNPjYbNdZ5aSnpbxL0u6W/kfNpJ9+/DlODwn8ktw1pE/MnjsaZxhPXCnXnJV6M4448/3RNCPF61t9meyYxPSYKNVPFLvF+4AEFVmXJVhLbTZ/W+vaJiLSc5PTwaQ0FuibjZvgp+/GRMMNF7nGcPNbdgU0IUDMIif8IUbx/AXt7yNI= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get all lists"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/lists"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get all lists + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with all lists data.","content":{"application/json":{"schema":{"type":"object","properties":{"lists":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true}},"required":["id","name","icon","parentId"],"title":"List"}}},"required":["lists"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-all-tags.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-all-tags.api.mdx new file mode 100644 index 00000000..d0e7bdf0 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-all-tags.api.mdx @@ -0,0 +1,63 @@ +--- +id: get-all-tags +title: "Get all tags" +description: "Get all tags" +sidebar_label: "Get all tags" +hide_title: true +hide_table_of_contents: true +api: eJyFVE1v2zAM/SsGz0Kc7uhbCmxFt8MKzMMOQQ6MzcSqP6RKdDbD0H8fKLtp4gbtSbZFPj7yPXqEknzhtGVtOsjggTjBpkkYjx4UxCPbQi7nToGnoneaB8i2I+wJHblNzxVk213YKXDkrek8echG+LJey3GN/3P/TAUnfzVX5zpJiYwrUFCYjqljyUJrG12gZKXPXlJH8EVFLcoTD5YgAxPBQIF1xpJjPRWeSJ+j0DkcQIFmav3n2bq8iPHsdHeEoKDDlm5f9O29MXWLrr5E7/p2T24ZcD9smLGoqMxj2GdkUN+ErPoWuxs3IQQR4aXXjkrRTZcwU18Q/ZDWTgFrbgQ5xyO8Q40D3oWpXEtcmRIyOFLkj2IHSGcDeXIncj76pXcNZDBiWTryPqRodXq6AwUndBr3zdzydD1Z54B9w5BBxWx9lqbshlWNDmsiu0JrQS38lVeUzAiJOSRcUfJjjk8mLtLOhZN/iammypd+Po9WKksfMQyyOQjU/PDNuBaF4fc/Ocg4dHcwki5dT5TuVuvVGt5GeuazeXq8yX/z9JgcjLsmL80GBdZ4nrWfHLnc2Cu48W2l3m321B7TP05tg7oT9KjQOGv4qrOCyniW93Hco6ffrglBPr/05ORPsHtTMP4IFFSEJbkoek0DZLApCrIcpW76uJTL/RZNzlZ6+JqDArxWYjH5iP664t1wgT2OU0RuaupCADWTYHmHIMb9D+rOsgM= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get all tags"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/tags"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get all tags + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with all tags data.","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"numBookmarks":{"type":"number"},"numBookmarksByAttachedType":{"type":"object","properties":{"ai":{"type":"number"},"human":{"type":"number"}}}},"required":["id","name","numBookmarks","numBookmarksByAttachedType"],"title":"Tag"}}},"required":["tags"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-current-user-info.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-current-user-info.api.mdx new file mode 100644 index 00000000..17789a8b --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-current-user-info.api.mdx @@ -0,0 +1,63 @@ +--- +id: get-current-user-info +title: "Get current user info" +description: "Returns info about the current user" +sidebar_label: "Get current user info" +hide_title: true +hide_table_of_contents: true +api: eJyNUz1v2zAQ/SvCmwnL7cjNQxukHRq0DjoYHmjpHDGWSIY8pTUE/vfiKCGxkw7RIom8j3fvvZvQUmqiDWy9g8ZP4jG6VFl39JU5+JEr7qhqxhjJcTUmilBg85Cgd7hPFBP2ComaMVo+Q+8mHMhEipuRO+jdPu8VIqXgXaIEPeHzei2v674/Do/UcPXHcleaVK1hs4JC4x2TY8kwIfS2MZJRPyZJm5CajgYjX3wOBA1fCkEhRB8osp2b2vYiJnG07gFZwZmB3l8ouLHvzaEnaI4jZQUajO0/EJll2KfRRmqFINtin+VRGIg730LjgQo8I/SglmFTPRCExPgsfAqHY+yhMZm2jZRSrk2w9fMnKDybaKVfmWq5nuk8mrFnaHTMIem65nhenUw0J6KwMiFAveF821G1VKj8sej8fYmvZizIOV+o+0vInjtfavxCinSWOUoY9BIEtXx89XEwgvDb7y2EEjGZpMvUM6RPq/VqLQazLJTiBc/m7va/+Dd3t9XRx2vwMmxWCD7xYIpNZp1xQ3xl5WLzt3WnV899dB3m8Zn+ch16Y510LwpOi847FJ0hNpB96XxiOZ2mg0l0H/uc5fhppCg7tH/VuayQQkempViscaIzNDZNQ4GLIfpRur/bDlHuxXQ3X7ZQMNd6vdGnVF+ujDtf1J6mOWLrT+RyhlpAsPwji8X/AXJleBo= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get current user info"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/users/me"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Returns info about the current user + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with user data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}},"required":["id"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-current-user-stats.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-current-user-stats.api.mdx new file mode 100644 index 00000000..51ca8256 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-current-user-stats.api.mdx @@ -0,0 +1,63 @@ +--- +id: get-current-user-stats +title: "Get current user stats" +description: "Returns stats about the current user" +sidebar_label: "Get current user stats" +hide_title: true +hide_table_of_contents: true +api: eJyNU8Fu2zAM/RWDZyFOd/QtA9au24AVW4odghwUh4nV2JJKUdkCQ/8+UPbaOG2A5RIlpPie3nvsYYuhJuPZOAsV/ECOZEMRWHMo9MZFLrjBoo5EaLmIAQkUsN4HqFbwGJACrBUErCMZPkG16mGDmpAWkRuoVuu0VkAYvLMBA1Q9fJjP5WsK/H3zhDUXvw03GWRgMAMFtbOMluWK9r41tZYr5VOQez2EusFOy4lPHqEClyeBAk/OI7EZUG3sPjp36DQdwlm3jd0GCZKS060+OjKMVxsWVDfmiNtr9WXW5f3aNxP4avGz2Tet2TfvdiQR8DkaEuDV9CUXvKcsXzmdMbjEWyf5KOiQG7eFCvaY1dNiH5RiRig7LLMhIFbTUVwXpyO1UEGvt1vCEFKpvSmPN6DgqMnoTTsoOZYH03c6tgwVNMw+VGXJdJodNOkDop9p70FdJGPZYDFOKNwup/Hr2F8MXCCldJbBn5KIAfk8iS+yCrK8I7dBNTaBGg+3jjotDL/8Wmbtjd05uS6vHijdzOazuayB4VYmvPBZPNy/y3/xcF/sHE3Jy2OTAu8Cdzpn2epM6A55snDFP+kng/vXzfjvtR0EYPzDpW+1sYKfPexHv1eQ/QaJg2iUgdcKGhdYqn2/0QEfqU1J/n6OSLLz61fH88oraFBvkXJIDniCChZ1jZ5zNNooLN4ss3j4EsK7T0tQoKfOXTiVp48lbU9ns/t+6Fi6A9qUQI0kWH5Dksj/BT5muKk= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get current user stats"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/users/me/stats"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Returns stats about the current user + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with user stats.","content":{"application/json":{"schema":{"type":"object","properties":{"numBookmarks":{"type":"number"},"numFavorites":{"type":"number"},"numArchived":{"type":"number"},"numTags":{"type":"number"},"numLists":{"type":"number"},"numHighlights":{"type":"number"}},"required":["numBookmarks","numFavorites","numArchived","numTags","numLists","numHighlights"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/get-highlights-of-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-highlights-of-a-bookmark.api.mdx new file mode 100644 index 00000000..dae985cd --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/get-highlights-of-a-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-highlights-of-a-bookmark +title: "Get highlights of a bookmark" +description: "Get highlights of a bookmark" +sidebar_label: "Get highlights of a bookmark" +hide_title: true +hide_table_of_contents: true +api: eJytVcGO2zYQ/RVhTi1ArJwiRQPdXKBNNzk0aLboYeEDLY0triWSGY42dgT+ezG0bEm7SjaHnCyTj8M3b94Me6gwlGQ8G2ehgLfIWW32dWP2NYfM7TKdbZ07tJoOoID1PkBxD78PSwE2CgKWHRk+QXHfwxY1Ia07rqG438SNAq9Jt8hIIQFCWWOroeiBTx6hgMBk7B4U4FG3vpElg6Zqjqd9+/nhzW/u+OXX+sjsyjfCwHCCXBjcVhAVEH7qDGEFBVOHCqxuBbQdQQqM5Oc11yCsCIN3NmAQJr+sVvIzl+KuxqwxgUWEURJQUDrLaFlOaO8bU2o5kT8EObaQoNs+YMmgwJPzSGzOl05ijlhNpE9ClrENL8eYJPhM0KggsCb+e7cLyJN927VbJNlHW31jt3SNo8VC2a4VF5ywadxnEDFF4D0hWlCwbToUX1S4013DUFyAUQHjkZdC2q5p9FYqKwWMCqxj/C6gWU69C0hfUaUk1IzVeoFInHnpfm6gqZpT7YasBs6J0fX+6W2b0b1/XWoP8emVE1tsYtp9vXr93J0X/2fWcbZzna1+nDNLVy1oHxW0GILeL+09SSJFGPEpkXSea1dBAfskW2rGAvKLyiHvR8FjPmu6gPR4GSEdNVBAr6uKMISYa2/yx1eg4FGTEXOkLIbts3QXJ9bMPhR5znS6OWjSB0R/o70HtdD9QwQZAFxj9n7AZ2cuUrrJ9Pso4g5dOZmBV6XkZskjwWQ2JZC0S/r401GrheG7/+6SnMbunByXrM+UXt2sblaTEXjls/5wu8h//eE22zmak5dkowLvArc62WIYli+M/ln4frTai0/GOX1pkdw32tjUnVLBfjDA2GZS6GLWc9NuUFC7wILv+60O+C81Mcrypw5JXp/N6IDkk8oE+a6g2Okm4Ddy+Omfwbw/Z1+jfBnQ9pSMJjOuAFBwwNP8pYmbqKBGXSElFmfAuizR8+ToswYVM10b5O0fd6BAzy30xDIp+iKtvj8j7twBbYxXliz/hWCM/wNdHrx1 +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get highlights of a bookmark"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/bookmarks/{bookmarkId}/highlights"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get highlights of a bookmark + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The list of highlights","content":{"application/json":{"schema":{"type":"object","properties":{"highlights":{"type":"array","items":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}}},"required":["highlights"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/karakeep-api.info.mdx b/docs/versioned_docs/version-v0.24.0/API/karakeep-api.info.mdx new file mode 100644 index 00000000..3e4eb827 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/karakeep-api.info.mdx @@ -0,0 +1,82 @@ +--- +id: karakeep-api +title: "Karakeep API" +description: "The API for the Karakeep app" +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: null +--- + +import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiExplorer/Export"; + +<span + className={"theme-doc-version-badge badge badge--secondary"} + children={"Version: 1.0.0"} +> +</span> + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Karakeep API"} +> +</Heading> + + + +The API for the Karakeep app + +<div + style={{"marginBottom":"2rem"}} +> + <Heading + id={"authentication"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Authentication"} + > + </Heading><SchemaTabs + className={"openapi-tabs__security-schemes"} + > + <TabItem + label={"HTTP: Bearer Auth"} + value={"bearerAuth"} + > + + + + + <div> + <table> + <tbody> + <tr> + <th> + Security Scheme Type: + </th><td> + http + </td> + </tr><tr> + <th> + HTTP Authorization Scheme: + </th><td> + bearer + </td> + </tr><tr> + <th> + Bearer format: + </th><td> + JWT + </td> + </tr> + </tbody> + </table> + </div> + </TabItem> + </SchemaTabs> +</div> +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/remove-a-bookmark-from-a-list.api.mdx b/docs/versioned_docs/version-v0.24.0/API/remove-a-bookmark-from-a-list.api.mdx new file mode 100644 index 00000000..8a7cb34e --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/remove-a-bookmark-from-a-list.api.mdx @@ -0,0 +1,71 @@ +--- +id: remove-a-bookmark-from-a-list +title: "Remove a bookmark from a list" +description: "Remove the bookmarks from a list" +sidebar_label: "Remove a bookmark from a list" +hide_title: true +hide_table_of_contents: true +api: eJzNVMFu2zAM/RWBpw3Q4nTosMK3DOuAbsVQdBl2CHJgbCZWY1uqJKfJDP37QNmNkzYrdhiGnWzLj+Lj4yNbyMllVhmvdA0p3FKlNyR8QWKh9bpCu3ZiaXUlUJTKeZDgceUgncG1ct7BXIKjrLHK7yCdtbAgtGQnjS8gnc3DXIJBixV5si4CXFZQhZC24HeGIAXnrapXIIG2WJmSjxSpvNzuVtXD3cV7vf35rth6r7MLzq58hHD2qxyCBEv3jbKUQ+ptQxJqrBhQdgAJiusy6AsI8q+l/9CL8yKFxQA6ojHnCGd07cgxk7fjc34cd+KrFpmuPdVevDnqh3hAJzDPKaY+H4+fxz6yE1hawnwnau2Fqh872N/LcWhMqTLkuOTOcfAJifTijjIONFYbsl51tDOd03Mhg4SKnMPVqX9HWs26Gwb8PIQQSzohB/dbaDuowCUtdVPn/3tBMd4XOocUcirJMyIaIYWEO+KStjNrSPYzl7SDeQLwjNnN4wQ1toQUWsxzS86FBI1KNmcgYYNW4aLsiul/d0ousSk9pFB4b1yaJN7uRmu0uCYyIzQG5BO5pwWJ/gahl9F/X3q86LhACOFg+L+xxl3mwxWwF4wzcx0RxrMRQSD7l0/aVsgMP/+YRlVVvdQczlV3lM5G49H4YAT3fCY3Vyf5T26uxFLbY/JcbJBgtPMVRnf0w9pvPhwcdrz2ju5vB8v90crsNPC09YkpUdVMIbax7Z0wi/vKgYR0v7j2t/HpwS6ZSyi08xzUtgt09N2WIfDxfUOW1/B88EJ0TK4cv+eQLrF09EIxr257N78Wv+PdH2K9i5YrG/4CCWvaDWuXV+0/zHqgTpgHCQVhTjbW3gEmWUbGH4Q+2xNs5v2cfry8vpxeggQ8dvET18YEJ5m1bYeY6jXVIeyJev5mjiH8AkTPj4c= +sidebar_class_name: "delete api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Remove a bookmark from a list"} +> +</Heading> + +<MethodEndpoint + method={"delete"} + path={"/lists/{listId}/bookmarks/{bookmarkId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Remove the bookmarks from a list + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"},{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"204":{"description":"No content - the bookmark was added"},"400":{"description":"Bookmark already not in list","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}},"404":{"description":"List or bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/replace-asset.api.mdx b/docs/versioned_docs/version-v0.24.0/API/replace-asset.api.mdx new file mode 100644 index 00000000..3421b7f4 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/replace-asset.api.mdx @@ -0,0 +1,71 @@ +--- +id: replace-asset +title: "Replace asset" +description: "Replace an existing asset with a new one" +sidebar_label: "Replace asset" +hide_title: true +hide_table_of_contents: true +api: eJy9VE2P4zYM/SsCT11AO54ttujCt2yxBaYFisE0ix6CHBibiTWxJa1EzyQ19N8Lys7XTDpAgUUvgSOR1HuPjxygplgF49k4CyU8kG+xIoVW0c5ENnajMEZi9Wy4UagsPStnCTQwbiKUC/js3LbDsI2w1BCp6oPhPZSLAVaEgcKs5wbKxTItNXgM2BFTiDkgVg11COUAvPcEJUQOxm5AA+2w860cGTJ1u9tvuufHTz+73d8/NTtmV30SBIZzyAHBXQ1JQ6BvvQlUQ8mhJw0WOwlanYI0GOHqkRtI+rvBmIlOb2LAKeICwHIMp8ifXb0XFJctmTeUVR/bwE6FqUfSEdBQOctkWRLR+9ZUKInFY5TsK+Tc6pEqBg0+OE+BDcWcO2F7pUK64LM4Bi5TGq+idzaORX68/fiawB9OTRjV+4OZMB5o1Cr2VUUxrvu23Yt4H68VOfRYWcdq7Xpbfz/qlavpCm8NHcWIm2t3LzTJFU7xWZqcz42rpdN9flX6XUJxsGIshpMrU5GlicUwCZxAxik8HYalDy2UMGBdB4oxFehN8fQBNDxhMLhqpzaO16OAa+xbhhIaZh/LouCwv9liwC2Rv0HvQV/x2lRBubXihtTvU7wasUBK6WzO/xSJx5fPp/2ol7wsPHKYTGEOAj19/OpCh4Lwt7/mWVRp3cNpGr4c5u/Mn2f9MXbt5E40Ggl8uLm9uT2bySP62f3dVbaz+zu1duGSqkiTNHgXucNspWmAj+tRwLysN5z8+J/26KgU044L36Kx8nRu9jA5ZnFcXhE0lBebbDSNHB/nUkPjIkvaMKww0tfQpiTH33oKspmXJ89kZ9UmyncN5RrbSG/Q+uFhMv079W/Ip0O0+2zNtpd/oGFL+8stLJv3f3z5IE9aJg0NYU0hkx9vfxkfej+XGqfsV1tFQI8Zs6oiz2/GLs82wP3Xubh+2vBd3jgQ8Bl0/s1AXeadhymfDdCi3fR5A8FYUmYEL0fsxUhlUlelGIYxYu62ZFM6KsPyX3RJ6R8BPcUh +sidebar_class_name: "put api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Replace asset"} +> +</Heading> + +<MethodEndpoint + method={"put"} + path={"/bookmarks/{bookmarkId}/assets/{assetId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Replace an existing asset with a new one + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"},{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"AssetId"},"required":true,"name":"assetId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The new asset to replace with","content":{"application/json":{"schema":{"type":"object","properties":{"assetId":{"type":"string"}},"required":["assetId"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"204":{"description":"No content - asset was replaced successfully"},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/search-bookmarks.api.mdx b/docs/versioned_docs/version-v0.24.0/API/search-bookmarks.api.mdx new file mode 100644 index 00000000..1c5a935f --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/search-bookmarks.api.mdx @@ -0,0 +1,71 @@ +--- +id: search-bookmarks +title: "Search bookmarks" +description: "Search bookmarks" +sidebar_label: "Search bookmarks" +hide_title: true +hide_table_of_contents: true +api: eJzNWEtv4zYQ/ivCXNoCgp3t0Tdv0BZp0d2gSdFDoMNYGllcU6TCh7Ouof9eDCVbskMnSjdAe4oizgy/eWo+76EgmxvROKEVLOCO0ORVstJ6U6PZWEjB4drC4gE+Ht9lKVjKvRFuB4uHPawIDZmldxUsHrI2S6FBgzU5MjYI2LyiGmGxB7drCBZgnRFqDW0Khh69MFTAwhlPKSisWeARUhAM6NGT2UGbRowoX6/InBopUdrBihS1cBMs9XBScMJJfnHtjdUvms47iddtr7SWhApSKKhEL93B09PA35SJJZc4nYTTYwa+s0mulSPlkichZbKiRKhc+oKKRKjEVZQYso1WlmbJJ+0oTVwlBqUcFetINGtKSm0Sq2sa8juL+vg/gXYMdm/2ulM8C3rGDnTXWI77j1dX/OfUh8+rL5QzTlcFYLarc0PWSxeu6lGxKjaNFDmy6vyLZf1IXnWwCCk0RjdknOhuHzpnEEVjcMeoHdX2dROiiHZKbggdFUsXPa11IUoRP05BeSlxxaXNKWyPhT5BkuMktlRESrpNocSt5kFw6dzhei3U+s6h8/b1+1Ig5WueNtbnOVmePyUK6Q1xmEgVrJW1KSjtpuG3vq7R7KZFJYy6d85bV8ORA3QO84qKj1Fwh0CggBQqX6OCrD1p1ge+sbd/Yi3IjepZK/pchkH8sgPd6WUoUqhNCL43MurR9Ko66c4J8qLGNf0Zu/aS8NJacjeRlMRqJDdEylbavUWr9FLe8k1dh7xFtTGUG3ySVPwL5a0oSL8JKG5FPjHQlavl9VA6r8of3Jgmjd5V2kwLkV9JYSuaJl2go9teY1pQWOP3fmhOUDjrvCDdNULGn/1vayxHX11orPAQ6yyrvcknNkAc6uGOb8WKXHgBbHi6f0U89CJfUpSDUqxuuU6FpE/RaRnr2TdEJAUr/h6b7VfHWD1Prv14mIegDL6+Q9S92ij9FPkEBIWsPYb2/b9fk9I8TNCD33fjNytUisxNXwtngxP6kcZy/fYUphtE5iT33KVQhK/hgDZrowLDGnWyNI0WnZOt5nyF6ZeEoVCOcc8G+nCgSsAIFH11PZ94c1GNedjIzuiqW1wLxQ4N9Kxtg+c1uUoXsIB1F0pkegbzo8l5twMDkzmzPVC18GmHPRaFIWvbOTZivv3AKUIjGGgolf6427N7VgOVc41dzOfO7GYbNLghambYNHBOKO4rSnoLiS7DPv5bL590WNiHEcu84+W7369HXPMYTb6Z/QhivIAGIa6n8PCzNjUywl//ug8pEarUrM5ed5A+zK5mVyMCeMSzvL2J4l/e3gTOcgKeneVPl7aO97XF/kBgIrT6bAM6zp0oBe/c5BE+bySKsFr3S1iX19NS6TObpVBp6/h0v1+h5WnZtvy6o06c70JYzuoF7jfG9f0ffWH+kFyCtKFdz923KD2fB0787I5O7sDOp8ge6fbLwhfB/4cc9oVIPeO1g3fZ0HHhR5UUKsKCt6GHfa+9zHNqxlrPeCtbOY6BX366h24DG1O1004ZkwRUu5Ht/b6TuNcbUm0LBxcc/w8tD9t/ABEfUog= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Search bookmarks"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/bookmarks/search"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Search bookmarks + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string"},"required":true,"name":"q","in":"query"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"boolean","default":true,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks."},"required":false,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks.","name":"includeContent","in":"query"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with the search results.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/sidebar.ts b/docs/versioned_docs/version-v0.24.0/API/sidebar.ts new file mode 100644 index 00000000..7a15818c --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/sidebar.ts @@ -0,0 +1,240 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "API/karakeep-api", + }, + { + type: "category", + label: "Bookmarks", + items: [ + { + type: "doc", + id: "API/get-all-bookmarks", + label: "Get all bookmarks", + className: "api-method get", + }, + { + type: "doc", + id: "API/create-a-new-bookmark", + label: "Create a new bookmark", + className: "api-method post", + }, + { + type: "doc", + id: "API/search-bookmarks", + label: "Search bookmarks", + className: "api-method get", + }, + { + type: "doc", + id: "API/get-a-single-bookmark", + label: "Get a single bookmark", + className: "api-method get", + }, + { + type: "doc", + id: "API/delete-a-bookmark", + label: "Delete a bookmark", + className: "api-method delete", + }, + { + type: "doc", + id: "API/update-a-bookmark", + label: "Update a bookmark", + className: "api-method patch", + }, + { + type: "doc", + id: "API/summarize-a-bookmark", + label: "Summarize a bookmark", + className: "api-method post", + }, + { + type: "doc", + id: "API/attach-tags-to-a-bookmark", + label: "Attach tags to a bookmark", + className: "api-method post", + }, + { + type: "doc", + id: "API/detach-tags-from-a-bookmark", + label: "Detach tags from a bookmark", + className: "api-method delete", + }, + { + type: "doc", + id: "API/get-highlights-of-a-bookmark", + label: "Get highlights of a bookmark", + className: "api-method get", + }, + { + type: "doc", + id: "API/attach-asset", + label: "Attach asset", + className: "api-method post", + }, + { + type: "doc", + id: "API/replace-asset", + label: "Replace asset", + className: "api-method put", + }, + { + type: "doc", + id: "API/detach-asset", + label: "Detach asset", + className: "api-method delete", + }, + ], + }, + { + type: "category", + label: "Lists", + items: [ + { + type: "doc", + id: "API/get-all-lists", + label: "Get all lists", + className: "api-method get", + }, + { + type: "doc", + id: "API/create-a-new-list", + label: "Create a new list", + className: "api-method post", + }, + { + type: "doc", + id: "API/get-a-single-list", + label: "Get a single list", + className: "api-method get", + }, + { + type: "doc", + id: "API/delete-a-list", + label: "Delete a list", + className: "api-method delete", + }, + { + type: "doc", + id: "API/update-a-list", + label: "Update a list", + className: "api-method patch", + }, + { + type: "doc", + id: "API/get-a-bookmarks-in-a-list", + label: "Get a bookmarks in a list", + className: "api-method get", + }, + { + type: "doc", + id: "API/add-a-bookmark-to-a-list", + label: "Add a bookmark to a list", + className: "api-method put", + }, + { + type: "doc", + id: "API/remove-a-bookmark-from-a-list", + label: "Remove a bookmark from a list", + className: "api-method delete", + }, + ], + }, + { + type: "category", + label: "Tags", + items: [ + { + type: "doc", + id: "API/get-all-tags", + label: "Get all tags", + className: "api-method get", + }, + { + type: "doc", + id: "API/get-a-single-tag", + label: "Get a single tag", + className: "api-method get", + }, + { + type: "doc", + id: "API/delete-a-tag", + label: "Delete a tag", + className: "api-method delete", + }, + { + type: "doc", + id: "API/update-a-tag", + label: "Update a tag", + className: "api-method patch", + }, + { + type: "doc", + id: "API/get-a-bookmarks-with-the-tag", + label: "Get a bookmarks with the tag", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Highlights", + items: [ + { + type: "doc", + id: "API/get-all-highlights", + label: "Get all highlights", + className: "api-method get", + }, + { + type: "doc", + id: "API/create-a-new-highlight", + label: "Create a new highlight", + className: "api-method post", + }, + { + type: "doc", + id: "API/get-a-single-highlight", + label: "Get a single highlight", + className: "api-method get", + }, + { + type: "doc", + id: "API/delete-a-highlight", + label: "Delete a highlight", + className: "api-method delete", + }, + { + type: "doc", + id: "API/update-a-highlight", + label: "Update a highlight", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "Users", + items: [ + { + type: "doc", + id: "API/get-current-user-info", + label: "Get current user info", + className: "api-method get", + }, + { + type: "doc", + id: "API/get-current-user-stats", + label: "Get current user stats", + className: "api-method get", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/versioned_docs/version-v0.24.0/API/summarize-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.24.0/API/summarize-a-bookmark.api.mdx new file mode 100644 index 00000000..ac5f5e18 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/summarize-a-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +id: summarize-a-bookmark +title: "Summarize a bookmark" +description: "Attaches a summary to the bookmark and returns the updated record." +sidebar_label: "Summarize a bookmark" +hide_title: true +hide_table_of_contents: true +api: eJytVU2P2zYQ/SvCnFqAsJwiRQPdnEOBbQ9ddLfowfBhLI4triWSIUeOHYH/vRhK/tp1mhxyksT5evP4ZjSAplgH49k4CxUsmLFuKBZYxL7rMBwLdgU3VKyd23UYdgVaXQTiPtiYDb3XyCRntQt6BgoYtxGqJXycQiKsFESq+2D4CNVygDVhoLDouYFquUorBR4DdsQUYnaIdUMdQjUAHz1BBZGDsVtQQAfsfCtHhoxuD8dt9/nlw2/u8OXX5sDs6g+CwHB2OSF40JAUBPrUm0AaKg49KbDYidP64qTACAseuQFBFSh6ZyNFQfLLfC6PW8Kerxg4U/TZcHPiDxTUzjJZlmD0vjU1SnD5EiXDnV7d+oVqBgU+OE+BzVjf6Ld8JAV1IKm+4LvWzmmzMffNCmzftrgWqoSRdCbuOzwx1I3Z0zWmtXMtoZWyG9w7ue6v2Rm3W2O3T4zcx2/XU0C270RTsa9rihGkhGn7QEITWS1Rq6TAOv4+/Kfr+bbvjXKWcg3XpN9QfEXLDQevG16lJGnfz9+/VdRJs4V1XGxcb/WPk1Dt9B12RCYUI27v2V51nzNc/HMjOZ4bp2V0XMxlZYIqKE8jEcvhMmapHMk3XyRVpLA/jX0fWqhgQK0DxZhK9KbcvwMFewxGriR3MZlH6jbYtwwVNMw+VmXJ4TjbYcAdkZ+h96DuTOyUoXCbvML+nPyLEQuklK421pOQO1a+3ltnpqSy9JHdRObZCdT08rsLHQrCP/59znQau3ESLl2PkN7N5rP51do641k8PtzFv3h8KDYu3IKXZpPKN9BhlsW04J5ObBd43lGv0w4Xif2gn8BIDtOBS9+iyWOf73eY1LE8b14Z5+pmDV8EslLQiKaqJQzDGiP9E9qU5PhTTzK/y9VFHllE2kR511BtsI30P43+9Pek7J+LryGeDtEeswrbXr5AwY6Ot7+OJNunIdQUMorRYVHX5Pkq9M30itLO0/P419OzLJFbgb0SVE5/F9cwjB7Pbkc2pTNMlm9BmNJ/SMy/hg== +sidebar_class_name: "post api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Summarize a bookmark"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/bookmarks/{bookmarkId}/summarize"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Attaches a summary to the bookmark and returns the updated record. + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The updated bookmark with summary","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/update-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.24.0/API/update-a-bookmark.api.mdx new file mode 100644 index 00000000..aa0c8c20 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/update-a-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +id: update-a-bookmark +title: "Update a bookmark" +description: "Update bookmark by its id" +sidebar_label: "Update a bookmark" +hide_title: true +hide_table_of_contents: true +api: eJytVk2P2zYQ/SvCnFpAtb1Figa6OUGCbj/QRbJBD4YPI3FscS2RCkl5rQr678VQsj52tRsBzR4WJjUkh2/ee8MaBNnEyMJJrSCCL4VAR0Gs9SlHcwriKpDOBlJACA6PFqIdvOs+WtiHYCkpjXQVRLsaYkJDZlu6FKLdvtmHUKDBnBwZ6wNsklKOENXgqoIgAuuMVEcIgS6YFxlPSZIiu1TH/PHh7a/68u8v6cU5nbzlDKTzIdcMbgU0IRj6WkpDAiJnSgpBYc5B8RAUguTLFehS4Kx4BVn3TouKc5lCcJ9SINBh4HRQejhWwd8qqwKXUnCQlAkbVLoMHlG5ISZQRIKHMQWF0WcpSKwghEQrR8rxMVgUmUyQj1k/WD5rBhAdP1DiIITC6IKMk2T9WpOk8sx37CNjrTNCxQgc8Ky5Ci99t2Weo6nmcFdllmHMqDJ4TQhKO3oe2PTgf2uLEHK8/EnqyCS42Ww2TQiJIXQktm5RBqXJ5uIO2uToIILSSM5nUrUF22LpUm0WhRZlnEmb0rJoLv9dt0IsXvGXFvIgFy5wdFmGHVpL7v3AuW8s8H+sB1toZVuq/bzZzIuiJbrozeH7sVvOoPA6bZoQ8g7AhaxaSF/G8H9pzeHxKNXxs0NX2iVyIVXmbKu2TBKylpmOMisNMUykBK/avyjMmfyXq31injvwLj+APoF4BMsEg6cX3reMerN585xEV9sOlHbBQZdKfD8KJVrM21ZO1uJx7tuT2/sdhvh9p42cXKpF2z2SlM/lLhLB+ioDu66HVtMAt0RzvjY872VQoxCGrG3WWMj1+QZCOKORXInW3dvPLWIHLDO2udS5wkbrtTPV6oQGT0TFCosCwhltdjsE+uDb1B9dfNDmAk3TjHr1Z8a0PXncsXuA+GS+hw9jdvsgCLsfH69G/Ps/9x5FrtWnoaV+uLbycdtquT4WTzvTk3VEUk/0YXzt+v3EyBeGyRbpfjiFqJ++NoFhZuT1o9VTS59+GJx7lKM36NE5Ex8e0VGqg2ZkmCFtbjerzWozumZfu+3d7Wytt3e3wUGbaaGZGNy5tHU5euV0z6DuRYdj237SOnsJvv78a8nBN10XGUrvdl2vbjWx699c7GLR6AG2DyHV1nFIXcdo6YvJmoanv5bE1d/tB0l44Qhp+beA6ICZpVdy/uFTJ+Ifg5ey7CZRVV55WckjCOFE1fSh2LDRpoSC6bCru4Cujj/d8zbDBs/sqgmvK7ZJQoV7NXY/spa77f3731hf3YM092YGBh8h9P99ttpf3svWz9WQoTqW3tyg3bTp3jnj1jQVr7/WLB513Ubc6xOppunhcTxmZJrmP/ieNbs= +sidebar_class_name: "patch api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Update a bookmark"} +> +</Heading> + +<MethodEndpoint + method={"patch"} + path={"/bookmarks/{bookmarkId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Update bookmark by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The data to update. Only the fields you want to update need to be provided.","content":{"application/json":{"schema":{"type":"object","properties":{"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"summary":{"type":"string","nullable":true},"note":{"type":"string"},"title":{"type":"string","nullable":true,"maxLength":1000},"createdAt":{"type":"string","nullable":true},"url":{"type":"string","format":"uri"},"description":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"assetContent":{"type":"string","nullable":true}}}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The updated bookmark","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/update-a-highlight.api.mdx b/docs/versioned_docs/version-v0.24.0/API/update-a-highlight.api.mdx new file mode 100644 index 00000000..03e02440 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/update-a-highlight.api.mdx @@ -0,0 +1,71 @@ +--- +id: update-a-highlight +title: "Update a highlight" +description: "Update highlight by its id" +sidebar_label: "Update a highlight" +hide_title: true +hide_table_of_contents: true +api: eJytVcGO2zYQ/RVhTi3A2k6RooFubtAi2x6ySB30YOhAi2OLa4lkyNGuVYH/Xgwl2/Kusi3Q+CRrnmbePL4Z9qAwlF470tZADp+dkoRZpQ9VrQ8VZbsu0xQyrUAAyUOAfAsfztEAhYCAZes1dZBve9ih9OjXLVWQb4tYCHDSywYJfUiAUFbYSMh7oM4h5BDIa3MAAXiSjav5lUat6lN3aJ4e3v1sT3//VJ2IbPmOKWhKkAuFOwVRgMcvrfaoICffogAjG0ZVE5QAzQ06SRUwL/4EA/1iVcdsbmXYVJgpSTIjm7VJkkX20dRdRhVme421Clln2+xJGrpiMoOo+O8OM+fto1aoFiCgtIbQEJeRztW6lFxm+RC41owkdveAJYEA561DTxoDR0tbWz+rnGkbPpcO69o+AffG/R48ogEBu7pFKGL6cSw4a8KQ8sfVar75oSF1NcK3a2Nn7bGR/ninXvYSBQSSnj7u9wFpEjdts0PPcTTqlej/00iAwr1sa4L8DIwCCE80l9K0dS13bEc2XRRgLOF/Aur51tuA/iuqlB75PNYzROKN/7dTfW/VnGo3djVyTowu9afVipmRg8FIb1dvX3rnAsqMpWxvW6O+5QCoGX2jgAZDkIe52DNtUoYrvhhnokGqrBq2Q1lxXd4SOSwv9g/LfrJMIiuL/vG81FpfQw69VMpjCHEpnV4+vgEBj9JrPvlEfwwPop1tVhG5kC+X5LvFUXp5RHQL6RyImakcM2R2nxbRHyM+G7jwuUz28Z+s6jhyk618kYgrcx8JBvkI4llID79Z30hm+Ptfm6Qjn9an69L89byuL4tpMjLa7C1HWKGB/pvFarGaLPAL9/X93Wyv6/u7bG/9baMsTBTgbKBGJu+Mm368t+TNwrpJ2l9d+C+33CAPz8fS1VKbNJp8wv3oi+31YgkgIJ9eM4WAygZiUN/vZMDPvo6RX39p0fMlWVxtkcyjdOBnBfle1gFfof3dp9HK32df4zm+lKZL7uOtlgMIOGL37D6MRRRQoVToE40B8X4o9sOG81wzvJjaKM5frMsSHb2KLSYTdr/evP/AJhvv3SbNNHiZdrJ8Guja1H3ybnrXQy3NoU0zDkNStqS8dfQzB6e2ZgXp+wGxsUc0MV70If7PysT4D5kaH2M= +sidebar_class_name: "patch api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Update a highlight"} +> +</Heading> + +<MethodEndpoint + method={"patch"} + path={"/highlights/{highlightId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Update highlight by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"HighlightId"},"required":true,"name":"highlightId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The data to update. Only the fields you want to update need to be provided.","content":{"application/json":{"schema":{"type":"object","properties":{"color":{"type":"string","enum":["yellow","red","green","blue"]}}}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The updated highlight","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}}}},"404":{"description":"Highlight not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/update-a-list.api.mdx b/docs/versioned_docs/version-v0.24.0/API/update-a-list.api.mdx new file mode 100644 index 00000000..ed2d03e2 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/update-a-list.api.mdx @@ -0,0 +1,71 @@ +--- +id: update-a-list +title: "Update a list" +description: "Update list by its id" +sidebar_label: "Update a list" +hide_title: true +hide_table_of_contents: true +api: eJytVd9v2zYQ/leIe9oAznaKDCv05hUrmq7Ags7FHgw/0OLZYiKRLHlKrAn634ejZMtOlBQD4gdD5B3vx3ff3bWgMebBeDLOQgbfvFaEojSRxLYRhqIwGiSQ2kfI1vDFRIqwkRAxr4OhBrJ1C1tUAcOypgKy9abbSPAqqAoJQ0wKMS+wUpC1QI1HyCBSMHYPEvCgKl/ylUGjy0Ozrx7v3v/mDv/+WhyIXP6evRtKKuz9RkMnIeD32gTUkFGoUYJVFSuUvYIEw8l4RQVwNKyNkX53uuEYLlNeFSi0IiXIiTqlPxN/2bIRVKDYGSx1FI2rxaOyNOoIi6j5uEXhg3swGvUMJOTOElpiN8r70uSK3czvIvuaAMJt7zAnkOCD8xjIYGRpn89zuCpjv6DdM9BXEip1OJ6uF528TOz5Y1uXpdoykj1oZ8YWF8auFmzN5FNmulRctIzzD310Er7XGJofpdKlHxcqemdjj8G7xWK6Wn0FdGLp20FuJvLp5AuV+L9gvxmcvcJEH9m64gatlK1VCRJipQJxp2rcqbokyI6y14ryxN9Fp60hjYIEyJDOWfCbyzaFvqDXi+vnNWS5sI7EztVWv10Fc6enS1VhjGo/JXuSYLIw6m8GWlZIhdP9RMmLlDXTFubMwDhv+7HTMeoYHo5Drw4lZNAqrQPG2M2VN/OHK5DwoIJhkFPQg7hH6VipgsjHbD6n0MzuVVD3iH6mvAc50Q6DBeF2aWT9OeiLPhYuxNm8/pux7D2fT+0TMOyZ80hqkA1KIIePjy5UiiP8/M8qocc1+jqO1z+O4/w4wkZqXQZ+uu7bYjyP3TDeDXQ9q6ixO8dOGOze4NVsMVuc7YoTDMvbm0nYlrc3YufCJWaMMbeki1Qpe5bGsBjVceg86f4Tg1/eoD2+hAea+1IZy34SRdqBTuu0viJIyIY9tpFQuEgsatutivgtlF3H1wMi683IpsQ5bSJ/a8h2qoz4Spw/fR14/7N4KbrhUtkmkbas+QQS7rEZd2236SQUqDSGFEEv/ND7+WXFJsbHz7q7k8cXyzxHT6/qbs468Xa5+vCJaTns9Cr1PgT1CDL9p0hdSjyxPd21UCq7r9MsgN4ok1hd9sATzqe0JrFo215j5e7Rdt0JGuIzI9N1/wHzITRF +sidebar_class_name: "patch api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Update a list"} +> +</Heading> + +<MethodEndpoint + method={"patch"} + path={"/lists/{listId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Update list by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The data to update. Only the fields you want to update need to be provided.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","nullable":true,"minLength":0,"maxLength":100},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"query":{"type":"string","minLength":1}}}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The updated list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true}},"required":["id","name","icon","parentId"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.24.0/API/update-a-tag.api.mdx b/docs/versioned_docs/version-v0.24.0/API/update-a-tag.api.mdx new file mode 100644 index 00000000..313d77c9 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.0/API/update-a-tag.api.mdx @@ -0,0 +1,71 @@ +--- +id: update-a-tag +title: "Update a tag" +description: "Update tag by its id" +sidebar_label: "Update a tag" +hide_title: true +hide_table_of_contents: true +api: eJytVcGO20YM/ZUBTy0wsZ0gRQPdvEGCbHvoInHQg+EDraGtWUuayQy1a1XQvxccyWt7q91e4oNtiU/DR/I9qgNDMQ/Ws3U1ZPDdG2RSjHu1bZXlqKwBDYz7CNkaVvK70RApb4LlFrJ1B1vCQGHZcAHZetNvNHgMWBFTiAkQ84IqhKwDbj1BBpGDrfeggY5Y+VJuWbKmPLb76vH+w+/u+M9vxZHZ5R8kueUEWeH+1kCvIdCPxgYykHFoSEONlcQ5xTVYKcQjFyBcBEyRb5xphcF1uauClEFGxU41qfSZ+qsuW8UFqZ2l0kTVukY9Ys1njKqJjFxuSfngHqwhMwMNuauZapY06H1pc5Q08/souSba4Lb3lDNo8MF5CmwpSnQo53mz+vSReqJ3dRyg7xaL6aIGokYG+fOIWTNBS7/EV0PdVDfOHSoMh3gBqJtqS+E54KZdMmNekFkl2P+RQTt5ZNFUWE9Ext6dhLOGpOtE/RnRV2ltruQ4Hvt+8X5iCrhXtWO1c01tft4Mcmemm11RjLifFM514emEM34z6qoiLpwZnJMXklcclMFcvD/vkrl6EOuHh5Oxm1BCBh0aEyjGfo7ezh/egoYHDBa35TipITy0aIdNyZBBwexjNp9zaGcHDHgg8jP0HvSEmscTlNslY/454tXARaZwsZO+SSeHzJeb6aktklnqSDDIRhDo8c9nFyoUhn/8vUq9kwl9PS+RT6eVdTLqxQxsvXMSkAYN7N/OFrPFxQ57or68u50sdXl3q3YuXNcpfek1eBd5VPeYelzXOPr86rjuLLkX1/rQEaYjz32JtpYsaajdOP71sPo1ZMN23WgoXGQJdN0WI30PZd/L7R8NBXkfbM7TTxoxNsp/A9kOy0ivkPzl66jSX9VL3MabWLdJZGUjV6DhQO3TC6DfyBogNBQSgSH2cUjzJrn4/Ox/rNjr0xPLPCfPr2I3F7a5W64+fhEVjS+aKhkVAj6CTt+JqEt1J3Gmex2UWO+bZFwYDhXN4bVkn0k0lTXZiq4bECt3oLrvz52Ra+lM3/8LCbK4Xg== +sidebar_class_name: "patch api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Update a tag"} +> +</Heading> + +<MethodEndpoint + method={"patch"} + path={"/tags/{tagId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Update tag by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"},"required":true,"name":"tagId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The data to update. Only the fields you want to update need to be provided.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The updated tag","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"numBookmarks":{"type":"number"},"numBookmarksByAttachedType":{"type":"object","properties":{"ai":{"type":"number"},"human":{"type":"number"}}}},"required":["id","name","numBookmarks","numBookmarksByAttachedType"],"title":"Tag"}}}},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file |