diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-04-13 16:18:09 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-04-13 16:18:09 +0000 |
| commit | ae76f9464f2f64018548f4ddfe7b94b92616c6dd (patch) | |
| tree | add456d6e4039e4843125bffad22fd106c281f8c /docs/versioned_docs/version-v0.23.2/API/get-highlights-of-a-bookmark.api.mdx | |
| parent | 969e774ac029c9fd2f82678af7981862966b79f2 (diff) | |
| download | karakeep-ae76f9464f2f64018548f4ddfe7b94b92616c6dd.tar.zst | |
docs: Release the new API docs
Diffstat (limited to 'docs/versioned_docs/version-v0.23.2/API/get-highlights-of-a-bookmark.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.23.2/API/get-highlights-of-a-bookmark.api.mdx | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.23.2/API/get-highlights-of-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.23.2/API/get-highlights-of-a-bookmark.api.mdx new file mode 100644 index 00000000..30b13898 --- /dev/null +++ b/docs/versioned_docs/version-v0.23.2/API/get-highlights-of-a-bookmark.api.mdx @@ -0,0 +1,72 @@ +--- +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: eJytVU1v2zgQ/SvCnFqAiNyiRQvdXKAf6aXFbhY9BD7Q0thiIpHscJTaFfjfF0NLkZyoTQ89WSYfh2/evBn2UGEoyXg2zkIBH5Gz2uzrxuxrDpnbZTrbOnfbaroFBaz3AYpreDcsBdgoCFh2ZPgIxXUPW9SEtO64huJ6EzcKvCbdIiOFBAhlja2Gogc+eoQCApOxe1CAB936RpYMmqo5HPftj5u3b9zh5+v6wOzKt8LAcIKMDC4riAoIv3eGsIKCqUMFVrcC2k4gBUby85prEFaEwTsbMAiTl6uV/JxLcVVj1pjAIsIkCSgonWW0LCe0940ptZzIb4IcW0jQbW+wZFDgyXkkNqdLZzEnrCbSRyHL2IanY8wSfCRoVBBYE3/Z7QLybN927RZJ9tFWv9ktXeNosVC2a8UFR2wa9wNETBF4T4gWFGybDsUXFe501zAUIzAqYDzwUkjbNY3eSmWlgFGBdYx/BDTLqXcB6ReqlISasVovEIlnXro+N9Bczbl2Q1YD58To/v75bZvJvZ/G2kN8eOXMFpuYdl+tXj125+j/zDrOdq6z1d9zZumqBe2jghZD0PulvQdJpAgTPiWSznPtKihgn2RLzVhAPqoc8n4SPOZnTReQ7sYR0lEDBfS6qghDiLn2Jr97AQruNBkxR8pi2D5JNzqxZvahyHOm40XtNFVIF9p7UAvNPwSQ/ucaswGenZhI4Waz71+RdujJ2QS810nulSwSTCZTAkmzpI8Pjlot/D5/u0piGrtzclxyPjF6cbG6WM0G4KeBzvrr5SL79dfLbOcoUR+xkmlU4F3gVidLDIPyibF/Fr2fbPbkc3FKXtoj9402NnWmVK8fij+1mBS5OOu3eScoqF1gwff9Vgf8j5oYZfl7hyQvz2aqfvJIZYJ8V1DsdBPwNzk8+2cw7vPsV5TH4WyPyWQy3woABbd4PH9l4iYqqFFXSInFCbAuS/Q8O/qoOcVK983x8f0VKNDnBnpgmBR9kVbfnxBX7hZtjPcsWf4LwRj/B3Qvuxk= +sidebar_class_name: "get api-method" +info_path: API/hoarder-api +custom_edit_url: null +hide_send_button: true +--- + +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 |
