diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-04-27 19:11:34 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-04-27 19:11:34 +0000 |
| commit | f24d704571c83780e9373c6e2733e62073133dcf (patch) | |
| tree | 7b090ad3452885e17a7639b907cf9cabe9e4aa81 /docs/versioned_docs/version-v0.24.0/API/update-a-bookmark.api.mdx | |
| parent | c81e7bae942291d8c7b39495ed8c4caf646c5992 (diff) | |
| download | karakeep-f24d704571c83780e9373c6e2733e62073133dcf.tar.zst | |
docs: Release the 0.24.0 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.24.0/API/update-a-bookmark.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.24.0/API/update-a-bookmark.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.24.0/API/update-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.24.0/API/update-a-bookmark.api.mdx new file mode 100644 index 00000000..aa0c8c20 --- /dev/null +++ b/docs/versioned_docs/version-v0.24.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/SvCnFpAtb1Figa6OUGCbj/QRbJBD4YPI3FscS2RCkl5rQr678VQsj52tRsBzR4WJjUkh2/ee8MaBNnEyMJJrSCCL4VAR0Gs9SlHcwriKpDOBlJACA6PFqIdvOs+WtiHYCkpjXQVRLsaYkJDZlu6FKLdvtmHUKDBnBwZ6wNsklKOENXgqoIgAuuMVEcIgS6YFxlPSZIiu1TH/PHh7a/68u8v6cU5nbzlDKTzIdcMbgU0IRj6WkpDAiJnSgpBYc5B8RAUguTLFehS4Kx4BVn3TouKc5lCcJ9SINBh4HRQejhWwd8qqwKXUnCQlAkbVLoMHlG5ISZQRIKHMQWF0WcpSKwghEQrR8rxMVgUmUyQj1k/WD5rBhAdP1DiIITC6IKMk2T9WpOk8sx37CNjrTNCxQgc8Ky5Ci99t2Weo6nmcFdllmHMqDJ4TQhKO3oe2PTgf2uLEHK8/EnqyCS42Ww2TQiJIXQktm5RBqXJ5uIO2uToIILSSM5nUrUF22LpUm0WhRZlnEmb0rJoLv9dt0IsXvGXFvIgFy5wdFmGHVpL7v3AuW8s8H+sB1toZVuq/bzZzIuiJbrozeH7sVvOoPA6bZoQ8g7AhaxaSF/G8H9pzeHxKNXxs0NX2iVyIVXmbKu2TBKylpmOMisNMUykBK/avyjMmfyXq31injvwLj+APoF4BMsEg6cX3reMerN585xEV9sOlHbBQZdKfD8KJVrM21ZO1uJx7tuT2/sdhvh9p42cXKpF2z2SlM/lLhLB+ioDu66HVtMAt0RzvjY872VQoxCGrG3WWMj1+QZCOKORXInW3dvPLWIHLDO2udS5wkbrtTPV6oQGT0TFCosCwhltdjsE+uDb1B9dfNDmAk3TjHr1Z8a0PXncsXuA+GS+hw9jdvsgCLsfH69G/Ps/9x5FrtWnoaV+uLbycdtquT4WTzvTk3VEUk/0YXzt+v3EyBeGyRbpfjiFqJ++NoFhZuT1o9VTS59+GJx7lKM36NE5Ex8e0VGqg2ZkmCFtbjerzWozumZfu+3d7Wytt3e3wUGbaaGZGNy5tHU5euV0z6DuRYdj237SOnsJvv78a8nBN10XGUrvdl2vbjWx699c7GLR6AG2DyHV1nFIXcdo6YvJmoanv5bE1d/tB0l44Qhp+beA6ICZpVdy/uFTJ+Ifg5ey7CZRVV55WckjCOFE1fSh2LDRpoSC6bCru4Cujj/d8zbDBs/sqgmvK7ZJQoV7NXY/spa77f3731hf3YM092YGBh8h9P99ttpf3svWz9WQoTqW3tyg3bTp3jnj1jQVr7/WLB513Ubc6xOppunhcTxmZJrmP/ieNbs= +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"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus"]}}}},"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 |
