diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-11-08 21:29:59 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-11-08 21:29:59 +0000 |
| commit | d9ef832e0b4fb04909a848ae948e22a01613c3b7 (patch) | |
| tree | 1e977b94fca1a36eff16df56535271e8ab0b5e8e /docs/versioned_docs/version-v0.28.0/api | |
| parent | 7339d1dfcde77d8945534180f8780ed6cc2063c5 (diff) | |
| download | karakeep-d9ef832e0b4fb04909a848ae948e22a01613c3b7.tar.zst | |
release(docs): release the 0.28 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.28.0/api')
41 files changed, 3039 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.28.0/api/_category_.json b/docs/versioned_docs/version-v0.28.0/api/_category_.json new file mode 100644 index 00000000..49c10f38 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/_category_.json @@ -0,0 +1 @@ +{ "label": "API" } diff --git a/docs/versioned_docs/version-v0.28.0/api/add-a-bookmark-to-a-list.api.mdx b/docs/versioned_docs/version-v0.28.0/api/add-a-bookmark-to-a-list.api.mdx new file mode 100644 index 00000000..a7c43463 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJy9VE1v00AQ/SurOYG01C0qovItHJAKCFWQikPkw8SexNvY3u3uuE2w9r+jsU2ctKFcEL7Yu56PN2/eTAcFhdwbx8Y2kMKsKBSXpJbWbmr0m6DYKlSVCQwaGNcB0gV8MYEDZBoC5a03vIN00cGS0JOftVxCushipsGhx5qYfOgNQl5SjZB2wDtHkEJgb5o1aKAt1q6SK0OmqLa7df14d/Xebn++K7fMNr+S7IZ7E8l+XUDU4Om+NZ4KSNm3pKHBWgyqwUCDkZIccglR/7P0H0ZqXoSwnIyOYGTiEZxtAgVB8vb8Ul7HTfhqVW4bpobVm6NuqEcMCouC+tSXp3yFHGX95NJYVivbNgJkjCpe6FxlchSv5C6I6wmC7PKOcmm889aRZzOAzm1Bz2mMGmoKAden/h0xtRgiTPZZlEfOXNpCyGr7rEJZCon0MyTd0NaY7LWZdBPNEUSN/uG31lpfQQodFoWnEGKCziQPF6DhAb3BZTVUMv4eaFxhWzGkUDK7kCYJ+93ZBj1uiNwZOgf6CdfzktQYQdlV36nPo70asECM8WBMvgvBQ+bDYdmzJZmljt5MVNQbgR4/PlpfoyD89GPeU2qalRV3qXqAdHF2fnZ+INY9ntnN9Un8s5trtbL+GLwUGzU4G7jGXhqjrGU94KStw91wFLqbpPa3lTJUzrTlxFVoGkncN68b+7/o5zmAhnQ/2PtYcnswa5mG0gYWp65bYqBbX8Uo1/cteVlT2aSAXieFCfJdQLrCKtALdbz6Ngr4tfoT7vESm10vtKqVE2jY0G5aS7KK/mPWA3ZiFjWUhAX5vvbBYJbn5PjA9dlqEAnvR/Pmdg4a8Fi4T4TaRz8Jq+sGi7ndUBPjHiXLWQDG+As6ID3T +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"},"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.28.0/api/attach-asset.api.mdx b/docs/versioned_docs/version-v0.28.0/api/attach-asset.api.mdx new file mode 100644 index 00000000..4a6377bb --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJztVcGO2zYQ/RVhTg3ArnaLFA10c4oW3RZoF1kHPRg+jMWxxTVFMiS1tivw34Oh5JUde4McesxFkEaP5Lw3b4Y9SAq1Vy4qa6CCWYxYNwUWhnYFhkCxiLbAYmXttkW/BQERNwGqBbwfQwGWAgLVnVfxANWihxWhJz/rYgPVYpmWAhx6bCmSDxkQ6oZahKqHeHAEFYToldmAANpj6zSHFCmp94dNu3t694vd//dzs4/R1u84AxUz5JjBvYQkwNOnTnmSUEXfkQCDLYNWE0iAYo4OYwOcFa+gEN9beeBczpWYN3QiQJYFBNTWRDKR4eicVjUyvHwKvOYKMbt6ojqCAOetIx8VBf6r5CX5JCCfN8/RK9KYrmXdtTLbP2Krfx1TERBqT2RCY/kj7/F4GlmhMeTvW9wQCFh3Wj/ghma+btQzR56VJMu4UakZ75BTptrjTpOcsF0g/9Fpi5JYz85sjd0ZWKazAiyY4CmdZUoDIjhrwqDBT7d3r6iexSY5yP9d9NdFF7BWmv7ORr/M3XRa44o7hRvi2yr09vbtZVGOfVYYG4u17Yz8/4pSW3kl+SSgpRBYvMt/XxDJO0z4TCSvj42V3O425GO56ysoj4KHsp9GQyqzEoHrSv75OKc6r6GCHqX0FEIq0any+Y6rh16xtJnC+HvQbY2djlBBE6MLVVlGf7jZosctkbtB50Bcc/ywQ2HXRWyo+GvEF0MukFI6GbGPrOxw8umgfZGJT87+ZBgPwAxiq+WX361vkTP889951pIr9mGahL8dJ/DQMJOdTvrkoh0Sj9a15UUs3sDs7ub25vZkXL/Qmj3cX5Vh9nBfrK0/14A1SyJXscVsrXGwH6+qsXHOtusne37TlTawirSPpdOoDJ+Yi9+Pvlm8NCp7pDq7VEbrLAU0bLVqAX2/wkAfvU6Jw5868nwzLifjZHtJFfhdQrVGHegrHH74MBr+TfFaumMQzSH7U3f8BQK2dDi/BRPPjYZQks9ZDICxkj/mAk8bXLR2EscVs7omF7+KXZ604cM/j/M874bLts19Dx53IPIzJ2sz9+ztHOtBo9l0eQ7AsCdbFs8d/4XDM6urcvT9gJjbLZmUXtSJ/M3CpPQZ2d8imQ== +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":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","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":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"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.28.0/api/attach-tags-to-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/attach-tags-to-a-bookmark.api.mdx new file mode 100644 index 00000000..6c1c6968 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/create-a-new-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/create-a-new-bookmark.api.mdx new file mode 100644 index 00000000..2b078007 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJztWktv2zgQ/ivGnLWxU+zJN6fYYrOvBpsUezB8GElji7VEqiTlxBX03xdD0pacSrHdBMUuYAQIFHGGM5znR01qSMkkWpRWKAlTeK8JLY1wJOlxFCu1LlCvIQKLKwPTOdyEVwYWERhKKi3sFqbzGmJCTXpW2Qym80WziEDTl4qMvVHpFqb1M0EPGe33H1k1SpxgiCBR0pK0zIFlmYsEmWP82TBbDSbJqEC3mucfl0603ZYEU1DxZ0osRFBqVZK2ggzTWWFzcg+ezFgt5AoikFWeY8xrVlcUQYFPf5Bc8QGuJ5NJEwHqJBMbSjvcsVI5oYQmgiVuFJ9/aF0q2yO3icBURYF627vm7ZDO7HGNHTU+5ndaKO+GbzlIVgX7LVePzK90gTksmghEUSpt78kYoeRt2q+nqnTSa7rdtlgKiOCRYnZczs+FikXOfqQnS5I3hwiMkKucln5BGwM7+bBomiaqQUk6zZdu9YVjCrl2x6t03ke3ZANYmEKlBZ+w1ORMSOnMu7rXEo2PZaHZ03O/6kUsWPnXqWzpyTqV3cOwGz71nWhAtd2er9UNjSGvnHt6OEIuClyx+DJdtkwDscXB8BcWAwly9olb/Vqxi4Z/Gs9hSiWNP/W7yeRIPcJcE6bbET0JY805Relle4t+W7yQ8w1nVCqW4uSScGK5e3V1s7haCbm6t2grc1xeGyWmShJyNWCJIq+0ixiSKXMt9tVRfHUmfvvt+6tyj3kGq3Qf7WClHFLzDSrnrivvhaLWuGUKS4X57miUQ1mJ1mKSUXrzYqdBPktWFSi5uB8mq0gh7H+wm6PrpNiP6QZn5cpBsTiB3pXC3gI2RDwbKpZ94ZZoImkyZc/hWlZ5fseSfN6fw/pNnzyHeSNSUmcpihuRnGjozBb5+zZ0jiMmT3uOOruTnyYAK5spfZpVqzgXJqPTqFO0dBc4TlOcOf4M3eMEhv8uzDlR1f817BnsKqdWESO+dreVVRGTfiEFvtvM/Vjr1Vav5Fqqx56u4RgYygVxb9/yTnIzd5NfO9WmW4Z3lrjvvolRStK3ITqeVV8IdZHpAux0NQl6ii1noSH9qcwVpsQ9tLXVWSHV147bsy+aXoIWnR5g0Q5+PACLz5FhP6AL2KUNxr1vF/u2vP/YAB7Ev5tcH8HtK2XDh4T0AtovoP0C2i+g/QLaL6D9AtovoP0C2i+g/QLafzxo/7nvY/sNpqMwHXw7nJ6otB8CFWQMu/PoLMHt0NK72YHjt5lKYQqlcvqWyCNCGMf7WSiPQvWGtHH4xwEXqDFNNRnTjLEU4801xw5qwY516oZlb5wlVjmPpTJrSzMdj63eXq1R45qovMKyhKjn2hN2GKnlyGY0+j3Qj7wubP/OjPaeregldye1e5OwZJcdTMaXBkfEge4ePuwGZ7/98+Dsxt75ux3w/vKERRlgWQiEfTy3VxaPpruXFP/Gw/uWY4/i21ed61b35cH4M0w5vxltdjYOkD8g+XB2BzkD4Gxpe2eDnbAScqn4vOx375Trq8nVBNpU2Htkdnfb68HZ3e1oqfSh+9jdjDOUsYzHp3UA94Oz+Wcwd59Ow8N8f2zuvOMyR+GuhgFu++CeQ9wd9Gcc+NM51HWMhntb0/DrLxWxk+aLNrTd7D+CjDBlhDSvYU3smVB/fwodaIN55d3wLN+5I3mOWZJQaV+kXXRy8+7j/YMry/6fDQpXDEAjBwT/ngJEoJyRXBK4dzXkKFeVKw7g92wCGuzenw9ToXvHQbntaFjXnuJBrUk2DUThKJb/BjeL/Bepno+R +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},"crawlPriority":{"type":"string","enum":["low","normal"]},"importSessionId":{"type":"string"},"source":{"type":"string","enum":["api","web","cli","mobile","extension","singlefile","rss","import"]}}},{"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={{"200":{"description":"The bookmark already exists","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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"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},"contentAssetId":{"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":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","tags","content","assets"],"title":"Bookmark"}}}},"201":{"description":"The bookmark got created","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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"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},"contentAssetId":{"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":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","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.28.0/api/create-a-new-highlight.api.mdx b/docs/versioned_docs/version-v0.28.0/api/create-a-new-highlight.api.mdx new file mode 100644 index 00000000..db7e10a0 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/create-a-new-list.api.mdx b/docs/versioned_docs/version-v0.28.0/api/create-a-new-list.api.mdx new file mode 100644 index 00000000..35e45c79 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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/SsGz1qSDtvFt7TYgG4FVqwZdghyYGw2UStLqiS3DQz994GyEzup12JAdwliiZ/vPVINlOQLJ22QRkMOF44wUIaZpqdMSR9AQMCNh3wJV9IHDysBnoraybCDfNnAmtCRm9dhC/lyFVcCHD3U5MO5KXeQNycJFltKcbNgsiIlAwGF0YF0YGu0VskC2Xp659mlAV9sqUL+F3aWIAezvqOCS7POWHJBkudbjRUNrHxwUm9AQCX1FekNV3gmoMLnw9dsFsVxga96z468PydvWYy5RdEdvIxHuq4Yzgp1jQoE+ApdYFxLusVaBcj3d1HAQ01u91ZTUYBFRzpclmOmulYK14ogD66mGFuKpKOS60iodX2sYmyvvTXat6h+nJ2N09jSV+5l8k4kypEWovgLt2+zd9L7K3z9A4L/ndwX+Wy9VrIYmK6NUYQaTtmUJYgjSgeNHcKsBAQZOHwaamhZ/zSbvST6HMusG+j347gw5TiZFXmPm7G7kzZThN4+6Tb5h60pIQdrUr0WeT5gqtLq4s3lHsn5tLhqpyCHBsvSkfdxilZOH89AwCM6yeCnUrvrFpg9g9sQrM+n0+B2k3t0eE9kJ2gtiJEx6SJk5jYLW8q+d/ZZWwtjP1ipN4xgm3m4WA9wcGbuI5mxDJIRiO7PV+Mq5Aq//V4kzJiZn/0+/vKMlVXUL8tecseFH47bcem/uzoO+u4k3Bv0YzTgVepbw0kZ/DbB2WQ2mUGvwwMs8+vLURjn15fZrXHHGDLmPB3Ghwr1oK2xd+xkUxy0PP7otX0Geg5Tq1BqzpMk03SqWoLaP4hbVlu+hKZZo6dfTsXIxx02y1WvqfRGCtgSluSSDO+J4btoi/mw4LRsrmpO/2LIoth7zIuCbHjVdjUYiOsfNwuWSfcoV2kCweETiPSbAwgwCZykvnTWgEK9qdNEQhuTRYXHmjzRYOqqu0K9G1TYNK3FwtyTjhFE10rgb4g8xH8AqpnrCg== +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":100},"description":{"type":"string","minLength":0,"maxLength":500},"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},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"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.28.0/api/create-a-new-tag.api.mdx b/docs/versioned_docs/version-v0.28.0/api/create-a-new-tag.api.mdx new file mode 100644 index 00000000..1d3f2014 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/create-a-new-tag.api.mdx @@ -0,0 +1,71 @@ +--- +id: create-a-new-tag +title: "Create a new tag" +description: "Create a new tag" +sidebar_label: "Create a new tag" +hide_title: true +hide_table_of_contents: true +api: eJytVD1v2zAQ/SvCzayVdNTmFi2QdmjQuOhgaDhLZ4uxRDLkKYkh8L8XR6qxkhpFhy6STN7Hu/feeYKWQuO1Y20NVPDREzIVWBh6KhgPoIDxEKDawkbetYJAzeg1n6DaTrAj9OTXI3dQbetYK/D0MFLgD7Y9QTW9Kb/pqGiRsWBbNLkVdySNiifN3QoUNNYwGZZcdK7XDUpueR+kwASh6WhA+eKTI6jA7u6pYVDgvHXkWVOQW4MDLaICe20OEGMGqD21MlOKqmPM58FZE3L6+6vry+gz6nbm5j+B1e0FqOofZ9AtqMUgUcFA3NkWKnA2pGYo8kCZlBQB/SP5kPQbfQ8VTNi2nkKIJTpdPl6Dgkf0Gnd9xjdfZ0b2OPYMFXTMLlRlyf60OqLHI5FboXOgLtA2VyjsPgn+dY4vMhaIMS6cdSe05c5Lf70QIZ1ljhQG1RwEav74bP2AgvDLz01iS+T4frblp2ccXE9nlywo12Zv5UIIyuivV1erK1kDzZIDL9DXtzcXR13f3hR761/PKbxElQQZ0CxaX1i4VyWns8cuLmdmhOmZS9ejNtIliTrNsm/zAtcKOnFDtYVp2mGgH76PUY4fRvKyzPVZ9LTLCjrClnzyyZFOAiBDebeRrhLej9L9D+tH9Ttj3TTk+K+x9cKwt9/uNqLj/Ocx2FZyPD6BSs8KQIFN1CR7pLMJejSHEQ8Sm2uK6vjaNG9Mkqaar9CcFginKUds7JFMjKDmUVh+Q5Ql+wUehMct +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 tag"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/tags"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Create a new tag + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The data to create the tag with.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"The created tag","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.28.0/api/delete-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/delete-a-bookmark.api.mdx new file mode 100644 index 00000000..56a84103 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/delete-a-highlight.api.mdx b/docs/versioned_docs/version-v0.28.0/api/delete-a-highlight.api.mdx new file mode 100644 index 00000000..39cd9b2b --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/delete-a-list.api.mdx b/docs/versioned_docs/version-v0.28.0/api/delete-a-list.api.mdx new file mode 100644 index 00000000..5059b462 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/delete-a-tag.api.mdx b/docs/versioned_docs/version-v0.28.0/api/delete-a-tag.api.mdx new file mode 100644 index 00000000..aaf7e855 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/detach-asset.api.mdx b/docs/versioned_docs/version-v0.28.0/api/detach-asset.api.mdx new file mode 100644 index 00000000..f08ec416 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/detach-tags-from-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/detach-tags-from-a-bookmark.api.mdx new file mode 100644 index 00000000..53a255cb --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/get-a-single-asset.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-a-single-asset.api.mdx new file mode 100644 index 00000000..63b18a94 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/get-a-single-asset.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-a-single-asset +title: "Get a single asset" +description: "Get asset by its id" +sidebar_label: "Get a single asset" +hide_title: true +hide_table_of_contents: true +api: eJx9U02P0zAQ/SvWnECymi4SYuVbhWC1cFlBEYeqB7eZNqaJ7bUnpSHyf0fjeEu72uUUf7zMezPveYQa4zYYT8ZZUHCHJHSMSGIzCENRmBokkN5HUCtY8E2EtYSI2z4YGkCtRtigDhgWPTWgVuu0luB10B0ShpgBcdtgp0GNQINHUBApGLsHCXjSnW/5yKCp29Ow737/uv3gTn/eNycit71lekMZkunva0gSAj72JmANikKPEqzuGKELQoLhbrymBlhPwOidjRhZw7v5nD/XjefaYussoaWZ+DgtBOsVJoqam+mMxZoHQw2WKfH9DFKS0CE1rgYFeySQE7WCKsNiNRZlCXh24fg0mT60oGDUdR0wxlRpb6rjDUg46mD0pp0Ul+tJ9U73LYGChshHVVUUhtlBB31A9DPtPchnrS1Z7VRBuF0W/7XgxaQFUkoXpn5nuybmS2vP7jEz95FhoAoIZFl8dqHTrPDLz2UejbE7x79z15Okm9l8Nr9w9qxn8XD/ov7Fw73YuXAtnptNEryL1GnLDCUGOcUiGrtvi1HPi45QrH4981OvhCeqfKuNZaps11jMXU1xiyBBPQVvLaFxkfhyHDc64o/QpsTHjz0Gfi7rf97mBNQm8roGtdNtxP/ofPOthP6teE1fOdR2yBFqe96BhAMOF68jrS/zevdpCRL0tcXPLM1KXyw+jhNi6Q5oUzpzEe+ZKaW/hvt+aA== +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 asset"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/assets/{assetId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get asset by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"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={{"200":{"description":"Asset content. Content type is determined by the asset type."}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.28.0/api/get-a-single-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-a-single-bookmark.api.mdx new file mode 100644 index 00000000..db305ceb --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJzNWN9v3DYM/lcMvmwDjFw6dFhxb2mxddmwNlhS7CG4B9qiz8rJkivJl1wO/t8Lyj8vcRInDbA9nc8ixY+fSIr0HgS51MrSS6NhCR/JR4kxmwLtJkp2kfQukgJi8Lh2sLyE9+2ig1UMjtLKSr+D5eUeEkJL9qTyOSwvV/UqhhItFuTJuiDg0pwKhOUe/K4kWILzVuo1xEA3WJSKX0mSQt3s1sX11btfzc3tL/mN9yZ9xwikDyIdglMBdQyWvlbSkoCltxXFoLFgoWQQikGyZyX6HOp4AkZijCLUEIOgDCvlu70OqTnNIkc+8iYKqz1NP7goNdqT9tG1VCpKKJI6VZUgEUkd+ZwiS6402tFR9Ml4iiOfy0EpRc06Cu2aoszYyJmC+t3d0aGXGSr3/4HW891u+6FR7Dj/WpHdAYdCZ8Yx7z8fH/PPoQ+fkytKGafPhwgU6JGttIBYC8tSyRRZa3HlWHXiSE3YDGIorSnJetkYluJ+9NUxpJbQkzjxk6uFETKT08sx6EopTDgwmfq6D9MZkmjTXG5JTIRiHUOGW8PJ9dC6x/Va6vW5R1+5p+3FQLoqOINdlabkHLAJqSpLTBNpwVqrOgZXFQVaeRsofv3ttfHz6Glw7ObJmsqmM7YdYGIpIYZrSji6FD8XJpGKQjXypB1HZQxO6rWirFmwwS1ZlMb64EtTFHujaC3uWMJT4V4cjU1GTSyg95jmJN5PctI7xr7kVYEaVvVB6biEUMnD/ge7BblRihlNn7NQsh93oFl9GIqSehN4qqya9Gh+rhzUihnyssA1fZky+5DwiXPkTyeOZCrcUkukXW78c7SySqkzttTk/XNUS0upxWtF4gXKWynIPAsobmU6k+jcF+rDEDpPyrdh9hw4nefzDGDlc2PnsVolSrqc5kkL9HTWaswDzhp/t7fHDIU7yRqkm9xZcd/yfbno6aatWfwwlYxNDZ2XM9NQOxvfixU5OALY8HTxhHhIXzYiskFpKrY4tKWiT5MF9sFbZW4VcfJ2vK2uioTsIynwYpoHUgZfX4H1Sm+0uZ64NYLCqu6pff0rb9Yx823yx6jajMtwx8T5+E2CWpM9baPjTvWFti6yXNtthpoEE8WWs9CR/VIqg4L4Dh24elZITV3Hg++relJg6E4PetFR/3jQLN7tDKcburZ3GYKxP9vV/UkL6oDs7fHb+217JxNp46PMVFq8XrueGjHdCRXkHJ/q/bU7BIYdBnlmuA76PjcClrBuDpxHwyUs+sFmsR/mx5oZJLvtptjQy8AehbDkXL3AUi62bzic0Eo+6wC9XW74aodKyL0v3XKx8HZ3tEGLG6LyCMsS7s5zFzlF7Q6RycKc9lcrHzVY+EhGA/g5M9pYHo/hPT1sOSQMi/EcEYQ49sPD78YWyAj//PcicCh1ZlidvW4gvTk6PjoeTeE9npOz00n8J2enYWQ8AM/O8sVrnOcGdbnv5kf+7oBR023349/dffdDYD3yoaLxmO+iRalQhmGpbUCbg77sM54TYDn6VLCKITfOs8h+n6Dj2l/X/LqZZPn8hXR8yg+M4mOI/+FUPknChnZTk/oWVcXCYU7vgviZrv74T5t0P0UPWe8uDL0b2+xQjQ4hXDQ5oeC+7HLfCpykKZVjuPcKC8PvE/vjbxfQ9ILj6fkw6scTziGs/b6RuDAb0nXdo/T8nwHW9Tfb7Kd7 +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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"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},"contentAssetId":{"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":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","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.28.0/api/get-a-single-highlight.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-a-single-highlight.api.mdx new file mode 100644 index 00000000..0916ef9d --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/get-a-single-list.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-a-single-list.api.mdx new file mode 100644 index 00000000..d00690b6 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJytVMFu2zAM/RWDpw0QknTosMK3Hrai24AVW4cdghwYm4nVypIq0W0yQ/8+UHbTpE2HHXayLVLke3zP7KGmWAXtWTsLJVwQF0ZHLpbbQnMsdA0KGNcRyjl81ZEjLBREqrqgeQvlvIclYaBw3nED5XyRFgo8BmyJKcScEKuGWoSyB956ghIiB23XoIA22HojR5p0bTbbdftwc/bBbX6/bzbMrjqT7ppzinS/rCEpCHTX6UA1lBw6UmCxlQQzJCjQwsQjNyBoAkXvbKQoCN7NZvI4JP1teUMVFw+am4F8jYwTUFA5y2RZbqD3RlcoN6Y3Ua4dIeZyIVDgg/MUWA9Ndf2SfHqEfSRwgO7l1GxnDC5lJkI/KdDVscSUhSArM/mXKkPCEZFs14r6LdoODSiILQYWG9S0ws4wlI+xpOCuo7D9p36+Wxpd7aUunTOEFtKBxHPIHszDGqnuEduVWRwaBVKSMqez05dyS7ywjouV62z9/2SuXH1cz5ZixPWx2DOmucJT/iINLFrixtVQwppyV3F2CVOxapz2g+2TCEPh/vGn64KBEnqs60Axpil6Pb0/AQX3GLTokCGP4WFGj2I2zD6W0ymH7eQWA94S+Ql6D8+cCdcNFWOFwq0Kbqj4MuYXAxaRYW9f/JBJDp33t8ZuLNJZeOQ0cUROAjW+fHKhRUH4+dd1np22KyfXhfUA6WQym8z2lsYOz/nV5VH851eXxcqFQ/BCVhzqIreYPTCuGFmPWERt14byqnhes38y0yu7dGDKtOGpN6itNMpi9aOw87zIIigox422UNC4yBLq+yVG+hlMSnI8/m3zxZOuWf1aR3mvoVyhifQXkG++j/57W7yGbjxEu832MZ18gYJb2j5t3bRIChrCmkJGMATPq4o871178X+JPXb+vvh4DQrw0BTPTJCrH4XU90PGtbslm9IOIcu3AEzpD17EW8M= +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},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"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.28.0/api/get-a-single-tag.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-a-single-tag.api.mdx new file mode 100644 index 00000000..7375b7f6 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/get-all-bookmarks.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-all-bookmarks.api.mdx new file mode 100644 index 00000000..7d4b08d4 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJzNGMtu20bwV4i59EJYTo+6OUGbukUTA3HQg6HDiByKGy13md2hHEXgvxezpEjKXttUYqA9idqd92tn5gA5+cypmpU1sIT3xAlqnayt3Vboth5SYNx4WN7B2+FslYKnrHGK97C8O8Ca0JG7ariE5d2qXaVQo8OKmJwPAD4rqUJYHoD3NcES1tZqQgNtCo6+NspRDssCtacUDFYCgi4r1Y5ySEGJaF8bcnto0x+jVuDOisCz6Hl2ymwgBTJNJaqjzyANphLdcyqw0QzL7uQZrt46/uhycjOYmqZak3uOmlaV4nPEZ8VaDt41zttnSWcdxHxTT6zArqH0QRxdF4knTtgm4XaIp198klnDZDi5VxJnlCiT6SanPFEm4ZISR762xtNF8sEypQmXakTK0AiORrehpLAu8baiMVovojr+T0QbjN2TfdchPjD6ShTo2Hix+6+Xl/JzqsPH9RfKRE4uT9M1yZFRWPVSCSrWtVYZCuriixf8iF9toAgp1M7W5Fh13Mc6MIKic7gXqZkq/zIJlT8OzTaFzBEy5Vccva1srgoVv07BNFrjWkJbXNgOgT4Dcqgq0eoxqRLRe8bNRpnNJ0Zu/Mv8xgLimywjL9W0QKUbR2ImMrlgrdoUfFNV6NT34KXXJ28szzNPJ8d+HqxtXDaD7KSM1gpSuKe1BKiW78qulRZp6RuT8RLdKXhlNpqK7sIFtVRVW8dBl+45euVo7DIzcoHMmJWUv43aZFBMdCmbCg2s2pMSdCcce/on1ALcJEutoY9FeCyfV6C7fVoUrcw22KlxOqrR/Fw5qTkz4FWFG/ocY/sU8JX3xNcRl8TCLXNExpeWz8EqGq1vhFOX9+eg1o4yh/ea8h9A3qmc7FmC4k5lMw1dcqXfjaHzInwfZueIc9R8HgNsuLRunlWbtVa+pHnQOTLd9BjzBBeMv/vXYwbCg2QN0F3urKT/+blcZPrW1yz5iCVjV0Pn5Uxc1COPn5UVJTiCsOHr9gXwkL7CJC9GpFhsSWgrTR+iBfbJV2VuFfHq+5Rs30M/nQI/bObRKKOur2D1xmyNvY+8GgFh1Q6mff0nb5ab5TX5Y1JtpmX4aIlP05M1GkPuuo+OB9UX+roocH1jGWoSRIqtZKEn97nWFvMwtY22OiukYs/xqPuqjQKM3elJL5pOp9KTkfK0M4w3dH3vMgbj4NvVOKsdp2wQuQx94354O1vR6Qg/oTNhdYMbZUTNcbJv22CPiri0OSxh0zkHZbKHxZSkJ7c7jveh1YAD5rkj79sF1mqxeyPeRqdEwhCH/XU3zRwn6JK59svFgt3+YosOt0T1BdY1PBzbbktKegqJLcI49lcPn3SyiPCTzcQnGXH6KWaynxjMKJxDPAuYtPkBSEIzfPxuXYUi4Z//3AZfKFNYQRetO5HeXFxeXE7G7EGeq5vrqPxXN9dhMjwRXpSVd9F6lv5xeTiOibFdzIOWbKhq8cVNp6i8EItaowojTN8Wdi6dRskqhdJ6lsPDYY1eanDbynE3mYqjc+XFneNovaX96apmh7oRpmF78AT4SeLMQZiuUebAHxclc2CHzcfzwE8a/j9cJ0T922n1aMUwarca0zJs61IoCcW24uAO+yrLqJ5iPVohCJWhSLz/7Ra6HnA6NZ+m03SyQbOf0D4cOohbuyXTtnBUgeU/tFKg/wWnsCCK +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":"string","enum":["asc","desc"],"default":"desc"},"required":false,"name":"sortOrder","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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"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},"contentAssetId":{"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":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","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.28.0/api/get-all-highlights.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-all-highlights.api.mdx new file mode 100644 index 00000000..a2577cf4 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/get-all-lists.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-all-lists.api.mdx new file mode 100644 index 00000000..04adc330 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJyNVE1v2zAM/SsGz0Kc7ehbDlvRbcAKLMMOQQ6MzdRqZEmV6G6Gof8+UHY+G2A7WRYfP98TR2go1kF71s5CBQ/EBRpTGB05ggLG5wjVBr7l/62CSHUfNA9QbUbYEQYKq55bqDbbtFUQKHpnI0WoRvi4XMrnOsP33QvVXPzW3J4zFQ0yLkBB7SyTZXFD742uUdzKlyi+I8S6pQ7lxIMnqMDlaKDAB+cpsJ4yT+WfYRgCDqBAM3Xx3+66ucBEDto+Q1JgsaO7hqsOb+0KbG8M7gxBxaGnpEDX94BJgcdAlh/vpL8TZQK8B5LtO+GsQ9ujAQWxw8BCXkN77A1DdbQlBa89heG/8vl+Z3R9Ad05ZwgtpCTEv/Y6UCOJdQPzsOZWLxo7hdkqYM0SPosL0m2UicNtStnSEbeugQqeKfOFojkojzqNFN4oxKzKPhioYMSmCRRjKtHr8u0DKHjDoKWjzPFsngR6HEvL7GNVlhyGxQEDHoj8Ar2HG45h3VIxRyjcvuCWiq8zvphqkYYu3ssPUe6U+fLVnGYpmaWPDJPZZhCo+fDZhQ6lwi+/1nne2u6duEvXU0kfFsvFEs5TPdWzenq8W//q6bHYu3BdvDQrXLvIHWaRTqp/txluNH96uO9XyNQg0x8uvUFtJX7maJxpPHGtoHWR5WIcdxjpZzApyfUs0s32TGLeOApawoZC5v1AA1SwqmvynNk2fX77t3tEaDnJ6eHTGhTgNRk3w8/Rj5vEDhexx3FCrN2BbEqg5iJY/iGJeP8CO0jVRg== +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},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}},"required":["lists"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.28.0/api/get-all-tags.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-all-tags.api.mdx new file mode 100644 index 00000000..50358c6f --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/get-all-tags.api.mdx @@ -0,0 +1,71 @@ +--- +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: eJydVU1v2zAM/SsGz0LS7uhbWmxFt8MKLMMOgQ+MzcRqbEmV6KyB4f8+0HK+0zTYSXFMPj6ST88tFBRyrx1rayCFJ+IEqyphXAZQ0B/pDKZyZgoC5Y3XvIF01sKc0JOfNFxCOsu6TIFDjzUx+dAHhLykGiFtgTeOIIXAXpsldAo8vTXaUwHpAqtACgzWEiHHozWM2kh9LZzeGvIb6NTHgArINLUQ7WEUNAGXcnqqaI0mJyFf0AKbiiEdXl+hEazn/ymPGhSUTY0GFBhrCLIrVZAZ85KKh83tta7A5Y0P1t8AZZp6ThJomqrCeUWQsm/oCnSla306kEzCg7MmUBDwL3d3chzr6ef8lXJO/moud7pKCmQcgYLcGibDkoXOVTpHyRq/Bkm9wNv2YKDAeevIs46Fo0h3Ueg99gNlqsPn2bq4OOTY+KUXTf1g7apGvwrnMz0JeNhMhh1P+7DPyKC+CBkVdf6m6452NpNm1PYOHBG9SitTwJpFBnLRQUANvfNj1NMFuZ/o5oTE4B0HEFkXqdbEpS0ghSX1vaNYB4yHhEB+vbWOxleQQotF4SmEboxOj9f3oGCNXkvpOK74Ospue7lLZhfS8Zj9ZrRCjysiN0LnQJ1oc1pSMiAkdpFwScmPIT6JXGTCB673SwQZKx96324+Uln66MMgHYJADT++WV+jMPz+Z9oPWZuFlXTpOlK6H92N7mC/jh2fycvzRf6Tl+dkYf0xeWm2U+Bs4EE3wzU+cfcjuHZ/Hc++ArE9pnceuwq1EfR+Q+2ww2HpmYLSBpbntp1joN++6jr5O3qGbLbQQfa3t5gVbc6Nf41VIzV7A/sgZTDpW0KPnPaWhJ2X3hK8dcd9bLYXav9tVFASFuT7CcSkSZ6TO8w6s0BB2d2Yp69TUIDHgjsRWI++dUFz2GrbxoipXZHpOtgyZ3mGTu7nPyWsuhQ= +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 + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string"},"required":false,"name":"nameContains","in":"query"},{"schema":{"type":"string","enum":["name","usage","relevance"],"default":"usage"},"required":false,"name":"sort","in":"query"},{"schema":{"type":"string","enum":["ai","human","none"]},"required":false,"name":"attachedBy","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"number","nullable":true},"required":false,"name":"limit","in":"query"}]} +> + +</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"}},"nextCursor":{"type":"string","nullable":true}},"required":["tags","nextCursor"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.28.0/api/get-bookmarks-in-the-list.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-bookmarks-in-the-list.api.mdx new file mode 100644 index 00000000..5f13a883 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/get-bookmarks-in-the-list.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-bookmarks-in-the-list +title: "Get bookmarks in the list" +description: "Get bookmarks in the list" +sidebar_label: "Get bookmarks in the list" +hide_title: true +hide_table_of_contents: true +api: eJzNGMtu20bwV4i9tAUIyylSNODNCdrUfcRG46AHQ4cRORTXWu4yu0PZisB/L2aXIimZkunEQHuyzJ33e2YrMnSplRVJo0Ui3iNFC2NWJdiVi6SOqMBISUciFgRLJ5Jb8ad05MQ8Fg7T2kraiOR2KxYIFu1FTYVIbufNPBYVWCiR0DoP4NICSxDJVtCmQpEIR1bqpYgFPkBZKf4kUWbqYbMs7+/e/GwevvxUPBCZ9A1zl+RBmPtlJppYWPxcS4uZSMjWGAsNJQOoABALyQpVQIVo4pPsdV2yXuBSEXt7sHIZ5lArEkn4sscvB+V6hs5YurIZ2h3PzzXazThTXZcLtKeoKVlKmkCpE39nmHe1deYk6TRAPE17YYxC0GJghWDi/WC5zCOHFJGJ/GsXON+5KDWaUFN0L5WKFhhJnao6w2wXUhZdZbTDs+iDIYwjKmSPlIJmHAV2iVFubORMiX1Yno3q+D8RrTN2S/ZdQDww+pwVCGwc2/3H83P+s6/D1eIOU5aTCp+CUQYEzKEVhjGgqpRMgTFmd47RRtxpPCERi8qaCi3JwLSTegAK1sKGhSUs3dMkZPY4IptYpBaBMLug0dfSZDKX48+x0LVSsOCIZs81XXxPgASbFnKN2UgkN7HIYW24XB17J1gupV5+JKDaPc2vrxuuTlN0TjALqWqLbCbUGWPNm1i4uizByi/eSy9PXhuaZp4gx2YarKltOoHsoHpWUsTiHhccoIp/l2YhFfr6TqgdB3UsnNRLhXl4sF4tWVbGktcltJgXjsaQkCMPQARpgdnbUZt0irEuRV2CFvNmr/LcMseW/h41DzfIUqPxKvdN8LQC4fW4KErqlbdTbdWoRtNzZa/UTICXJSzx0xjbY8AXziE34knhllpE7QpDz8HKa6WumVPI++egVhZTC/cKs69AXssMzbMEhbVMJxq6oFK960PnSfg2zJ4jzk7zaQygpsLYaVatF0q6AqdBZ0B43WJME5wx/mq7xwSEg2T10CF35jz2fFsuEj60NYt/jCVjqKHTcmZc1B2Pb5UVODi8sP7XzRPgPn2ZSZb3SGOxxaEtFX4YLbBHu8rUKuLklyHZdnQ+ngJfbebeKL2uL2D1Wq+0uR/pGh5h3nSmffmWN8nN3E1+G1SbYRneWeLj8MsCtEZ72UbHQfUVbV1kuHaw9DVJjBRbzkKH9lOlDGTIPbS31bNCaqwd97rPm1GAfjrdm0UH8+PesHg4GY4PdO3s0gdj59t5v6K9bQ0jWC6ND9TubM9WtB/d9+gMWF3DUmpW820H2nhzvD5//XjV4KU60oai3NQ6e7kVIzXZ+OhVonMcRo/fDjT1FHp4dmnj8akwmUjEMkQYb/mJmPGa5GbbcAJoZkMzObTr3SnCj09iC1lm0blmBpWcrV9xBIOVbHUvfPscrLU7BhRElUtmM7KbsxVYWCFWZ1BV4nADvSkwailEJveb5R8tfBRkYYcMrigf2abtZja4pXQGYs4+RxmMVxcPxOnmf/xqbAks4e//3HgrSp0bRmetg0ivzs7PzgcXg06ei+vLUfkvri/9krsnPCvLvd444pk42e423lO3o4Nxswuv0wenoDh3wVmlQPo1rR19g8dv/bWH3Zt0Z5/e6fNYFMYRg223C3DceZqGP4c1nEMhk44d3t8RVrg5uOmsQdUsh7+VHIHfXW2mwHZnmNPAR032H942Rj0StHp07+i1m/eJNW7zo6p+/3dbCn6IjnHf9U29GfLs/RKuhdxXCgR2KEsQHi/SFKuhqI9KHYvelZr3v9yIMA4PDwj7WThc8vZF2m4DxI1ZoW6aTkLi/1nApvkXsx9wOw== +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 bookmarks in the list"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/lists/{listId}/bookmarks"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get bookmarks in the 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","enum":["asc","desc"],"default":"desc"},"required":false,"name":"sortOrder","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 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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"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},"contentAssetId":{"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":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","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.28.0/api/get-bookmarks-with-the-tag.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-bookmarks-with-the-tag.api.mdx new file mode 100644 index 00000000..0b5fc82a --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/get-bookmarks-with-the-tag.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-bookmarks-with-the-tag +title: "Get bookmarks with the tag" +description: "Get bookmarks with the tag" +sidebar_label: "Get bookmarks with the tag" +hide_title: true +hide_table_of_contents: true +api: eJzNWF9v2zYQ/yoCX7YBQpwOHVb4LQ22LhvWBquLPQR+OEsniTFFquTJiWvouxdHypLsyInSBtie4oj398e7493tRIousbIiabSYi3dI0cqYdQl27aI7SUVEBUYEuYgFQe7E/EYs+O8yFg6T2kraivnNTqwQLNqLmgoxv1k2y1hUYKFEQus8gUsKLEHMd4K2FYq5cGSlZrl4D2Wl+JNEmar7bV7e3b751dx/+aW4JzLJG1YuyZMsIL9KRRMLi59raTEVc7I1xkJDyefkz2Mh2Z0KqBBN/KhyXZfsFLhExB4Ndi3FDGpFYh6+HKjLQLlenzOWPtgU7V7n5xrtdlyprssV2sekKVlKmiCpM38Py2VtnXlUdBIonpa9MkYhaDFAISB8GCpXWeSQIjKRP+3C5gcXJUYTaorupFLRCiOpE1WnmEZS+3Cy6CqjHZ5F7w1hHFEhe6YENPMosDlGmbGRMyX2QXk26uP/xLQO7FbsZWA8An3JDgQ1jnH/+fyc/xz68GF1iwmFFFTSUZQCAWtojWEOqColE2CO2a1jtpHrNF6QiEVlTYWWZFDaWT0gBWthy8YSlu5pETJ9GJFNLBKLQJhe0OhpaVKZyfHjWOhaKVhxRPPNNV18T6AEmxRyg+lIJDexyGBjuFidOifIc6nzjwRUu6f19XXD1UmCzglWIVVtkWFCnTLXsomFq8sSrPzib+nlxWtD0+AJdmyn0ZraJhPEDqpnJUUs7nDFAar4d2lWUqGv7oTacVDHwkmdK8zCgfVuybIylrwv4X154WgMCTlyAESQFJi+HcWkc4x9KeoStFg2B5XnhjW28g+kebpBlhqNHzL/BD7uQDg9bYqSeu1xqq0a9Wh6rhyUmgn0soQcP42pPUV84RzS1ciVjIVbYhG1Kww9hyurlbpmTSHvn8NaWUws3ClMv4F5I1M0zzIUNjKZCHRBpbrsQ+dJ+jbMnmPO3vNpCqCmwthpqNYrJV2B06hTILxuOaYZzhx/t6/HBIajZPXUIXeW3PZ8Xy4S3rc1i3+MJWOoodNyZtzUvY7vtRU4OLyx/tfiCXKfvqwkzXqmsdji0JYK348W2JOvytQq4uSXodi2dT6dAt8Mcw9K7+sLoF7rtTZ3I6+GZ1g2HbQv/+RNumZ+Tf4YVJthGd4j8XH4ZQVao71qo+Oo+oq2LjJd21j6miRGii1noUP7qVIGUuQ3tMfqWSE19hz3vi+bUYK+Oz3oRQf940GzeNwZjjd0be/SB2N3t8t+RHvbAiPYLo331M5sz3a0b90P5AxUXUMuNbv5tiNtPByvz18/HDUWkEfaUJSZWqcvN2EkJh3vvEp0jqPo4dmRo15CT8832nh+Kkwq5iIPAcZD/lzM+ApmOz//N7MhRg7tZr+F8L2T2EGaWnSumUElZ5tXHL5gJUPuTW+PA1T7TUBBVLn5bEZ2e7YGC2vE6gyqShyPn4sCo1ZCZDI/Vv7V0kfBFr6NwQLlIyPajmWDNUoHD2v2CcpkPLd4Is41/+N3Y0tgC//8d+ExlDozzM5eB5NenZ2fnQ/WBZ09F9dXo/ZfXF/5CffAeHaWH3rjiBvi+W4/7j66NjpqNrvoemLZFFznR3BWKZB+Sms733DjN/ukm+93Pv2lL2NRGEdMtNutwPGz0zT8OczgHAqpdHzh/RJhjdujhc4GVM1W+EXJCfr9ymYKbbeDeZz4JGL/4WJj9D6CVw+WHb13yz6xxjE/6eqP/7SF4KfolPb9o6m3Q517q0JQ+He2QOD7ZAPC2UWSYDW09EGdY8u7OvPut4UIrfBweXCYhMMB79Ci3S5QLMwaddP0BvL/bGDTfAVlGWzq +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 bookmarks with the tag"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/tags/{tagId}/bookmarks"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get 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":"string","enum":["asc","desc"],"default":"desc"},"required":false,"name":"sortOrder","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 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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"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},"contentAssetId":{"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":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","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.28.0/api/get-current-user-info.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-current-user-info.api.mdx new file mode 100644 index 00000000..e2cbb08b --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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/SvCmwnL7ajNQxukHRq0DjoYHs7SOWIsiQx5SmsI/O/FUUJiJx2iRRJ5H+/eezeh4VgH68W6ARV+soxhiIUdjq6ggxulkJaLegyBBynGyAEGQg8R1Q73kUPE3iByPQYrZ1S7CQemwGEzSotqt097g8DRuyFyRDXh83qtr+u+Pw6PXEvxx0qbmxQNCa1gULtBeBDNIO87W5NmlI9R0ybEuuWe9EvOnlHB5UIw8MF5DmLnpra5iIkS7PCAZDBQz+8vDIax6+jQMSoJIycD7sl2H4rsXE2dEnMRfXCuYxqQknLxNNrAjfJnG1wm7JM+Bj1L6xpUeOA8CSmTKJWXWPYM5Ts8K/VK9xg6VJioaQLHmErytnz+BINnClahZQKW65n5I42doEIr4mNVlhLOqxMFOjH7FXkP80aebcvFUqFwx2yJ70t8MWNBSunCCL9Ul7nzpR1eGNHOOkcOU4ZyEMzy8dWFnhTht9/bzJr6UdN16hnSp9V6tVYvWlH28YJnc3f7X/ybu9vi6MI1eB02GXgXpafsqNkSuGG5cn3eiLd1p1d7fnRz5vGF/0rpO7KDds8KTovOO2SdoTbQ1WpdFD2dpgNFvg9dSnr8NHLQddu/6py3zaBlatR9uwknPqPCpq7ZSzZEN2r3d4ukyr2Y7ubLFgZ0rdcbfXL15YqG80XtaZojtu7EQ0owCwjRfyS1+D9TYIbk +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},"localUser":{"type":"boolean"}},"required":["id","localUser"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.28.0/api/get-current-user-stats.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-current-user-stats.api.mdx new file mode 100644 index 00000000..483f1f86 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJylVkuPm0AM/ivIZxSyPXJL1cduH2rVZlVVUQ4OccI0MENnTFqK+O+VB5IAG7S77WnZ+PXZ/mxPDVtyiVUFK6Mhhi/EpdUucIzsAtyYkgNOKUhKa0lzUDqyEALj3kG8gntH1sE6BEdJaRVXEK9q2BBasouSU4hX62YdgiVXGO3IQVzDi/lc/gwDf9r8oISDX4pTH6RFMIMQEqOZNIsJFkWmEhST6IcTuxpcklKO8sVVQRCD8Z4ghMKagiyrNqou85fGHHK0B9fT1mW+IQtNKF9v8GisYppUWNgkVUfaTsmXvi7XZR+U40nhrdqnmdqnExqbE/KX1dLLHss2U/pw1RPTb74qQOfomqSR7v0slZWsV63jzs3JaC1+TfHK5Kh0PwG0FisIQTHl7nHQW++gp+fYKr0XdIkp9RPQdR5O+gIsx993bfibucfJmC0E9lf1h6Yr8bDSz0yGh9aPp9Jhm4A1StRLT776luumRxel94uE1dEP5qOAU+W+EU3QJlXuo9Ey0RPS74T2OnerW1Pafy9kOrS+OH4iJ7z9hREe0SusPu1GyT6XrFj9D6qtj3UGNW7vqRf9yvfqfK7qMBk/iLi/d7j/D+ZqzJ/H3BF4bz85gmPl/loeLeHhyr0s2N46HS/Ph6tysJoezP9o2q+PTq+o0ipJISdOzRZi2JMvIMpkQCSXy0U5Rf56gdxFe5QTKWextBnEUON2a8m5JsJCRccbCOGIVuEma6vfidsLucMyY4ghZS5cHEVsq9kBLR6IihkWBYSjM7pMKeg8BGbnT/f7Tj9osUDTNL2D/VXOZxu5f7bPPZbIkodXg7hTkkL5jzfG5igI331beiIovTNiLlm3kG5m89lcaqg4Ew9nPIvPd1fxLz7fBTtjh+Al2SaEwjjOUV9oCm+JB6+T4FT6geP68ox48hunLYBcuqjI5Kw0YdvDuuv3Cny/QeggNfKB1yGkxrFI63qDju5t1jTy88+SrDyQ1peO+/dRCCnhlqwnyYEqiGGRJFSwp0ZW+hEev3ykh2cSvn29FCYPOzfqlPd+Wgi66vmu61ZjaQ6kmwbCDgTL/9AI5f8C4yOBiw== +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"},"bookmarksByType":{"type":"object","properties":{"link":{"type":"number"},"text":{"type":"number"},"asset":{"type":"number"}},"required":["link","text","asset"]},"topDomains":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"count":{"type":"number"}},"required":["domain","count"]},"maxItems":10},"totalAssetSize":{"type":"number"},"assetsByType":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"count":{"type":"number"},"totalSize":{"type":"number"}},"required":["type","count","totalSize"]}},"bookmarkingActivity":{"type":"object","properties":{"thisWeek":{"type":"number"},"thisMonth":{"type":"number"},"thisYear":{"type":"number"},"byHour":{"type":"array","items":{"type":"object","properties":{"hour":{"type":"number"},"count":{"type":"number"}},"required":["hour","count"]}},"byDayOfWeek":{"type":"array","items":{"type":"object","properties":{"day":{"type":"number"},"count":{"type":"number"}},"required":["day","count"]}}},"required":["thisWeek","thisMonth","thisYear","byHour","byDayOfWeek"]},"tagUsage":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}},"required":["name","count"]},"maxItems":10}},"required":["numBookmarks","numFavorites","numArchived","numTags","numLists","numHighlights","bookmarksByType","topDomains","totalAssetSize","assetsByType","bookmarkingActivity","tagUsage"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.28.0/api/get-highlights-of-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-highlights-of-a-bookmark.api.mdx new file mode 100644 index 00000000..02f4a0c4 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/get-lists-of-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/get-lists-of-a-bookmark.api.mdx new file mode 100644 index 00000000..1b7134a9 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/get-lists-of-a-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-lists-of-a-bookmark +title: "Get lists of a bookmark" +description: "Get lists of a bookmark" +sidebar_label: "Get lists of a bookmark" +hide_title: true +hide_table_of_contents: true +api: eJytVE2P1DAM/SuVTyBF2wEtAvW2SIAWOCBYxGE0B0/rmWanTbKJu8xQ5b8jp52v3bJw4NSPPMfPz8/uoaJQeu1YWwMFfCDOGh04ZHaVYba0dtOi34ACxnWAYg5vx18BFgoClZ3XvINi3sOS0JO/6riGYr6ICwUOPbbE5EMChLKmFqHogXeOoIDAXps1KKAttq6RX5p01Wx36/bn7ZvXdvvrVb1ltuUbYaA5QfYMriuICjzdddpTBQX7jhQYbAW0PIIUaCnNIdcgrDwFZ02gIExezmbyOFfhpqakgohQ63Xd6HXNARSU1jAZlgh0rtElSkR+GyRsokC7vKWSQYHz1pFnPSRNCp/A0HvcCU+mNvw9XFePNYz7yicOzop7LL7pmgaXIq0oGBXocgoYUz/J8PVE+olbBsBEr03XipFaNB02oCC06FncVNEKu4ah2J9FBXcd+d0/5XPdstHlCXRpbUNoIJ65ZC7yjWKNpZ4UdrhmcfTbZx0Y4sNbhh4uYjq4nF0+dtHep5mxnK1sZ6r/56DSVtO9bikEXE+dPeCfbjjiUyEpnmtbQQFrSlllaArI9+MU8v44WTEfRJA94O/3U975Bgrosao8hRBzdDq/fwEK7tFr6VgqYDweVNu3vWZ2ochz9ruLDXrcELkLdA7UxICON8iMck3ZpxGfDVykYScL6pvoOmQ+XVMHkSSz1JFg4p0EAjW+vLe+RWH48cdNUlKblZVwqXqg9OJidjE72VIHPldfrif5X325zlbWn5OXYsXLNnCLyRHjPvvzYn4w3QeDPbXLh6KZtpy7BrWRnKlv/djx+WGBSnuLs206Ol9BbQMLtO+XGOi7b2KU3+PIzhfHlidjVDrIewXFCptATzB/9nU06vPsT2z3m9PskrOaTr5AwYZ259s/LqKCmrAin1gMgKuyJMcnoY+GUdxzGIYP725AAZ575oFH0u2TtPp+QNzYDZkYDyxZvoVgjL8BtGuT5g== +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 lists of a bookmark"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/bookmarks/{bookmarkId}/lists"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get lists 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":{"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},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}},"required":["lists"]}}}},"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.28.0/api/karakeep-api.info.mdx b/docs/versioned_docs/version-v0.28.0/api/karakeep-api.info.mdx new file mode 100644 index 00000000..3e4eb827 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/remove-a-bookmark-from-a-list.api.mdx b/docs/versioned_docs/version-v0.28.0/api/remove-a-bookmark-from-a-list.api.mdx new file mode 100644 index 00000000..aa3dc73e --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/replace-asset.api.mdx b/docs/versioned_docs/version-v0.28.0/api/replace-asset.api.mdx new file mode 100644 index 00000000..53865886 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/search-bookmarks.api.mdx b/docs/versioned_docs/version-v0.28.0/api/search-bookmarks.api.mdx new file mode 100644 index 00000000..47d9cf2e --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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/ivCXNoCQpzt0Tdv0EdadBM0WfQQ6DCWRhbXFKmQlBOvof9eDClLsiMn8m6A9hRHnMc3T85wBxnZ1IjKCa1gDneEJi2ipdbrEs3aQgwOVxbmD/Cx+5bEYCmtjXBbmD/sYEloyCxqV8D8IWmSGCo0WJIjYz2BTQsqEeY7cNuKYA7WGaFW0MRg6LEWhjKYO1NTDApLJniEGAQDeqzJbKGJTwuJgVRdMkK0KcTeIGDBkjaoUmK4GeVYSwfzwecD5TlK22u32rgbk5GZgELV5ZLMa9KkKIU7xx4nnOQPV7Wx+lXRaaB4W/ZSa0moYOCK4O/D8F/nkSUXOR350y4PfrBRqpUj5aInIWW0pEioVNYZZZFQkSsoMmQrrSxdRJ+0ozhyheiZUlTMI9GsKMq1iawuqc+yi1Eb/yfQOme3Yq8C45HTEzYgqLHs958vL/nPoQ03yy+UMk5XeGA2VJshW0vnVbWomBWrSooUmXX2xTL/SFy1lwgxVEZXZJwI2vv67UnRGNwyakelfVuEyEbrNTWEjrKFGz0tdSZyMX4cg6qlxCWnNoew6RJ9AiX7SWwoG0npJoYcN5rb0alzh6uVUKs7h662b+vrO4qt05Qsd8EchawNsZtIZcyVNDHYuizRiK8+Su8vXmk3zT0Bx3Yara5NOkHsoK9WAmJ4oiUnqOTfpV4KyWjp2ZGynN0xWKFWkvJwYLxZoqy0cd6WcI28czaGyhw5QOcwLSj7OOqTzjC2pahLVJA0By3ogTW28g+kebpBlWpFN7m/5F43IJyehiKFWns/1UaOWjS9Vg56zgR6UeKKPo+pPUW8sJbc9UhIxtItNUTKFtqdw5XXUt6yplD357BWhlKDT5Kyb2DeiIz0WUBxI9KJji5cKa/61HmTvk2zc+DsLZ+mAGtXaDPNq/VSClvQNOoMHd22HNOAM8df7e0xgeGoWD11qJ2E55/vq0VHz23P4h9jxRh66LSaGYe61/G9WJGTw4P1v+7fIPfly0qyvGcayy1ObSHp02iDPXmrTO0iVnwdim1n6NMl8M1u7p3S2/oOXq/VWumnkVvDMyRN59r3v/ImhZlvk98H3WbYhveeuBt+WaJSZK7b7DjqvtD2RaZrB0vfk2Ck2XIVWjKfK6kxI75De1+dlVJj13Fve9KMEvTT6cEsOpgfD4bF48lwfKBrZ5c+GbvYJv2utt+OgXEpenbt8na2ocPVeyBnoOoWV0Kxmf1G3jTeHyW5Qmcwh1UIDvJGDrNO5CwsHGwnmc1+O/cTB+wwywxZ28ywErPNBw46GsFAfTq2x2Gp2W/ThXOVnc9mzmwv1mhwTVRdYFXB8fZ2X1DUSoh07pefP1v6KGBhGwYPC3e86bTLzOB5ofMma/ZpzWQ87XsizlD/41dtSmSEf/xz70MiVK6Zna0OkD5cXF5cDrbtDs/i9noU/+L22i+IB+DZWL4etXU8Rs53+21x5CXlaDDretvoq0swk6+JWSVR+D2mnQ1DXA9TpY1sEkOhrePT3W6Jljty0/DnsKdyvDNhOaonFu0hrh//bhPzp+gUpDVt2+eaDcqaz/0DxAsdgW74sDKFfv90MoW2ewt5nfiksf/hA8Mrnn3x6NBbl/QV6t/dYigI2bcc5MC9SFOqhlwvHhVYStc2fvvlHsJUONyjDytruOug2g5k73aB4l6vSTUN7E1w/D803LL/BR6EDps= +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":"string","enum":["asc","desc","relevance"],"default":"relevance"},"required":false,"name":"sortOrder","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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"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},"contentAssetId":{"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":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","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.28.0/api/sidebar.ts b/docs/versioned_docs/version-v0.28.0/api/sidebar.ts new file mode 100644 index 00000000..fc37c831 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/sidebar.ts @@ -0,0 +1,282 @@ +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-lists-of-a-bookmark", + label: "Get lists of a bookmark", + className: "api-method get", + }, + { + 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-bookmarks-in-the-list", + label: "Get bookmarks in the 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/create-a-new-tag", + label: "Create a new tag", + className: "api-method post", + }, + { + 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-bookmarks-with-the-tag", + label: "Get 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", + }, + ], + }, + { + type: "category", + label: "Assets", + items: [ + { + type: "doc", + id: "api/upload-a-new-asset", + label: "Upload a new asset", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-a-single-asset", + label: "Get a single asset", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Admin", + items: [ + { + type: "doc", + id: "api/update-user", + label: "Update user", + className: "api-method put", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/versioned_docs/version-v0.28.0/api/summarize-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/summarize-a-bookmark.api.mdx new file mode 100644 index 00000000..23bd3d61 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJytVU2P4zYM/SsGT1tASLLFFrvwLT0UmPbQQWeKPQQ50DYda2JLWonOJGvovy8o53PG285hTnFEinx8fKQGqCiUXjvW1kAOS2YsGwoZZqHvOvSHjG3GDWWFtdsO/TZDU2WeuPcmJEPvKmSSs9L6agYKGDcB8hX8frwSYK0gUNl7zQfIVwMUhJ78sucG8tU6rhU49NgRkw/JIZQNdQj5AHxwBDkE9tpsQAHtsXOtHGnSVbs/bLrnpy+f7f77b82e2ZZfBIHm5HJCcFdBVODpW689VZCz70mBwU6ciouTAi0sOOQGBJWn4KwJFATJr4uF/NwS9njFwJmiZ83NiT9QUFrDZFguo3OtLlEuz5+CRJio1RZPVDIocN468qzH/Lp6zUdUUHqS7EuetHa20rWeNiswfdtiIVQJI/FM3Bs80ZeN3tE1psLaltBI2hp3Vtr9MzvjZqPN5oGR+/D/+RSQ6TvRVOjLkkIASaHb3pPQRKaSW+uoYGRdf08Uv394Y/lt9Jy6/yZf2/vyDWEvMNFpUPBMhairle/OFrqlNB9MJog4FQRtNi3Vo8GnsnTnrGdYx5t5WIm4rqV0I5yrZt909mUbp9lfxyjJPi0+vZ6e03xmxnJW295U7zcupa0mOJWRoBBwM2V7wUmKcPFPhaT73NhK1oQNKa1sixzmp/EP8+GyUuL8xImECuR3pxXX+xZyGLCqPIUQ5+j0fPcRFOzQa2l6quJoHqmrsW8ZcmiYXcjnc/aH2RY9boncDJ0DNbGdjhEyW6d1/dfRPxuxQIzxajs/CLlj5usdfWZKMksdyU1GOjmBOn78YX2HgvDPr4+JTm1qK9el6hHSx9litrha0Wc8y/u7SfzL+7ustv4WvBQbVepAh0kWx2X+cGI7w/M+fhl2uEjsnR68kRymPc9dizqtuNTf4aiO1fmVkTHJb56ci0DWChrRVL6CYSgw0L++jVGOv/Uky2S1vsgjiajSQb4ryGtsA/1HoR/+OSr7l+xniI+HaA5JhW0v/0DBlg63z2SUVdgQVuQTitFhWZbk+Orqq+kVpZ2n5/7vh0dZLbcCeyGoFH4S1zCMHo92SybGM0yW/4Iwxh/uYBE2 +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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus"]}}}},"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.28.0/api/update-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/update-a-bookmark.api.mdx new file mode 100644 index 00000000..3cc383fe --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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/SvCnFpAtb1Figa6OUGLbj/QRbJBD4YPI3FkcS2RCkl5rRj678VQsj52lY2Krk4iOSSHb+bNmwsIsomRpZNaQQSfSoGOgljrY4HmGMR1IJ0NpIAQHB4sRDt41y1a2IdgKamMdDVEuwvEhIbMtnIZRLt9sw+hRIMFOTLWG9gkowIhuoCrS4IIrDNSHSAEOmNR5jwlSYr8XB+Kx4e3P+vzl5+ys3M6ecseSOdNrh7cCmhCMPS5koYERM5UFILCgo3iwSgEyY8r0WXAXvEOsu6dFjX7MoXgPqNAoMPA6aDycKyCv1VeBy6jIJWUCxvUugoeUbnBJlBEgocxBaXRJylIrCCERCtHyvE1WJa5TJCvWT9YvmsGEB0/UOIghNLokoyTZP1ek2TyxG/sLWOtc0LFCKR40hyFr63bqijQ1HO4qyrPMWZUGbwmBKUdPTdsevC/dUQIBZ7/JHXgJLjZbDZNCIkhdCS2bpEHlcnn7FJtCnQQQWUk+zOJ2oJjsXKZNotMyyrOpc1omTWH/67bIRbv+EsLmcqFGxydl2GH1pJ7P+TcNzb4j/lgS61sm2o/bjbzpGgTXfTF4fWyW86g8HLaNCEUHYALs2ph+jKG/4trDg8HqQ4fHbrKLqELqargsmqrJCFrOdNR5pUhhomU4F37nsTyi4f49Y+f5/0MPP+lmFhdmWRR0bi6iaWEEB4p5uzK+b/QsczJS4QjZTkfQ7BSHXJK2wXjnyWLUhsH+2YiCTvw2jWk0iRxRsGeRPZpGOfR37fsebN585wwV4kKlHZBqislXo8uiRbzJboga/Ewt/YEE3/CYL/v6kBBLtOiVcok43tZMSNYXylv15dBVhuGhczpKu6+bsMFhTBkbbPGUq5PNxDCCY3kWLdK1i63iKVY5VzSM+dKG63XztSrIxo8EpUrLEsIZ+pQd0KgUy/Jf3T2QesLNE0z6ks+MqbtzePupAeIb+Z3eDNmsjeCsPv59So6v/9z71HkWH0Y2odfrm3LWKLbjB4XinamZ86IBp51w/ja4fQToxo4TLZI98MpRP30VfCGmZGujXZP5Wu6MKjUyEcvRqN7JpozSkepUs3IcIa0vt2sNqvN6Jl97LZ3t7Ox3t7dBqk200BzYrBKa+sK9MzpWr6ue8WxRD1pE3oKvtzqtsnBL12XOUpf2bu+pOXEru8vuTpEo2ZzH0KmrWOTyyVGS59M3jQ8/bkijv5uP1DCE0dIy/8CohRzSy/4/N2HjsTfB1/zsptEVXvm5RWPIIQj1dOmuOGqnxEKTofdpTPo4vjDPR8zHPCsXDXhdcc2Sah0L9ruR6Xlbnv//jfmV9d8F76YgcFHruT42Hqr/eM9bf3cBXJUh8oXN2gPbbqebizDU/L6Z83icbm0Fvf6SKppengcjxmZpvkXS5iHXA== +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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus"]}}}},"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.28.0/api/update-a-highlight.api.mdx b/docs/versioned_docs/version-v0.28.0/api/update-a-highlight.api.mdx new file mode 100644 index 00000000..e137a989 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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.28.0/api/update-a-list.api.mdx b/docs/versioned_docs/version-v0.28.0/api/update-a-list.api.mdx new file mode 100644 index 00000000..fa31e48d --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJytVk1v4zYQ/SvEnFqAtZ1iF13o5i5aNO0CDbZe9GDoMBbHFhOJ1JJUYlXQf18MJVtyrGRRID4YIjmaj/feDNWCIp85XQVtDSTwpVIYSBTaB7FrhA5eaAUSAh48JFv4pH3wkErwlNVOhwaSbQs7QkduXYcckm3apRIqdFhSIOejgc9yKhGSFkJTESTgg9PmABLoiGVV8JYmrYpjcyif7j/8Yo//vc+PIdjsA0fXIZpw9FsFnQRHX2vtSEESXE0SDJZsUPQGEjQXU2HIgbNha/LhV6sazuGy5E1OQmFAEayoY/kL8bcpGhFyEntNhfKisbV4QhNGG2GIFC93JCpnH7UitQAJmTWBTOAwWFWFzpDDLO89x5oBwu7uKQsgoXK2Ihc0eT7t67mGq9TmE5kDA30jocTjebVadfKysuu3TV0UuGMoe9Qm3lYX3t5Hbzqbc9NFdskw0N+N0Un4WpNrvlcLO613hc4mhjtrC0IDXfwxi76yxvcA/bxazVPZ06OihN+ODz1TaydfoOn/EvFmUPcGM01m6pK7t0RTYwESfIkucBsr2mNdBEhOZ68RdhXvFcqmLbqFOEMiWEOpk8LObtLLRoee9Xerd9dE87kwNoi9rY16O5ozq+b5LMl7PMydPas0ehjt00G7JYXcqn4mZXksn3UPS5apX7b94OqYGnKPp7FZuwISaFEpR953S6z08vEGJDyi08xETHo47lE60ZmHUPlkuQyuWTygwweiaoFVBXKmZwYPwu7j0PtrsBd9LkzEZOL/w1j2kadz/wwMR+Y6ohlrIhqBHB5+t65EzvDPfzcRPebo8zigfztdCKchOOrvMvHzdt8743psmXFv0PTEaJDuqf/M3nJIhr53f7NYLVaTu+cMyvrudhbE9d2t2Ft3iSAjzo1ifSjRTIoaLlo8zalnA+Os55dv5B7tQMewrArUhuNEwbSDuLbxOvQgIRnuxVRCbn3go7bdoacvrug63h7w2aajtqIClfb8rCDZY+HplTx/+Dx0wY/ipeyGTTRNlHBR8wokPFAz3t1d2knICRW5mEF/+LGP89OGXYwvX/V6J09vrLOMqvCqbTrpy7v15uMfLNLhG6GMkwAcPoGM/zFTGwuP2o97LRRoDnWcDNA7ZUnjZUc864BY1iwWbdtbbOwDma47QxN4zch03Tdsok9Y +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":100},"description":{"type":"string","nullable":true,"minLength":0,"maxLength":500},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"query":{"type":"string","minLength":1},"public":{"type":"boolean"}}}}}}} +> + +</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},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"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.28.0/api/update-a-tag.api.mdx b/docs/versioned_docs/version-v0.28.0/api/update-a-tag.api.mdx new file mode 100644 index 00000000..73362456 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJytVMGO2zYQ/RViTgnA2k6RooFubpCg2x66SB3kYOgwFscWdyWRIUe7VgX9ezCkdu3deoMc4oNtcZ44b2bemxEMxSpYz9Z1UMBnb5BJMR7UblCWo7IGNDAeIhRb2MhvqSFS1QfLAxTbEXaEgcK65xqKbTmVGjwGbIkpxASIVU0tQjECD56ggMjBdgfQQEdsfSNHlqxpjsOhvb9597s7/vdbfWR21TtJbjlBNni4MjBpCPS1t4EMFBx60tBhK3FOcQ1WCvHINQgXAVPkP5wZhMHTcjc1KYOMip3qU+kL9U/XDIprUntLjYlqcL26x45PGNURGXnckfLB3VlDZgEaKtcxdSxp0PvGVihpljdRcl1og9vdUMWgwQfnKbClKNFczvNmTekj9UTvupihv65Wl4vKRI0M8ucRs+YCLf0i3/NBbSHpKEHLXMjb1dsL3PGgOsdq7/rO/DzmlTOXKGpoKUY8/AD9dMMJX87TaIlrZ7Leqlryiu4KWIpjlmOS5ARimHD3YIc+NFDAiMYEinFaorfLuzeg4Q6DxV2TKc/h3KI99g1DATWzj8VyyWFY3GLAWyK/QO9BX9DAfINy+yTnv2e8ylxEUGdO/lc6mTOf+/mxLZJZ6kgwKGYQ6PnPRxdaFIZ/fdmk3smEPp2s9+HB6A/yPpuB7fZOAtKgzP7NYrVYnTn/kfr6+upiqevrK7V34Wmd0pdJg3eRW+zOUs9LDmd3PLluPEnuxWWYO8J05KVv0HaSJQ11nMe/zQtTQ5F3UqmhdpElMI47jPQ5NNMkx197CrJFy9P0k0aMjfLfQLHHJtJ3SL76NKv0tXqJ23yI3ZBE1vTyBBpuaXhcm1M5aagJDYVEIMfe5zS/bOSG07v/s+KkH95YVxV5/i62PLPN9Xrz/k9R0bye22RUCHgPOn0noi7VncSZzkZosDv0ybiQLxXN4VPJPpNoKutiK8YxIzbulrppOnVGnqUz0/QN/t1xKA== +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"}},"required":["id","name"]}}}},"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.28.0/api/update-user.api.mdx b/docs/versioned_docs/version-v0.28.0/api/update-user.api.mdx new file mode 100644 index 00000000..0767763f --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/update-user.api.mdx @@ -0,0 +1,71 @@ +--- +id: update-user +title: "Update user" +description: "Update a user's role, bookmark quota, or storage quota. Admin access required." +sidebar_label: "Update user" +hide_title: true +hide_table_of_contents: true +api: eJzFVk1v4zYQ/SvEXNoCjD92txfdvF+A20u6TdCDYRRjcWxxLZEMSSXrCvzvi6Fkx7GdPRRZRAdbIofDN28eZ9iBolB67aK2Bgq4dQojCRRtIP9LEN7WJMXK2m2DfivuWhtRCutFiNbjhvqRkZipRhuBZUkhCE93rfakRiAh4iZAsYBsAEsJgcrW67iDYtHBitCTn7WxgmKxTEsJDj02FMmHbBDKihqEooO4cwQFhOi12YA8wX1TkZh/FHYtYkUZvIhWtDkakEDfsHE1r+epf6dv3kKSsMcJRfQtSTDY7E3mCiRo9uwwVsDI2JpCfG/VjvGU1kQykV/RuVqXyFDGXwPjuQDcrr5SGUGC89aRj5oCzzLBl8Ij0zbMG4MBCdjTlyTsc/EXE3+0UptIm2xr2rrGFbvtw2q00Q17myQJQ97+5+qVtw+B/AePD7U2m0+GLdWRn5W1NaE585PSacZuOUd9goTCiMdZ2tMyhH0W9HQymZyG8vtk/yR+OF/BWRN6mt9MJvz3LAQlQpvFu27regfypdI7eL3AUHoiwMXBctmjf3cJ8HtUYpChuBJzc4+1VkIb18bMIR/MEo2xcc+sfTBikNALRUTeW3+u2NNwerNDMNML7BtsY2W9/o+UuBJcBMjEAdahhrw28LfnwD9bv9JKkWHUl+rea2N+94zUWRdr25pXBZgkNBQrq7i2ttkjV9gCxvmwj1mtYdz1RTgBNwx/v28Hra+hgA6V8hRCGqPT4/spSLhHr7naZFDDdM/CGts6QgFVjC4U43H0u9EWPW6J3Aidu9hKBg/7fvLnYC96LJBSOupkfzNX/c7H/ezACe/McWQzrgDZiKtafvlsfYOM8I9/bjJxnIMvj83m0wtVRe5na8tumM4+1uloMppwl9Yxez4EOrueXyRmdj0Xa+ufssIsJgnOhthgls/QSYfbxFCAnng7aqA/4dLREx/pWxy7GrVheFk73aC2xYHErDeQUAxtfymhsiGySdetMNCtr1Pi4buWPF9blo9yy6JUOgxtcI11oB8E+uuXAeRv4jmUwyCaXVZ13fIXSNjS7vFqkvgiUBEq8hlBP/mh3+fqhl08Lj473knuV8zKklz8oe3y6Lhe395k1fUXoMYqXuLxAWT+zThtDru/2vBYBzWaTYsbtu1dssbx6RE5ORI5qItMdF1vcWO3ZFI6EBP5m3lJ6Tty27rt +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={"Update user"} +> +</Heading> + +<MethodEndpoint + method={"put"} + path={"/admin/users/{userId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Update a user's role, bookmark quota, or storage quota. Admin access required. + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","description":"The ID of the user to update","example":"user_123"},"required":true,"name":"userId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["user","admin"]},"bookmarkQuota":{"type":"integer","nullable":true,"minimum":0},"storageQuota":{"type":"integer","nullable":true,"minimum":0},"browserCrawlingEnabled":{"type":"boolean","nullable":true}},"description":"User update data","example":{"role":"admin","bookmarkQuota":1000,"storageQuota":5000000000}}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"User updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}},"400":{"description":"Bad request - Invalid input data or cannot update own user","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"403":{"description":"Forbidden - Admin access required","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.28.0/api/upload-a-new-asset.api.mdx b/docs/versioned_docs/version-v0.28.0/api/upload-a-new-asset.api.mdx new file mode 100644 index 00000000..5d2f6b37 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/upload-a-new-asset.api.mdx @@ -0,0 +1,71 @@ +--- +id: upload-a-new-asset +title: "Upload a new asset" +description: "Upload a new asset" +sidebar_label: "Upload a new asset" +hide_title: true +hide_table_of_contents: true +api: eJyNVE1v2zAM/SsGz26c7uhbtqFANmAL0BQ7BDnQNlOrsS1VotNlhv77QMlNnDQDdpMlfrzH98wBKnKlVYaV7iCHJ9NorBJMOnpL0DliSIHx2UG+gYV8O9im4KjsreIj5JsBCkJLdtFzDflm67cpWHrtyfFnXR0hH65arGtKKmRMWCelJWRKuKbYLHlTXM8ghVJ3TB1Ldts3rAxaznbatneSKteurKkNJz4aghx08UKlwDVWG7KsyMnrTjUUohTLAR5UQ9K6oKQPZKkC7yNmZakSoiFn6328d0Z3Lhb7NJ9/JPSVGFXjEix0z4FLpFWdBjhhg8Y0qkRJzV6c5P8/lVBuWU0CHVvVPYM/tViH+xvvTv2ZPnR9W5CVB+H6A9tbWVdTeW9/2WwsPSm0TU/DDo4BHyfZEte6ghyMdoEcimMgw2grcZU9kHXBVL1tIIcBq8qScz5Do7LDPaRwQKuwaMaJxOeoyQ77hiGHmtm4PMvYHmd7tLgnMjM0BtIbThwrJHoXlPs+xicRi0Cf2P1RhIqdp6Y/DU46C48QBvkYBOl4eNC2RUH47dc6TFd1Oy3pwjpCup/NZ3M4D/CEZ7Fa3sS/WC2TnbaX4IWsT8OcWwwW64LCt3/vi6LD2az/WAaRKtNvzkyDqpNOQa1hVHR0SlgUtUidb2AYCnT0ZBvv5fq1JyvLY3vWM+yOFGrCimywwJ6OkMOXCOduNNsBm17639oKPn1PWpQlGZ6Ef/jtRNaTIVc/H9ei0rivWl1JjhQOddPzMYLES9mvZA7gxyfsjhMUwxAj1npPnfeQjnBZvsHLxvkLeuzpPg== +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={"Upload a new asset"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/assets"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Upload a new asset + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The data to create the asset with.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"title":"File to be uploaded"}},"required":["file"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Details about the created asset","content":{"application/json":{"schema":{"type":"object","properties":{"assetId":{"type":"string"},"contentType":{"type":"string"},"size":{"type":"number"},"fileName":{"type":"string"}},"required":["assetId","contentType","size","fileName"],"title":"Asset"}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file |