diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-04-13 16:25:03 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-04-13 16:25:03 +0000 |
| commit | f3c525b7f7dd360f654d8621bbf64e31ad5ff48e (patch) | |
| tree | f9c8378e5c24caf1441f055d0d08b60f8b91a0ab /docs/versioned_docs/version-v0.23.1/API/update-a-bookmark.api.mdx | |
| parent | ae76f9464f2f64018548f4ddfe7b94b92616c6dd (diff) | |
| download | karakeep-f3c525b7f7dd360f654d8621bbf64e31ad5ff48e.tar.zst | |
docs: Revert 0.23.2 docs and just update 0.23.1 instead
Diffstat (limited to 'docs/versioned_docs/version-v0.23.1/API/update-a-bookmark.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.23.1/API/update-a-bookmark.api.mdx | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.23.1/API/update-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.23.1/API/update-a-bookmark.api.mdx new file mode 100644 index 00000000..65bd5882 --- /dev/null +++ b/docs/versioned_docs/version-v0.23.1/API/update-a-bookmark.api.mdx @@ -0,0 +1,72 @@ +--- +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/SvCnFpAtb1Figa6OUGLbNGii2SDHgwfxuLY4q5EKvzwWhX034uhZH1ktRsBzR4WJjUkh2/ee8MaBNnUyNJJrSCBz6VAR9FB68cCzWN0qCLpbCQFxODwZCHZwbvuo4V9DJZSb6SrINnVcCA0ZLbeZZDs9s0+hhINFuTI2BBg04wKhKQGV5UECVhnpDpBDHTBosx5SpIU+aU6FU8Pb3/Vl39/yS7O6fQtZyBdCLlmcCugicHQFy8NCUic8RSDwoKDDkNQDJIvV6LLgLPiFWTdOy0qzmUKwX1GkUCHkdORD3Csor9VXkUuo+goKRc2qrSPnlC5ISZSRIKHB4pKo89SkFhBDKlWjpTjY7Asc5kiH7N+sHzWDCD68ECpgxhKo0syTpINa02ayTPfsY88aJ0TKkbgiGfNVXjpu/VFgaaaw135PMcDo8rgNTEo7eh5YNOD/60tYijw8iepE5PgZrPZNDGkhtCR2LpFGXiTz8UdtSnQQQLeSM5nUrUF26J3mTaLQkt/yKXNaFk0l/+uWyEWr/hLC3mUCxc4uizDDq0l937g3DcWhD/Wgy21si3Vft5s5kXREl305vD92C1nUHidNk0MRQfgQlYtpC9j+L+05vB0kur0yaHzdolcSPmCbdX6NCVrmekoc2+IYSIleNX+RWHO5L9c7RPz3EFw+QH0CcQjWCYYfH3hfcuoN5s3z0l0te1IaRcdtVfi+1Eo1WLetgqyFk9z3766fdhhiN932ijIZVq03SPN+FzuIgmsrzKw63poNQ1wSzTna8MLXgY1CmHI2maNpVyfbyCGMxrJlWjdvf3cInZEn7PNZc6VNlmvnalWmUYjyKywLCGekWa3QaSPoUt14VGbCTRNM+rUnxjR9txxv+7h4XP5FiGMuR2CIO5+/H614T/+uQ8YcqU+Dg31t2sjHzetlulj6bQzPVVHFA00H8bXnt9PjFxhmGxx7odThPrpawsYZkZOP1o9NfTph8G3RzkGex6dM3HhERmlOmpGhvnR5naz2qw2o2t+6Eq3vbudrfT27jY6ahPKfI1lVnDX0tYVGFTTPYG61xyOLfurttnL7/WnX0sNvue6zFEGp+v6dKuHXf/eYgdLRo+vfQyZto5D6vqAlj6bvGl4+osnrv1uP8ghiEZIy78FJEfMLb2S8w8fOwH/GL2UZTeJqgqqyz2PIIZHqqaPxIZNNiMUTIZd3QV0VfzpnrcZNnhmVU18XbFNUyrdq7H7ka3cbe/ff2B1dY/RIhgZGHyCOPwP2epw+SDaMFdDjurkg7FBu2nTvXHGbWkq3XCtWTzquo2414+kmqaHx/GYkWma/wA9UDRf +sidebar_class_name: "patch 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={"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 |
