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/get-highlights-of-a-bookmark.api.mdx | |
| 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/get-highlights-of-a-bookmark.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.25.0/API/get-highlights-of-a-bookmark.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
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 |
