diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-06-08 10:06:06 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-06-08 10:06:06 +0000 |
| commit | dd38899cb6ef3284af94a25cfe1d3cfeb1238684 (patch) | |
| tree | 5f62eeb1370499b2a3ba0948f13cd863bec04932 /docs/versioned_docs/version-v0.25.0/API | |
| parent | fc3e7b99e8a5d65fd363d5396ac52d9f24f45ab6 (diff) | |
| download | karakeep-dd38899cb6ef3284af94a25cfe1d3cfeb1238684.tar.zst | |
docs: Release the 0.25.0 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.25.0/API')
38 files changed, 2870 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.25.0/API/add-a-bookmark-to-a-list.api.mdx b/docs/versioned_docs/version-v0.25.0/API/add-a-bookmark-to-a-list.api.mdx new file mode 100644 index 00000000..84552191 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/attach-asset.api.mdx b/docs/versioned_docs/version-v0.25.0/API/attach-asset.api.mdx new file mode 100644 index 00000000..00146e1f --- /dev/null +++ b/docs/versioned_docs/version-v0.25.0/API/attach-asset.api.mdx @@ -0,0 +1,71 @@ +--- +id: attach-asset +title: "Attach asset" +description: "Attach a new asset to a bookmark" +sidebar_label: "Attach asset" +hide_title: true +hide_table_of_contents: true +api: eJztVcFu2zgQ/RVhTi3AjZJFF1vo5hYtkN3DBo2LHgwdxuLYYiyRLEnF9gr892IoOZIbN+ihx14EafQ4nPf4ZtiDJF85ZYMyGgpYhIBVnWGmaZ+h9xSyYDLM1sbsWnQ7EBBw66FYwbsx5KEU4KnqnApHKFY9rAkduUUXaihWZSwFWHTYUiDnE8BXNbUIRQ/haAkK8MEpvQUBdMDWNhxSpGRzOG7b/cPbv83h/7/qQwimessVqJAgpwpuJUQBjr52ypGEIriOBGhsGbSeQAIUc7QYauCqeAX58M7II9dyrsSyppkASRYQUBkdSAeGo7WNqpDh+YPnNReImfUDVQEEWGcsuaDI818ln5OPAtJ+yxS9II3uWtbdV45I+9pw2rTifh5Zo9bkblvcEgjYdE1zh1tauKpWjxx5VJIM40ZdFpwhFUiVw31DcsJ2eqfNXkMZz/Rdcf3zassYB4S3RvuB4p/XNz8QNWlJclD3t6Yva/rm+s1zGU/Gz7QJ2cZ0Wv46GSsjL0gVBbTkPQvw/N93RFKGCZ+IpPWhNpL7z/i0LbdhAflJNJ/3U6/GPCnhgUeLezwNjs41UECPUjryPuZoVf54wyeATuG6GSiMvwfdNtg1AQqoQ7C+yPPgjlc7dLgjsldoLYhLHh0yZGaThZqyf0d8NtQCMcbZzLtnZYed55PvSSbemXkkGE+kBGK7pJePxrXIFf7zZZm05BP7NI2mD6eROFh8Mu/M2XMDRx5zG8N41m0gdXN1fXU9G51PjBZ3txcVWNzdZhvjzumzXFGkA2wxuWocsqdrY/T9Wbp+cuZPXS8DoUCHkNsGleYd07n3o2VWT33G9ijOBvzomlJAzS4rVtD3a/T02TUxcvhrR45vqXLyTHKWVJ7fJRQbbDy9wOHVp9Hrr7MflTsGUR+TNZuOv0DAjo7nN1Iso4CaUJJLVQyA98Nef6SznRI86+ooTisWVUU2vIgtZx1499/9Mo2r4eJrU8uDwz2I9EzFmsQ92TrFemhQb7s0AmDIyW7Fc7N/Z+7E6qIcfT8glmZHOsYndQJ/szAxfgPFevk9 +sidebar_class_name: "post api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Attach asset"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/bookmarks/{bookmarkId}/assets"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Attach a new asset to a bookmark + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The asset to attach","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"The attached asset","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.25.0/API/attach-tags-to-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.25.0/API/attach-tags-to-a-bookmark.api.mdx new file mode 100644 index 00000000..426301a6 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/create-a-new-bookmark.api.mdx b/docs/versioned_docs/version-v0.25.0/API/create-a-new-bookmark.api.mdx new file mode 100644 index 00000000..1d398219 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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: eJzVWFtv6zYM/isBn7UmHfbkt/RgA7rbKdYOewj8wNhMrBNb8pHktDmG//ugS20nVVpnLYYNBQpHIkXqE0l9VAs56Uzx2nApIIFPitDQDGeCHmdrKXcVqh0wMLjVkKzgJgxpSBloyhrFzQGSVQtrQkVq2ZgCklXapQwUfW1ImxuZHyBpTww9FNSvPzNyljnDwCCTwpAwVgPruuQZWo35F23VWtBZQRW62bL8vHGmzaEmSECuv1BmgEGtZE3KcNJWznBTkvvwYtooLrbAQDRliWs7Z1RDDCp8+pXE1m7gerFYdAxQZQXfUz7SXktZEgroGGxwL+3+z80LaSJ2Owa6qSpUh+icxyFfmrc97rqOtSAFTYPBzb5ck0RT2ZMtudhB2jFoVBmT20hVoYEEGsWto7WiTOFjSfnSo3SbRzbU+TDgyoK08rPeRGqdf5/Lhp6Mc9l9RJGWjcroz9iOzrj2vOZ7fUOtyTvnvh7eEOcVbq35Ot8MSlFEGWx4Sb9jdSa2Lt7x4N9gNu3sX+c1dC2F9rv+fnEdT+UQtuOSMTmRXweax0F4JU86BpXM+YZPTCM2tUS8uyIY3G652N4bNI2eUpKew0M3WUZa2zREXjbKhQqJ3GqlfUXh3xzEH798vJJF4Dlb2WKguyulF0Sl8AAMuKFK/+OwEOfyAo3BrKD8Jupcn7UcGBRNhQLS03ThOYT1j1ZzcqNY/3fq8UVBe5SuE+RdMYqWkHPCy3PlKhYjmSISupDmEq1NU5Z31pJPwEtUX9xUlyjveU7yIkdxz7OJQBemKj8NofOm/PM2pkljYwqppkHUrEuuC5omnaOhu6AxDRSr8VuoyVOIzX+WNUx09X/NImI5ewEiDDT/Nl5WNNWaVDSeJ8f+JdTl3ag3YifkY+QKcAqWGQVzH39/TTrmoYI+7/t+PLJGIUjdhlg4KZwQSpqVC1zNVTeI1Embc+egcLfh4G3aRQUGlnbEyUY86og0nTKkOLEJ1GEIn/400v5W7BtV8Cz2h8XiJXG9wXwWmtSP46uZzOMMpCKt7ZG8ycvdCoO84+FO3xQyhwRq6fyt0XaqMF/3LbntyNWelHb0w/EGaDHPFWndzbHm8/21PX9U3KaWczdMe3A22JS2xSuMqXUynxt1uNqhwh1RfYV1DSxC/cMKM7mZmYJmvwT5mffF4j96Kri3KHrL4weDHhJr2e7DiVny7IRssLqPn56b0J//enC42dP5Y3hn+PEJqzqwohAIffYM1N2T3zFZ9yOe5g4aPZsdhkZtxzAYfHeMLfC1YTLaJ4/CgouNtP7ac/OgXl8trhYwhHKP6PLuNnoCy7vb2UaqY/jtcdmbXWpj6WzSBm589onnhCX26XD+Tchv295187pE7lqcwFZ9cK5gPX4vKmzgJito2zVqe5t0nR3+2pAFeZUOoemekBgUhLnlJKsWdmTPIZCl70LN32PZuNp7mq/2DvAayyyj2rwqm45y6+7z/YMrjf7NqnLJDAofgbn/CQAD6UByQezGWihRbBuX3ODX7AL/GveBx6E8bhFQHEYetq2XeJA7El0HLGzF2N/g+vK/AWXoz2M= +sidebar_class_name: "post api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Create a new bookmark"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/bookmarks"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Create a new bookmark + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The bookmark to create","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"title":{"type":"string","nullable":true,"maxLength":1000},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"note":{"type":"string"},"summary":{"type":"string"},"createdAt":{"type":"string","nullable":true}}},{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string","format":"uri"},"precrawledArchiveId":{"type":"string"}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["type","assetType","assetId"]}]}]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"The created bookmark","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","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.25.0/API/create-a-new-highlight.api.mdx b/docs/versioned_docs/version-v0.25.0/API/create-a-new-highlight.api.mdx new file mode 100644 index 00000000..b5340d69 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/create-a-new-list.api.mdx b/docs/versioned_docs/version-v0.25.0/API/create-a-new-list.api.mdx new file mode 100644 index 00000000..f16f6d30 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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/SsGz1qTDD351hYb0K3AijXDDkEOjM0kamVJleS2gaH/PlB2Yif1WgzoLkEs8fO9R6qBknzhpA3SaMjhyhEGyjDT9Jwp6QMICLjxkC/gRvrgYSnAU1E7GXaQLxpYETpyF3XYQr5YxqUAR481+XBpyh3kzUmC+ZZS3CyYrEjJQEBhdCAd2BqtVbJAtp7ce3ZpwBdbqpD/hZ0lyMGs7qng0qwzllyQ5PlWY0UDKx+c1BsQUEl9Q3rDFc4EVPiy/zqfRnFc35vO0yPn2ZS9ZTHmFkV38Doe6bpiNCvUNSoQ4Ct0gWEtaY21CpDv76KAx5rc7r2eogCLjnS4LsdMda0UrhRBHlxNMbYMSUcl15FA6/pYxthee2u0b0H9PJ2Ns9iyV+5V8kEcypEWovgLte+zd9L7G3z9A4L/ndxX+Wy9UrIYmK6MUYQaTtmUJYgjSgeNHcIsBQQZOHyaaWhZP59OXxN9iWXWzfPHcVyYcpzMirzHzdjdSZspQm+fdJv8w9aUkIM1qV6LPB8wUWlz8eJyT+R82lu1U5BDg2XpyPs4QSsnTzMQ8IROMvip1O66BWbP4DYE6/PJJLjd2QM6fCCyZ2gtiJEx6SJkZp2FLWXfO/usrYWxH2zUO0awzTzcqwc4ODP3kcxYBskIRPfnq3EVcoXffs8TZszMz34df3nByirqd2UvuePCD8ftuPTfXR0HfXcS7g36MRrwKvXacFIGv00wO5ueTaHX4QGWi9vrURgvbq+ztXHHGDLmPB3Ghwr1oK2xZ+xkUxy0PP7mtX0GegkTq1BqzpMk03SqWoDav4dbVlu+gKZZoadfTsXIxx02i2WvqfRECtgSluSSDB+I4btqi/k057RsrmpO/2rIoth7XBQF2fCm7XIwELc/7uYsk+5NrtIEgsNnEOk3BxBgEjhJfemsAYV6U6eJhDYmiwqPNXmiwdRVd4V6N6iwaVqLuXkgHSOIrpXA3xB5iP8A4Gbq2Q== +sidebar_class_name: "post api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Create a new list"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/lists"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Create a new list + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The list to create","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","minLength":0,"maxLength":100},"icon":{"type":"string"},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","minLength":1},"parentId":{"type":"string","nullable":true}},"required":["name","icon"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"The created list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"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.25.0/API/create-a-new-tag.api.mdx b/docs/versioned_docs/version-v0.25.0/API/create-a-new-tag.api.mdx new file mode 100644 index 00000000..0e53e19d --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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: eJytVE1v2zAM/SsGz1rc7OhbNmxAtwEr1gw7BDkwNhOrsSVVotsGhv77QMlr3DbbaRfbkfjxHt9jRmgo1F471tZABR89IVOBhaHHgvEAChgPAaoNrOW9VRCoHrzmE1SbEXaEnvxq4BaqzTZuFXi6HyjwB9ucoBpflV+3VDTIWLAt6tyKW5JGxaPmdgEKamuYDEsuOtfpGiW3vAtSYIRQt9SjfPHJEVRgd3dUMyhw3jryrCnIrcGeZlGBvTbCptfmG5mD4F3GmOFqT40wTDnbGPN5cNaEXOz91fIyl8yhmSb1n6Dr5i3wqP7C6DUH3YCaEYkKeuLWNlCBsyE1QyEPZdJV5PQP5ENSc/AdVDBi03gKIZbodPmwBAUP6DXuuoxvus4T2ePQMVTQMrtQlSX70+KIHo9EboHOgbowtqlCYfdJ/q9TfJGxQIxx5rNbGVvuPHfb8yCks/BIYVBNQaCmj8/W9ygIv/xap2mJHD/OJv30hL3r6OyZ2ci12Vu5kAFl9MvF1eJKlkKz5MAz9NXN9UWqq5vrYm/9S54yl6iSID2aWesL6/ei5Hj22MVVzRNheuLSdaiNdEmijpPsm7zOWwWtuKHawDjuMNBP38Uox/cDeVnt7Vn0tNkKWsKGfPLJkU4CIEN5t5auEt4N0v2N9aP6k7Gqa3L8z9jtzLA332/XouP0V9LbRnI8PoJKzwpAgU2jSfZIZyN0aA4DHiQ21xTV8aVpXpkksZqu0JxmCMcxR6ztkUyMoCYqLL8hypL9Bg6ty64= +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","minLength":1}},"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.25.0/API/delete-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.25.0/API/delete-a-bookmark.api.mdx new file mode 100644 index 00000000..2efd161f --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/delete-a-highlight.api.mdx b/docs/versioned_docs/version-v0.25.0/API/delete-a-highlight.api.mdx new file mode 100644 index 00000000..6b41831c --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/delete-a-list.api.mdx b/docs/versioned_docs/version-v0.25.0/API/delete-a-list.api.mdx new file mode 100644 index 00000000..86c83140 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/delete-a-tag.api.mdx b/docs/versioned_docs/version-v0.25.0/API/delete-a-tag.api.mdx new file mode 100644 index 00000000..0ca6fba3 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/detach-asset.api.mdx b/docs/versioned_docs/version-v0.25.0/API/detach-asset.api.mdx new file mode 100644 index 00000000..694ebff8 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/detach-tags-from-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.25.0/API/detach-tags-from-a-bookmark.api.mdx new file mode 100644 index 00000000..4ba9ae53 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/get-a-single-asset.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-a-single-asset.api.mdx new file mode 100644 index 00000000..eafc90ef --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/get-a-single-bookmark.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-a-single-bookmark.api.mdx new file mode 100644 index 00000000..60be25d2 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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: eJzNV01vGzcQ/SvEXNoCC8spUjTQzQnawC2aGI2LHgwdRsuRltYuuSG5smVh/3sw3E/JVLxODLQny8sZzuPjm+HMHiS51KrSK6NhDu/Ji6UxmwLtRix3QnknlIQEPK4dzG/gbbvoYJGAo7Syyu9gfrOHJaEle1H5DOY3i3qRQIkWC/JkXTBwaUYFwnwPflcSzMF5q/QaEqB7LMqcPylSMr/frYu72ze/mvuHX7J77036hhEoH0w6BJcS6gQsfa6UJQlzbytKQGPBRsvBKAHFJyvRZ1AnERhLY3JCDQlIWmGV+26vQ2ouV8KRF96IsNrT9IMTqdGetBd3Ks/FkoTSaV5JkkJp4TMSllxptKMz8cF4SoTP1OCUomafHO2axMpY4UxB/e7u7PCUK8zd/wdaz3e77bvGseP8c0V2ByyFLoxj3n8+P+c/h2f4uLyllHH6bFCgRI8cpQXEXliWuUqRvWa3jl0jV2rCZpBAaU1J1qsmsJKP1VcnkFpCT/LCR1cLI9VKxZcT0FWe45KFydTXvUwnWKJNM7UlGZFincAKt4aT69S6x/Va6fUnj75yT8dLgHRVcAa7Kk3JOeAQKq8sMU2kJXst6gRcVRRo1UOg+OW318ZPo6fBsZtGeqhOvSFaizsWoafCfbMsGmlHFtB7TDOSb6PgOiJQQQJZVaCGRX2QwzcQSmrY/2C3YDfSutH0cRVq59cP0KyehpIrvQnkVzaPnmi6aA+SdoK9KnBN/8TCnjK+cI78ZeRKYhpJLZF2mfHP8VpVeX7FkZoEfI5raSm1eJeT/AbnrZJkngUUtyqdSHTmi/zdIJ0n7btjTLPGymfGTqOoWubKZTTNWqKnq9ZjGins8Vdbkyc4HGVesG4SYcHdwPcllqd7HxIr/IhlljOVTScmQBxqF+N7sSILL4ANv66fMA+5yEHkanCK6ZZ1qnL6EK2WsZx9BiMJOPUw3lZXxZJsVM+TtR+neSBlOOsLsF7pjTZ3kScgOCzqntqXf78mXfNQQbtzfxp/WaLWZC9bLRwVTmhLGtu1HVuobhCpk5xzp6gIr+GAdlFHDYYu7aAnG/VRB03TcYcUb2za1mGQT38bi8cTB9QB2evz14/b185GaOPFylRavlzbmhoZb0QKco5v5vHaEYFhh8GeGa6Dv8+MhDmsm0vjEWkOs77Bn+2HOapmBsluu2kutBKwRyktOVfPsFSz7SuWBFrF2Ragt8sNX+1wBZn3pZvPZt7uzjZocUNUnmFZwvFcc52RaHcQZhXmlT9be9Fg4SsZDaKfmNEm8ngc7enhyHyOYMb9dDBi/YYfvxtbICP849/rwKHSK8PufOoG0quz87Pz0TTa47m4uoziv7i6DKPTAXg+LD+VxnnuD+f7bo7i+RuFU3qdD4PW8b77QVhfGdibE/PrMStzVGFoaPu/5qJv+qzlBJiPRuZFAplxnk32+yU6rtZ1zZ+biY7vXyrHt3xiJB1D/A+n0ygJG9rFJtYt5hUbh3m1E/Ezj/rj323S/SRORe9KvN6NY3aoRpcQnoaMUHIndbNvDS7SlMox3EeFheH3if3+t2tourfxFHmo+vGAcQhrv28srs2GdF33KD3/zwDr+gtMflJP +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},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","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.25.0/API/get-a-single-highlight.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-a-single-highlight.api.mdx new file mode 100644 index 00000000..705ceb5a --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/get-a-single-list.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-a-single-list.api.mdx new file mode 100644 index 00000000..a9ff6160 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/get-a-single-tag.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-a-single-tag.api.mdx new file mode 100644 index 00000000..64c17ee7 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/get-all-bookmarks.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-all-bookmarks.api.mdx new file mode 100644 index 00000000..c8e1037b --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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: eJzNWEtv20YQ/ivEXHohJKdH3RSjDdyisQG76MHQYUSOxI3IXWZ3KEcR+N+LWVJ8yGubSgy0J8vceb92vj1CSi6xqmRlNCzgE3GEeR6tjdkVaHcOYmDcOlg8wsfu2yoGR0llFR9g8XiENaElu6w4g8Xjql7FUKLFgpis8wQuyahAWByBDyXBAtbG5IQa6hgsfa2UpRQWG8wdxaCxEBK0Sab2lEIMSkz7WpE9QB3/mLQN7o0YPEmeY6v0FmIgXRXiOroEYh8q8T2lDVY5w6L58opWZyzf2pTsBKW6KtZkX5OWq0LxJeaz4lw+XFfWmVdFJw3F9FAPosC2ovisjm42kSOO2ET+tKunX1yUGM2kOXpSUmcUKZ3kVUpppHTEGUWWXGm0o1n02TDFEWeqZ0pQC0+OdkvRxtjImYL6ap0FffyfmNYFuxV73TCeBX0lDjRqnMT916sr+TP24Xb9hRKxk7Nxu0YpMoqq1iphxbLMVYLCOv/ihD+QV+MlQgylNSVZVo32fg70pGgtHsRqpsK9LUKlz0uzjiGxhEzpkoOnhUnVRoWPY9BVnuNaSltSWHeFPoGymyrB6TGYEsFzxu1W6e09I1fubX39AHFVkpCTabpBlVeWJEykU+Fa1TG4qijQqu8+S+8vXhueFp7GjsO0oPt74Z3LommRwAEyY5JR+jFoXDeoFcSQVQVqWNWjWfAoGlv5I2mebtAuRtPtxt9arzvQnL5sSq70zge/snnQo+lFO2r+CfSqwC39HVL7EvHSOeKbQEpCNZJYIu0yw5dwbao8vxNNTQNewlpaSiw+5ZT+APNepWQuMhT3KpkY6IyL/LovnTfpT25Mo8aKM2Onhaha58plNI06Raa7lmNaUITjr3YmT2A46zxP3TTCSraKn2sspm/sG8v/CHWWM5VNJjZA2NSTjp+1FaXwvLH+18Mb5L4XRUm66ZlCdSt1qnL6HJyWoZ69ICIxOPV9KLbdTEP1PLn2w2Hug9L7+g5Rr/ROm6fAFeAZVnUX2ve/vyaluZ+gJ7/vh1/WqDXZm7YWzgYntCNN6NrlzE83CMxJ6bmXQuFvw97aVR0k6Le00U4WD9HZCFqNN6TwYtOuDn35dNlY9ZjlhDZB7NL0jVsQc3GpDaHsQM5A1R1ulRY3e4Rb1z4eBXFmUljAtgkwCsKF+VCkI7s/wVx/08MR09SSc/UcSzXff5CMoVVioa+c9rjZ6k9IMmMu3WI+Z3uY7dDijqicYVnCOXx5yChqJURm42HJny191Ngixg8Q+r2s+u02P8DpXRhFs/jhyWTd9URSXv7H78YWKBb+8c+Dz4XSGyPs4nVj0ofZ1exqADc7e5Z3N0H7l3c3HiGNjBdn5SYzjmV9WxxPcCn0JnG2EXVzKPyA0TgqM31e5qj8Kt9uZU1Kh1WyiiEzjuXj8bhGJ1OzruVzg9Ak0alyks4eYu7oMH6y2GNeiVKPol8gHzXOFIbhc8IU+tODwRTa7gXgdeIXA/8fwupgfhuvnkHt3rtV35b+1SqGjFBiKwluuJdJQuWQ6xmUFindkPj02wM0W9sQPY7baQgsUB8Gso/HhuLB7EjXNZxcYPkfahnQ/wKNWctP +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},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","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.25.0/API/get-all-highlights.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-all-highlights.api.mdx new file mode 100644 index 00000000..dc484071 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/get-all-lists.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-all-lists.api.mdx new file mode 100644 index 00000000..adadf81e --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/get-all-tags.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-all-tags.api.mdx new file mode 100644 index 00000000..d0e7bdf0 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.0/API/get-all-tags.api.mdx @@ -0,0 +1,63 @@ +--- +id: get-all-tags +title: "Get all tags" +description: "Get all tags" +sidebar_label: "Get all tags" +hide_title: true +hide_table_of_contents: true +api: eJyFVE1v2zAM/SsGz0Kc7uhbCmxFt8MKzMMOQQ6MzcSqP6RKdDbD0H8fKLtp4gbtSbZFPj7yPXqEknzhtGVtOsjggTjBpkkYjx4UxCPbQi7nToGnoneaB8i2I+wJHblNzxVk213YKXDkrek8echG+LJey3GN/3P/TAUnfzVX5zpJiYwrUFCYjqljyUJrG12gZKXPXlJH8EVFLcoTD5YgAxPBQIF1xpJjPRWeSJ+j0DkcQIFmav3n2bq8iPHsdHeEoKDDlm5f9O29MXWLrr5E7/p2T24ZcD9smLGoqMxj2GdkUN+ErPoWuxs3IQQR4aXXjkrRTZcwU18Q/ZDWTgFrbgQ5xyO8Q40D3oWpXEtcmRIyOFLkj2IHSGcDeXIncj76pXcNZDBiWTryPqRodXq6AwUndBr3zdzydD1Z54B9w5BBxWx9lqbshlWNDmsiu0JrQS38lVeUzAiJOSRcUfJjjk8mLtLOhZN/iammypd+Po9WKksfMQyyOQjU/PDNuBaF4fc/Ocg4dHcwki5dT5TuVuvVGt5GeuazeXq8yX/z9JgcjLsmL80GBdZ4nrWfHLnc2Cu48W2l3m321B7TP05tg7oT9KjQOGv4qrOCyniW93Hco6ffrglBPr/05ORPsHtTMP4IFFSEJbkoek0DZLApCrIcpW76uJTL/RZNzlZ6+JqDArxWYjH5iP664t1wgT2OU0RuaupCADWTYHmHIMb9D+rOsgM= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get all tags"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/tags"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get all tags + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with all tags data.","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"numBookmarks":{"type":"number"},"numBookmarksByAttachedType":{"type":"object","properties":{"ai":{"type":"number"},"human":{"type":"number"}}}},"required":["id","name","numBookmarks","numBookmarksByAttachedType"],"title":"Tag"}}},"required":["tags"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.25.0/API/get-bookmarks-in-the-list.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-bookmarks-in-the-list.api.mdx new file mode 100644 index 00000000..03fd02e9 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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: eJzNWN9v4zYM/lcMvWwDjKY33LCD33qH7dD9uCt2HfZQ5IGxmFgXWfJJdNpc4P99oOzYTqqk7lZge2pqkeLHTyRFaick+typipQ1IhPvkZKFtesS3NonyiRUYKKVJ5EKgpUX2Z34TXnyYp4Kj3ntFG1FdrcTCwSH7qqmQmR382aeigoclEjofBDweYEliGwnaFuhyIQnp8xKpAIfoKw0f1KopH7Yrsr7z29+tA9ffygeiGz+hq0rCiJs/VqKJhUOv9TKoRQZuRpTYaBkAd0KpEKxQxVQIZr0rHlTl+wX+FykgQ92TuISak0ia78c2FuC9oNBbx19dBLd3uaXGt02btTU5QLdud20KhVN2KmHvyfmXe28Pbt13ko8vffCWo1gxIiFluLDYLleJh4pIZuE1T5wvvFJbg2hoeReaZ0sMFEm17VEuQ8ph76yxuNF8sESpgkValDKwbCOBrfCZGld4m2JQ1heRH38n0Drye62fdcqHpE+ZwdaM555//7ykv8c+vBx8RlzxklFSMFEAgFb6MCwBlSVVjmwxuyzZ7XIcdqwkUhF5WyFjlRrtEc9EgXnYMtgCUv/9BZKPo7IJhW5QyCUVxRdLa1USxVfToWptYYFRzSfXNPH9wRJcHmhNigjkdykYgkby+Xq1DrBaqXM6hMB1f5pe0Pd8HWeo/eCTShdO2Sa0EjWmjep8HVZglNfwym9/PbG0jR6WhzbaaSHWv/CYdFmRmQBiCAvUL6NguvrsxKpKOoSjJg3ByXgji12+x/sFuRG6WINflyG2+i8A+3qaShamXUgv3Y66tH0oD3I+QnyqoQV/hkze0r4ynvkG3FSjOQO0fjC0nO0lrXWN2ypTcDnqFYOcwf3GuU/UN4oifZZQGGj8olEF1Tqd0PoPCm/d2OaNNRUWDeNonqhlS9wmrQEwptOYxoprPF7V5MnKBxlXpBuE2HOzcS/SyzCBwqJFX7EMsvb2uUTEyAOdW/j32IFDrwANvy6fUI85CIbkctBKRa3HKdK44dotYzl7DMYSYVXX8fbdg1pLJ4nx36c5oGUwdcXYL02a2PvI1dAUJg3PbUvf39NOuahgu79/jT+sgBj0F13sXBUOEVX0liua85CdROROsk5d4qKcBsOaOdNVGDo0g56slEfddA0HXdI8camax2G8OlPYz6MKm875wTjMvhA3ezy7FAbWtiDfUambmClDLv5thdtAh2vL18/brl5uEyMpWRpayNfrtXOrYx3PiV6z6HweO3I07DDIM9H2gR9KqwUmVi1UcLTbiZmPC742a4dhZvZmCaPbrMfyUP3InYgpUPvmxlUarZ5xVEITjHrAXy33LK1H4oLospnsxm57cUaHKwRqwuoKnE8id0WmHQ7JHYZJqxfO/mkxcIHMnpN+MScdhPK6E2hJ4gtsx9BjFv4IMQpE378bF0JjPCXv24Di8osLauz1y2kVxeXF5ejybnHc3VzHcV/dXMdhr0D8Ows387WE7ek2W4/+Z17Qznq9vrwOv/w0jrO99as0qDCuNJ1nu2J34VXDz7erH/+GA59norCemKx3W4Bnu+KpuHP7TjKoSCV5wMf5uk1bo/eNjaga8YR3gxOyO9fL6bI9s8R54VPUvYfzvjRE2m9ejT3D97Nh8SKc37S1W//6ErBd8kp6/ubzmzHNodzaV/N+HYsEPhAGUG7eJXnWI2hPip1DL0vNe9/uhVtAzsepA+zcDxjHULa7VqJW7tG0zQ9QuL/GWDT/A0J8BsP +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},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","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.25.0/API/get-bookmarks-with-the-tag.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-bookmarks-with-the-tag.api.mdx new file mode 100644 index 00000000..9fd379db --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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: eJzNWEtv4zYQ/isCL20BIc4WW3ShWxK0i7ToJui66CHwYSyNLcYUqSVHTryG/nsx1NMOnSjdAO0pjjjPbx6c4V5k6FIrS5JGi0R8RIqWxmwKsBsXPUjKI8oxIliLWBCsnUjuxJz/LmLhMK2spJ1I7vZiiWDRXlSUi+RuUS9iUYKFAgmt8wQuzbEAkewF7UoUiXBkpWa5+AhFqfiTRJmpx926eLj/8LN5/PpT/khk0g+sXJInmcP6OhN1LCx+qaTFTCRkK4yFhoLPyZ/HQrI7JVAu6vhZ5boq2ClwqYg9GuxahiuoFImk+XKgbgXKDfqcsXRjM7Sdzi8V2l1Yqa6KJdrnpClZSJogqTe/g+Wqss48KzptKF6WvTRGIWgxQqFB+DBVrleRQ4rIRP60T5vvXJQaTagpepBKRUuMpE5VlWEWSe3TyaIrjXZ4Fn0yhHFEuRyYUtDMo8CuMVoZGzlT4JCUZ0Ef/yem9WC3Yq8axiPQF+xAo8Yx7j+en/OfQx9ulveYUlOCSjqKMiBgDa0xzAFlqWQKzDG7d8wWCKfxgkQsSmtKtCQbpb3VI1KwFnZsLGHhXhYhs6cZWccitQiE2QUFTwuTyZUMH8dCV0rBkjOaI1f3+T2BEmyayy1mgUyuY7GCreFmdeqcYL2Wev2ZgCr3sr6hb7gqTdE5wSqkqiwyTKgz5lrUsXBVUYCVX32U3l68NjQNnsaO3TTQfaN/47RoKiNwAESQ5phdBo3r+7MUscirArRY1Act4I41tvIPpHm6UbkYjTcrfxc970BzetoUJfXGg19ZFfRoetIe1PwEelnAGv8KqT1FfOEc0nUgJKEcSS2idrmh13CtKqVuWVNTgK9hLS2mFh4UZv+CeSszNK8yFLYynQh0ToW6GlLnRfrOjWnUUFFu7DSIqqWSLsdp1BkQ3rYc00Bhjj/anjyB4ajyPHVTCAseJr6tsAgfyReW/xGqLGcqm04sgLCpnY5vtRU48byx/tf8BXJfi6wkWw1MobzlPJUKPwW7ZahmX4FILJz8OhbbDqShfJ6c+2GYB1AGX98A9UpvtHkIXAGeYVH30L79/TUpzEMH7fz+PP6yBK3RXre5cNQ4RdvSmK4dznx3E4E+yTV3Cgp/Gw7WLuogwTClHcxkoznqYGg6npDCg007Ogzp00djMawql61zgu3S+Ejt7vLqVBtG2AM5I1W3sJaa3bzsSWsPx/vz909H7jmsI20oWplKZ283aacmCw8+BTrHmfD07MhRL2Gg54jWnp9yk4lErJsk4WU3ETMOwWzv9+B6NsbIod1227gfXcQessyic/UMSjnbvuMUBCsZcm96e9xA1W3EOVHpktmM7O5sAxY2iOUZlKU4XsPmOUathMis/Hr1e0sfNbZwNEYPCZ8Z0XY9GT0n9PCwZvbDk/H87om4XvyPX40tgC387e+5x1DqlWF29rox6d3Z+dn5aG3u7bm4vQ7af3F77Te9A+PZWb6ajSOeR5N9t/Y9+3xyNOv12fXCo0vjOl9bs1KB9NtKO3g2Eb/rii7p3j6GoC9ikRtHTLTfL8HxRVHX/LnZRTkVMuk44MMyvcHd0cPGFlTFVvgHgxP03dPFFNr+LeJ54pOI/YcLfjAejVdPlv7Bu8VQWGHMT7r6/Z9tI/ghOqW9u+b0bqyzs6pJCn8z5ggcTzagObtIUyzHlj7pc2x532c+/jIXzfA6XqIPi3C8Xx1atN83FHOzQV3Xg4H8PxtY1/8AIuAXvg== +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},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","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.25.0/API/get-current-user-info.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-current-user-info.api.mdx new file mode 100644 index 00000000..17789a8b --- /dev/null +++ b/docs/versioned_docs/version-v0.25.0/API/get-current-user-info.api.mdx @@ -0,0 +1,63 @@ +--- +id: get-current-user-info +title: "Get current user info" +description: "Returns info about the current user" +sidebar_label: "Get current user info" +hide_title: true +hide_table_of_contents: true +api: eJyNUz1v2zAQ/SvCmwnL7cjNQxukHRq0DjoYHmjpHDGWSIY8pTUE/vfiKCGxkw7RIom8j3fvvZvQUmqiDWy9g8ZP4jG6VFl39JU5+JEr7qhqxhjJcTUmilBg85Cgd7hPFBP2ComaMVo+Q+8mHMhEipuRO+jdPu8VIqXgXaIEPeHzei2v674/Do/UcPXHcleaVK1hs4JC4x2TY8kwIfS2MZJRPyZJm5CajgYjX3wOBA1fCkEhRB8osp2b2vYiJnG07gFZwZmB3l8ouLHvzaEnaI4jZQUajO0/EJll2KfRRmqFINtin+VRGIg730LjgQo8I/SglmFTPRCExPgsfAqHY+yhMZm2jZRSrk2w9fMnKDybaKVfmWq5nuk8mrFnaHTMIem65nhenUw0J6KwMiFAveF821G1VKj8sej8fYmvZizIOV+o+0vInjtfavxCinSWOUoY9BIEtXx89XEwgvDb7y2EEjGZpMvUM6RPq/VqLQazLJTiBc/m7va/+Dd3t9XRx2vwMmxWCD7xYIpNZp1xQ3xl5WLzt3WnV899dB3m8Zn+ch16Y510LwpOi847FJ0hNpB96XxiOZ2mg0l0H/uc5fhppCg7tH/VuayQQkempViscaIzNDZNQ4GLIfpRur/bDlHuxXQ3X7ZQMNd6vdGnVF+ujDtf1J6mOWLrT+RyhlpAsPwji8X/AXJleBo= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get current user info"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/users/me"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Returns info about the current user + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with user data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}},"required":["id"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.25.0/API/get-current-user-stats.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-current-user-stats.api.mdx new file mode 100644 index 00000000..51ca8256 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.0/API/get-current-user-stats.api.mdx @@ -0,0 +1,63 @@ +--- +id: get-current-user-stats +title: "Get current user stats" +description: "Returns stats about the current user" +sidebar_label: "Get current user stats" +hide_title: true +hide_table_of_contents: true +api: eJyNU8Fu2zAM/RWDZyFOd/QtA9au24AVW4odghwUh4nV2JJKUdkCQ/8+UPbaOG2A5RIlpPie3nvsYYuhJuPZOAsV/ECOZEMRWHMo9MZFLrjBoo5EaLmIAQkUsN4HqFbwGJACrBUErCMZPkG16mGDmpAWkRuoVuu0VkAYvLMBA1Q9fJjP5WsK/H3zhDUXvw03GWRgMAMFtbOMluWK9r41tZYr5VOQez2EusFOy4lPHqEClyeBAk/OI7EZUG3sPjp36DQdwlm3jd0GCZKS060+OjKMVxsWVDfmiNtr9WXW5f3aNxP4avGz2Tet2TfvdiQR8DkaEuDV9CUXvKcsXzmdMbjEWyf5KOiQG7eFCvaY1dNiH5RiRig7LLMhIFbTUVwXpyO1UEGvt1vCEFKpvSmPN6DgqMnoTTsoOZYH03c6tgwVNMw+VGXJdJodNOkDop9p70FdJGPZYDFOKNwup/Hr2F8MXCCldJbBn5KIAfk8iS+yCrK8I7dBNTaBGg+3jjotDL/8Wmbtjd05uS6vHijdzOazuayB4VYmvPBZPNy/y3/xcF/sHE3Jy2OTAu8Cdzpn2epM6A55snDFP+kng/vXzfjvtR0EYPzDpW+1sYKfPexHv1eQ/QaJg2iUgdcKGhdYqn2/0QEfqU1J/n6OSLLz61fH88oraFBvkXJIDniCChZ1jZ5zNNooLN4ss3j4EsK7T0tQoKfOXTiVp48lbU9ns/t+6Fi6A9qUQI0kWH5Dksj/BT5muKk= +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Get current user stats"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/users/me/stats"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Returns stats about the current user + +<ParamsDetails + parameters={undefined} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with user stats.","content":{"application/json":{"schema":{"type":"object","properties":{"numBookmarks":{"type":"number"},"numFavorites":{"type":"number"},"numArchived":{"type":"number"},"numTags":{"type":"number"},"numLists":{"type":"number"},"numHighlights":{"type":"number"}},"required":["numBookmarks","numFavorites","numArchived","numTags","numLists","numHighlights"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file diff --git a/docs/versioned_docs/version-v0.25.0/API/get-highlights-of-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.25.0/API/get-highlights-of-a-bookmark.api.mdx new file mode 100644 index 00000000..dae985cd --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/karakeep-api.info.mdx b/docs/versioned_docs/version-v0.25.0/API/karakeep-api.info.mdx new file mode 100644 index 00000000..3e4eb827 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/remove-a-bookmark-from-a-list.api.mdx b/docs/versioned_docs/version-v0.25.0/API/remove-a-bookmark-from-a-list.api.mdx new file mode 100644 index 00000000..8a7cb34e --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/replace-asset.api.mdx b/docs/versioned_docs/version-v0.25.0/API/replace-asset.api.mdx new file mode 100644 index 00000000..3421b7f4 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/search-bookmarks.api.mdx b/docs/versioned_docs/version-v0.25.0/API/search-bookmarks.api.mdx new file mode 100644 index 00000000..0822161c --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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/ivCXNoCgp3t0TdvsC3SopugSdFDoMNYGllcU6RCUs56Df33YihZkh06kbsB2lMccR7fPDnDPWRkUyMqJ7SCBdwTmrSIVlpvSjQbCzE4XFtYPMLH/lsSg6W0NsLtYPG4hxWhIbOsXQGLx6RJYqjQYEmOjPUENi2oRFjswe0qggVYZ4RaQxODoadaGMpg4UxNMSgsmeAJYhAM6Kkms4MmPi8kBlJ1yQjRphB7g4AFS9qiSonhZpRjLR0sRp+PlOco7aDdauNuTUZmAgpVlysyr0mTohTuEnuccJI/XNfG6ldFpy3F27JXWktCBSNXtP4+Dv9NHllykdORP+3z4AcbpVo5Ui56FlJGK4qESmWdURYJFbmCIkO20srSLPqsHcWRK8TAlKJiHolmTVGuTWR1SUOWzYI2/k+g9c7uxF63jCdOT9iAVo1lv/98dcV/jm24XX2hlHG6wgOzbbUZsrV0XlWHilmxqqRIkVnnXyzzB+KqvUSIoTK6IuNEq32o34EUjcEdo3ZU2rdFiCxYr6khdJQtXfC01JnIRfg4BlVLiStObQ5h0yf6BEr2k9hSFkjpJoYct5rb0blzh+u1UOt7h662b+sbOoqt05Qsd8EchawNsZtIZcyVNDHYuizRiG8+Su8vXmk3zT0tjt00p/t+/s5p0ZZI4ACdw7Sg7GMQXN+5BcRQ1CUqSJqjXvDIGjv5R9I83ahctKLb3N82rxvQnp6HIoXaeOfXRgYtmp60R8U/gV6UuKa/QmrPES+tJXcTCEkoR1JDpGyh3SVceS3lHWtqC/AS1spQavBZUvYvmLciI30RUNyKdKKjC1fK6yF13qQ/mDGNGmtXaDPNRfVKClvQNOoMHd11HNOcwhx/dD15AsNJ5XnqthASniq+r7AcfXW+sPyPUGVZXZt0YgGEoR50fC9W5MTzYP2vhzfIfS2ykiwfmEJ5y3kqJH0OdstQzV7gkRis+DYW202moXyenPthNw9OGWx9B6/XaqP0c+AK8AxJ07v2/e+vSWEeOujB7vvxlxUqReamy4WTxgldS2O6bjjz3Q0CfZJr7pwr/G04oE2aIMEwpR3NZKM56mhoOp2QwoNNNzoM6dNHIxl2lsOWCIxL0VfXLTEXp9p4BR3JGam6w7VQbOawmTaN90dJrtAZLGDdOhh5M4V5L3LeDt5sJ5ntYUv1Fz7sMcsMWdvMsRLz7QcOHBrBQH0CdcftcH/YKgvnKruYz53ZzTZocENUzbCq4HSLeSgo6iREOvdLwO8dfdRiYRtGC/Y9T/zdUD9as3tvsma2w5Px1OuJOMv8j1+0KZER/vb3gw+JULlmdra6hfRhdjW7Gm2dPZ7l3U0Q//Luxi9KR+DZWL7QtHU8xS32h60p8KJwMhf13Sj4+tCayY19XkkUfp7vRrM2rsep0kU2iaHQ1vHpfr9Cyz20afhzu69xvDNhOapnFs4xrh//7BLzp+gcpA3tumeLLcqaz/0i/kJHSzd+YJhCf3hCmELbvwm8TnzW2P9w0X7Fsy+W78G6ZKhQ//4UQ0HIvuUgt9zLNKVqzPViuWYpfdv49dMDtHPceJ88rqzxqoFqN5K937cUD3pDqmngYILj/6Hhlv0PsLS5YA== +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},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","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.25.0/API/sidebar.ts b/docs/versioned_docs/version-v0.25.0/API/sidebar.ts new file mode 100644 index 00000000..86bcf612 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.0/API/sidebar.ts @@ -0,0 +1,264 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "API/karakeep-api", + }, + { + type: "category", + label: "Bookmarks", + items: [ + { + type: "doc", + id: "API/get-all-bookmarks", + label: "Get all bookmarks", + className: "api-method get", + }, + { + type: "doc", + id: "API/create-a-new-bookmark", + label: "Create a new bookmark", + className: "api-method post", + }, + { + type: "doc", + id: "API/search-bookmarks", + label: "Search bookmarks", + className: "api-method get", + }, + { + type: "doc", + id: "API/get-a-single-bookmark", + label: "Get a single bookmark", + className: "api-method get", + }, + { + type: "doc", + id: "API/delete-a-bookmark", + label: "Delete a bookmark", + className: "api-method delete", + }, + { + type: "doc", + id: "API/update-a-bookmark", + label: "Update a bookmark", + className: "api-method patch", + }, + { + type: "doc", + id: "API/summarize-a-bookmark", + label: "Summarize a bookmark", + className: "api-method post", + }, + { + type: "doc", + id: "API/attach-tags-to-a-bookmark", + label: "Attach tags to a bookmark", + className: "api-method post", + }, + { + type: "doc", + id: "API/detach-tags-from-a-bookmark", + label: "Detach tags from a bookmark", + className: "api-method delete", + }, + { + type: "doc", + id: "API/get-highlights-of-a-bookmark", + label: "Get highlights of a bookmark", + className: "api-method get", + }, + { + type: "doc", + id: "API/attach-asset", + label: "Attach asset", + className: "api-method post", + }, + { + type: "doc", + id: "API/replace-asset", + label: "Replace asset", + className: "api-method put", + }, + { + type: "doc", + id: "API/detach-asset", + label: "Detach asset", + className: "api-method delete", + }, + ], + }, + { + type: "category", + label: "Lists", + items: [ + { + type: "doc", + id: "API/get-all-lists", + label: "Get all lists", + className: "api-method get", + }, + { + type: "doc", + id: "API/create-a-new-list", + label: "Create a new list", + className: "api-method post", + }, + { + type: "doc", + id: "API/get-a-single-list", + label: "Get a single list", + className: "api-method get", + }, + { + type: "doc", + id: "API/delete-a-list", + label: "Delete a list", + className: "api-method delete", + }, + { + type: "doc", + id: "API/update-a-list", + label: "Update a list", + className: "api-method patch", + }, + { + type: "doc", + id: "API/get-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", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/versioned_docs/version-v0.25.0/API/summarize-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.25.0/API/summarize-a-bookmark.api.mdx new file mode 100644 index 00000000..20c7d734 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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: eJytVUuP2zgM/isGT1tAiNNFFy18Sw8FpnvYwc4seghyYCwm1sSWXIlOkxr67wvKzmvGfRzmZFvi4+PHj3QPmkLpTcvGWShgwYxlRSHDLHRNg/6Yscu4omzt3K5Bv8vQ6swTd96GdNG1GpnkrHRez0AB4zZAsYSPo0uAlYJAZecNH6FY9rAm9OQXHVdQLFdxpaBFjw0x+ZAMQllRg1D0wMeWoIDA3tgtKKADNm0tR4aMrg/HbfPt6cN7d/j+V3VgduUHQWA4mZwQ3GmICjx97YwnDQX7jhRYbMRofTFSYISFFrkCQeUptM4GCoLkz/lcHreEPV4xcKbom+HqxB8oKJ1lsizO2La1KVGc86cgESZqdesnKhkUtN615NkM+Y1+yUdUUHqS7AuevG2cNhszfa3AdnWNa6FKGIln4n7DEn1ZmT1dY1o7VxNaSbvBvZN2/+iecbs1dvvAyF34dT4FZLtGNBW6sqQQQFKYuvMkNJHV4rWKCgbWzfdE8euHt45/j55T939teyPMpXT5uqc3Hbxi/Ybi53xO07CKUZK9m797KePToGTWcbZxndWvp9vS6QnORJsUAm6n7p5xkiJc7FMhyZ8rp2VeXUhpZWwLyE9zGPL+MtsxP3EioQL5/WnXdL6GAnrU2lMIMcfW5Pu3oGCP3kijUhXj9UDdBruaoYCKuQ1FnrM/znbocUfUzrBtQU2siTFC5jZpb/492mcDFogxXq3JByF3yHy9LM9MSWapI5nJbCUjUOPLJ+cbFISfvzwmOo3dOHGXqgdIb2fz2fxqV57xLO7vJvEv7u+yjfO34KXYqFIHGkyyGLfqw4ntDM+L8XnY/iKxV/rzDOQwHThvazRp16T+9qM6lud1L2NS3Oz+i0BWCirRVLGEvl9joP98HaMcf+1Ipnq5usgjiUibIO8aig3WgX5S6B//jsp+k/0I8XiI9phUWHfyBQp2dLz9X0XZSRWhJp9QDAaLsqSWr1xfTK8o7Tw99/88PMpquRXYM0Gl8JO4+n6weHQ7sjGeYbJ8C8IY/wc5POmb +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}},"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.25.0/API/update-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.25.0/API/update-a-bookmark.api.mdx new file mode 100644 index 00000000..e61eb3db --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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/QRbJBD4YPI3FscS2RCkl5rQj678FQsj52lY2Arg+GSA7J4Zv3ZqYGQTYxsnBSK4jgUyHQURBrfcrRnIK4CqSzgRQQgsOjhWgH77pFC/sQLCWlka6CaFdDTGjIbEuXQrTbN/sQCjSYkyNjvYFNUsoRohpcVRBEYJ2R6ggh0AXzIuMpSVJkl+qYPz68/VVfvvySXpzTyVv2QDpvcvXgVkATgqHPpTQkIHKmpBAU5mwUD0YhSH5cgS4F9op3kHXvtKjYlykE9ykFAh0GTgelh2MV/KuyKnApBQdJmbBBpcvgEZUbbAJFJHgYU1AYfZaCxApCSLRypBxfg0WRyQT5mvWD5btmANHxAyUOQiiMLsg4SdbvNUkqz/zG3jLWOiNUjMABz5qj8K11W+Y5mmoOd1VmGcaMKoPXhKC0o+eGTQ/+944IIcfL36SOTIKbzWbThJAYQkdi6xZ5UJpszu6gTY4OIiiNZH8mUVtwLJYu1WaRaVHGmbQpLbPm8N91O8TiHf9oIQ9y4QZHl2XYobXk3g+c+84G/2M92EIr21Lt581mXhQt0UWfHF6P3XIGhZdp04SQdwAuZNVC+jKG/0trDo9HqY4fHbrSLpELqTLntGrLJCFrmekos9IQw0RK8K59L2L5xUP8+sfP634GnuXJZJKbd+CLyBDTSQRHqE8gfornPAz7lsZvNm+eM/daKwKlXXDQpRKvx9tEi/lcmZO1eJxbe4KJP2Gw33eCzMmlWrQlK0n5Xi5dEayv2rPreqhvDcNC5nytsj6BQo1CGLK2WWMh1+cbCOGMRnJ82pLSLreIHbDMOLemzhU2Wq+dqVYnNHgiKlZYFBDOJITuhEAffG38q7MPWl+gaZpRg/CRMW1vHrcJPUB8M7/Dm7GkvBGE3cfv1+z/53/3HkWO1Yehjv927R/GtbJVwFix7UxP4RF1Pf2H8bXV6CdGyWiYbJHuh1OI+ulr5RlmRgVmtHtaR6YLQ7kY+eirwuieSfIf0VGqg2ZkmCGtbzerzWozemYfu+3d7Wyst3e3wUGbaaCZGFwutXU5euV0vVfXRuK4Vjyp170EX+45W3LwS9dFhtKn2K5BaDWx6xs9zg7RqOvbh5Bq69ikrmO09MlkTcPTn0vi6O/2gyS8cIS0/C0gOmBm6QWff/jQifjH4FtedpOoKq+8rOQRhHCiatqdNpx+U0LBdNjVnUEXx5/u+ZjhgGfpqgmvO7ZJQoV70XY/Si132/v3f7C+ui4498kMDD5C6P+9t9o/3svWz9WQoTqWPrlBe2jTNVfjejgVr3/WLB513Vrc6xOppunhcTxmZJrmK4OCX9A= +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}},"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.25.0/API/update-a-highlight.api.mdx b/docs/versioned_docs/version-v0.25.0/API/update-a-highlight.api.mdx new file mode 100644 index 00000000..03e02440 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/update-a-list.api.mdx b/docs/versioned_docs/version-v0.25.0/API/update-a-list.api.mdx new file mode 100644 index 00000000..e240ffe1 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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/SvEnFqAtZ0iRRe6uYsWTbtAg60XPRg+jMWxxUQitSSVWBX034uhJEuOlSwKxAdDJEfz8d6boRpQ5FOny6CtgQS+lAoDiVz7IPa10MELrUBCwKOHZAuftA8edhI8pZXToYZk28Ce0JFbVyGDZLtrdxJKdFhQIOejgU8zKhCSBkJdEiTgg9PmCBLohEWZ85YmrfJTfSyeHz78bE///pSdQrDpB46uQzTh6HcKWgmOvlbakYIkuIokGCzYIO8MJGgupsSQAWfD1uTDL1bVnMNlyZuMhMKAIlhRxfIX4i+T1yJkJA6acuVFbSvxjCaMNsIQKV7uSZTOPmlFagESUmsCmcBhsCxznSKHWT54jjUDhN0/UBpAQulsSS5o8nza1XMNV6HNJzJHBvpGQoGnYXW7auVlYdcvmyrPcc9IdqBNnK0unN2s2JtO59y0kVwyjPM3Y7QSvlbk6m+Vwk6rfa7TieHe2pzQQBt/TKIvrfEdPj+uVvNMduyoqOD3o0PP1NrKV1j6v0S8G9SdwUyPmarg5i3QVJiDBF+gC9zFig5Y5QGS4ewtwq7ivUHZtEO3EEdIBKsvdVLY2c3uss+hY/12dXtNNJ8LY4M42Mqo96M5tWqez4K8x+Pc2YtKo4fRftdrt6CQWdWNpDSL5bPuYcky9cumm1stU0PuaZialcshgQaVcuR9u8RSL59uQMITOs1MxKT74w6lgc4shNIny2Vw9eIRHT4SlQssS5AzPdN7EPYQZ96fvb3ocmEiJgP/b8ayizwd+2dgODLXEc1YE9EIZP/wm3UFcoZ//LOJ6DFHn8f5/OtwHwwzcNTfZeLn7a53xvXYMuNer+mJUS/dof/MwXJIhr5zf7NYLVaTq+cMyvr+bhbE9f2dOFh3iSAjzo1ifSjQTIrq71kc5tSLgXHW8+sXcod2oFNYljlqw3GiYJpeXNt4G3qQkPTX4k5CZn3go6bZo6cvLm9b3u7x2e5GbUUFKu35WUFywNzTG3l+97nvgu/Fa9n1m2jqKOG84hVIeKR6vLrbXSshI1TkYgbd4ccuzg8bdjG+fNXrrRzeWKcpleFN292kL+/Xm4+/s0j7T4QiTgJw+Awy/sdMbSw8aj/uNZCjOVZxMkDnlCWNlx3xogNiWbNYNE1nsbGPZNr2DE3gNSPTtv8BTB5PJw== +sidebar_class_name: "patch api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"Update a list"} +> +</Heading> + +<MethodEndpoint + method={"patch"} + path={"/lists/{listId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Update list by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"description":"The data to update. Only the fields you want to update need to be provided.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","nullable":true,"minLength":0,"maxLength":100},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"query":{"type":"string","minLength":1},"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.25.0/API/update-a-tag.api.mdx b/docs/versioned_docs/version-v0.25.0/API/update-a-tag.api.mdx new file mode 100644 index 00000000..f9078a9e --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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.25.0/API/upload-a-new-asset.api.mdx b/docs/versioned_docs/version-v0.25.0/API/upload-a-new-asset.api.mdx new file mode 100644 index 00000000..841a9639 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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/SsGz26c7uhbtqFANmAr0BQ7BDnQNl2rsS1VotNlhv77QMlNnDYD5pMsfj3yPXGEilxplWGle8jh0bQaqwSTnl4TdI4YUmB8cpBvYSX/DnYpOCoHq/gI+XaEgtCSXQ3cQL7d+V0Kll4GcvxZV0fIx3clNg0lFTImrJPSEjIl3FAslrwqbhaQQql7pp4luhtaVgYtZ7W23Y2EyrUrG+rCiY+GIAddPFMpcI3VhiwrcmKtVUvBS7Ec4E61JKULSobQLFXgwye4ndG9i4GflsuP4L8So2pdgoUeOOCOLVSnYc2QozGtKlFCs2cn8f8PO6RbVzNHx1b1T+BPJTbh/ordqT9zQz90BVkxyCx+YHctykfWlKVKqH4rf1lsSj1LtEtPgw3qgGmSHXGjK8jBaBeaQ1EHZBglJAqyB7IuCGiwLeQwYlVZcs5naFR2uIUUDmgVFu00kWiOnNQ4tAw5NMzG5VnG9rjYo8U9kVmgMZBeUd2UIdF1YO775J9ELAJ9Ju0HISpWngv8NDipLH0EN8gnJ0inw522HQrCb782Ybqqr7WES9cR0u1iuVjCeYAnPKv79VX8q/t1Umt7CV6a9WmYc4dBYn1g+PpTvkg6nsX6j4cfW2X6zZlpUfVSKbA1ToxOSglLoRGq8y2MY4GOHm3rvVy/DGRlUezOfIY9kUJDWJENEtjTEXL4EuHcTGI7YDtI/WsbwKdvQauyJMMz9w/PTmg9CfL+58NGWJp2U6criZHEIW96PkaQeEn7O5oD+MmE/XGGYhyjx0bvqfce0gkuyz/4nff+L1YD4pc= +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"}}}}}}} +> + +</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 |