diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-07-20 13:24:58 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-07-20 13:24:58 +0000 |
| commit | 0cd9eea0da130ea855c0e63fb8e0de717c8336e0 (patch) | |
| tree | c4118d290c44cbff80f37adc95ac311620c77550 /docs/versioned_docs/version-v0.26.0/API/update-a-bookmark.api.mdx | |
| parent | 705e46dc6caa7c84de7458bb2f43f619d5d100ca (diff) | |
| download | karakeep-0cd9eea0da130ea855c0e63fb8e0de717c8336e0.tar.zst | |
docs: Release the 0.26.0 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.26.0/API/update-a-bookmark.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.26.0/API/update-a-bookmark.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.26.0/API/update-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.26.0/API/update-a-bookmark.api.mdx new file mode 100644 index 00000000..e61eb3db --- /dev/null +++ b/docs/versioned_docs/version-v0.26.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/SvCnFpAtb1Figa6OUGLbj/QRbJBD4YPI3FscS2RCkl5rQj678FQsj52lY2Arg+GSA7J4Zv3ZqYGQTYxsnBSK4jgUyHQURBrfcrRnIK4CqSzgRQQgsOjhWgH77pFC/sQLCWlka6CaFdDTGjIbEuXQrTbN/sQCjSYkyNjvYFNUsoRohpcVRBEYJ2R6ggh0AXzIuMpSVJkl+qYPz68/VVfvvySXpzTyVv2QDpvcvXgVkATgqHPpTQkIHKmpBAU5mwUD0YhSH5cgS4F9op3kHXvtKjYlykE9ykFAh0GTgelh2MV/KuyKnApBQdJmbBBpcvgEZUbbAJFJHgYU1AYfZaCxApCSLRypBxfg0WRyQT5mvWD5btmANHxAyUOQiiMLsg4SdbvNUkqz/zG3jLWOiNUjMABz5qj8K11W+Y5mmoOd1VmGcaMKoPXhKC0o+eGTQ/+944IIcfL36SOTIKbzWbThJAYQkdi6xZ5UJpszu6gTY4OIiiNZH8mUVtwLJYu1WaRaVHGmbQpLbPm8N91O8TiHf9oIQ9y4QZHl2XYobXk3g+c+84G/2M92EIr21Lt581mXhQt0UWfHF6P3XIGhZdp04SQdwAuZNVC+jKG/0trDo9HqY4fHbrSLpELqTLntGrLJCFrmekos9IQw0RK8K59L2L5xUP8+sfP634GnuXJZJKbd+CLyBDTSQRHqE8gfornPAz7lsZvNm+eM/daKwKlXXDQpRKvx9tEi/lcmZO1eJxbe4KJP2Gw33eCzMmlWrQlK0n5Xi5dEayv2rPreqhvDcNC5nytsj6BQo1CGLK2WWMh1+cbCOGMRnJ82pLSLreIHbDMOLemzhU2Wq+dqVYnNHgiKlZYFBDOJITuhEAffG38q7MPWl+gaZpRg/CRMW1vHrcJPUB8M7/Dm7GkvBGE3cfv1+z/53/3HkWO1Yehjv927R/GtbJVwFix7UxP4RF1Pf2H8bXV6CdGyWiYbJHuh1OI+ulr5RlmRgVmtHtaR6YLQ7kY+eirwuieSfIf0VGqg2ZkmCGtbzerzWozemYfu+3d7Wyst3e3wUGbaaCZGFwutXU5euV0vVfXRuK4Vjyp170EX+45W3LwS9dFhtKn2K5BaDWx6xs9zg7RqOvbh5Bq69ikrmO09MlkTcPTn0vi6O/2gyS8cIS0/C0gOmBm6QWff/jQifjH4FtedpOoKq+8rOQRhHCiatqdNpx+U0LBdNjVnUEXx5/u+ZjhgGfpqgmvO7ZJQoV70XY/Si132/v3f7C+ui4498kMDD5C6P+9t9o/3svWz9WQoTqWPrlBe2jTNVfjejgVr3/WLB513Vrc6xOppunhcTxmZJrmK4OCX9A= +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"]},"summarizationStatus":{"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","summarizationStatus"]}}}},"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 |
