aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.23.2/API/get-a-single-highlight.api.mdx
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-04-13 16:18:09 +0000
committerMohamed Bassem <me@mbassem.com>2025-04-13 16:18:09 +0000
commitae76f9464f2f64018548f4ddfe7b94b92616c6dd (patch)
treeadd456d6e4039e4843125bffad22fd106c281f8c /docs/versioned_docs/version-v0.23.2/API/get-a-single-highlight.api.mdx
parent969e774ac029c9fd2f82678af7981862966b79f2 (diff)
downloadkarakeep-ae76f9464f2f64018548f4ddfe7b94b92616c6dd.tar.zst
docs: Release the new API docs
Diffstat (limited to 'docs/versioned_docs/version-v0.23.2/API/get-a-single-highlight.api.mdx')
-rw-r--r--docs/versioned_docs/version-v0.23.2/API/get-a-single-highlight.api.mdx72
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.23.2/API/get-a-single-highlight.api.mdx b/docs/versioned_docs/version-v0.23.2/API/get-a-single-highlight.api.mdx
new file mode 100644
index 00000000..53d98650
--- /dev/null
+++ b/docs/versioned_docs/version-v0.23.2/API/get-a-single-highlight.api.mdx
@@ -0,0 +1,72 @@
+---
+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/RWDpw0QknTosMG3HLauu7TYOuwQ5KBYjK3WllSJbpMZ+veBipM4qVvssFMc84l6fHykO1AYCq8daWsghyukrNJlVeuyomy1zTSFTCsQQLIMkC/g2z4aYCkgYNF6TVvIFx2sUHr085YqyBfLuBTgpJcNEvqQAKGosJGQd0Bbh5BDIK9NCQJwIxtX8yuNWtWbbdk833/+ZDd/PlYbIlt8ZgqaEuRA4VpBFODxsdUeFeTkWxRgZMOoaoASoLk6J6kC5uUxOGsCBubyYTbjn1Mhblb3WFD2rKkaCKIkyQkIKKwhNMTHpHO1LiQfm94HPjtSp03ZQIDz1qEnvbt5Ze1DI/3DtXqpSRQQSHq6Wa8D0iBu2maFnuNo1BvRwtbWj2pt2oY7ucW6ts/AarBCpUc0IGBVt8itVbiWbU2Q74FRAOGGxlKatq7lipvDLYgCjCX8J6AeL70N6F9RpfAoCdV8hEg8ccNiqO+pmkPt+qp6zonR4f7hbcsRA0KMfOfl7PKlgw6gzFjK1rY16v85p7BqRN8ooMEQZDkWO9MmZTjil3FXSoNUWQU5lEmaNDE5TA8jEKbdYLAi64r+aT/gra8hh04q5TGEOJVOT58uQMCT9Jr7nsj34Z1ke5NVRC7k0yn57aSy0iv0E+kciDNZ7yrM+gSZXWdUYdbDsx0T7slgM/1kRftxG+yngzx8L1eRYJD3IJ6D9PDV+kYyv++/75KG2qwtH+ead4wuJrPJbLieejrz2+tR9vPb62xtfaK+x3KlUYCzgRqZnNBvMV7IMgvalDUeF9F53u7oq7dW+K5itvvU1VKbNGncsq5v9OK4NQMIyIc7dCmgsoEY1HUrGfCXr2Pk148tev4CLI99Tm5QOvCzgnwt64BvcH73o3fm++w1nv1LabbJTrykcgABD7g9W/ZxGQVUKBX6RGOHmBcFOhqcfTF+7JqD/a++3IEAeeqVM2+k7KO8um6HuLMPaGI80CT+zwRj/Asdfo7e
+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 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