diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-11-29 18:31:05 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-11-29 18:32:19 +0000 |
| commit | 97c386a4d15294b4ed07ff83c8a6a773e7289ab8 (patch) | |
| tree | 3c8a22fdd92efa489638d5216714497d61b47b3e /docs/versioned_docs/version-v0.29.0/api/update-a-highlight.api.mdx | |
| parent | f01d96fd91f8829d4d91c465e9950e78fc6f7513 (diff) | |
| download | karakeep-97c386a4d15294b4ed07ff83c8a6a773e7289ab8.tar.zst | |
release(docs): release the 0.29 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.29.0/api/update-a-highlight.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.29.0/api/update-a-highlight.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.29.0/api/update-a-highlight.api.mdx b/docs/versioned_docs/version-v0.29.0/api/update-a-highlight.api.mdx new file mode 100644 index 00000000..c8b25624 --- /dev/null +++ b/docs/versioned_docs/version-v0.29.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/RViTg3A2E6QooFubtAimx6ySBzkYPhAi2OLa4lkyNGuVUH/Xgwl2/Kusg2Q+CSLT5yZN+/NtKAx5sF4Ms5CBl+8VoSiMPuiNPuCxLYRhqIwGiSQ2kfI1vD+dBphIyFiXgdDDWTrFraoAoZlTQVk6023keBVUBUShpgAMS+wUpC1QI1HyCBSMHYPEvCoKl/yK4NGl8dmXz3cvf3DHf/9vTgSufwtp2AoQc4p3GjoJAT8VpuAGjIKNUqwqmJUMUJJMFygV1QA58WfYKQ/nW44m2saVgUKrUgJcqJOlMzER1s2ggoUO4OljqJxtXhQli4YYRE1/92i8MHdG416BhJyZwktcRjlfWlyxWHmd5FjTVDitneYE0jwwXkMZDDyae5KFyaZs3XFfWmwLN0DcG1c7z4gWpCwLWuETSfBOsKp721dlmrLvDJ7XfrxJdE7G/vYrxeLaZb6yvVFMb+u3q1zh0qFw41+mnQnIZIK9HG3i0ijc1tXWwx8jlY/c/pzZErQuFN1SZCdgJ0EwiP9AL8/3AgJZrr0OmL4Dit5QO7HciKR7soo6zG/12yOuRuqGnJOGZ3jj6NtJrwJvZDeLN481c4ZJKwjsXO11b/SKXqC305ChTGq/dTZI27SDRf8ZvBEhVQ43Y+RvOC4PE4ymJ/lH+ftaOp0zCyG+9P0q0MJGbRK64AxdnPlzfz+FUi4V8Fw51P6w3FP2klmBZGP2XxOoZkdVFAHRD9T3oOccOVwg3C7NLH+GfCiz4X7Mhrcn5nVwXKj8X2miCNzHQkG2QBiL6SHv12oFGf44esq8cjd+nSZrn+d5vp5gl281Rth1CBjd46RzFhfzqvZYrYYTf5zLcvbm8nal7c3YufCdeFMVCfBu0iVSloaVsSw8NTVALu6tL2o8n/WY08X+2XuS2Vssip3vB10sr5spAgSsvF+2kgoXCQGte1WRfwSyq7j199qDLxdNxeZJDFpE/lZQ7ZTZcRn0v7t0yDtF+J7eQ4vlW2SGnnKZQASDtg8WqQdr5IClcaQ0ugR7/pgL1d8z+WGJy7u5OmLZZ6jp2exm5Hjbperd+9ZdMPCrpLHIag0o9VDn65L1Sctp3ctlMru6+R56C9liaprhT9SdCprkpC27RErd0DbdWd+iP8zM133H3AUMso= +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"]},"note":{"type":"string","nullable":true}}}}}}} +> + +</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 |
