diff options
Diffstat (limited to 'docs/versioned_docs/version-v0.29.0/api/update-a-bookmark.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.29.0/api/update-a-bookmark.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.29.0/api/update-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.29.0/api/update-a-bookmark.api.mdx new file mode 100644 index 00000000..5536c01c --- /dev/null +++ b/docs/versioned_docs/version-v0.29.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: eJytVtuO2zYQ/RVhnlpAtb1FigZ6c4IW3V7QRbJBHww/jMSRxbVEKrx47Rj692IoWZddZeOiqyeRHJLDM+fMzBkE2czI2kmtIIFPtUBHUar1vkKzj9JTJJ2NpIAYHO4sJBt41y1a2MZgKfNGuhMkmzOkhIbM2rsCks222cZQo8GKHBkbDGxWUIWQnMGdaoIErDNS7SAGOmJVlzwlSYryeNpVjw9vf9bHLz8VR+d09pY9kC6YXDy4FdDEYOizl4YEJM54ikFhxUbpYBSD5MfV6Apgr3gHWfdOixP7MoXgvqBIoMPI6cgHOBbR36o8Ra6gKJdUChudtI8eUbnBJlJEgocpRbXRBylILCCGTCtHyvE1WNelzJCvWT5YvmsGEJ0+UOYghtromoyTZMNekxXywG/sLVOtS0LFCOR40ByFr61bX1VoTnO4K1+WmDKqDF4Tg9KOnhs2PfjfOiKGCo9/ktoxCW5Wq1UTQ2YIHYm1u8oDb8o5u1ybCh0k4I1kfyZRu+JY9K7Q5irT2qeltAVdZ83hv+t2iKt3/KWFzOWVGxwdr8MOrSX3fuDcNzaEj/Vga61sS7UfV6t5UbREF31yeD12yxkUXqZNE0PVAXglq66kL2P4v7TmcLeTavfRofP2GrmQ8hWnVeuzjKxlpqMsvSGGiZTgXdtexPJLgPj1j5/X/Qw8/yWZWO1NdlXSuLiJtYQYHilldpX8X+lUlhRKhCNlmY8xWKl2JeXtggnPklWtjQtv8ZbM7RynJtViA6GsDSybcGrEg0nQn0Z4PjC9D9tWYW9Wb56L6lLGIqVdlGuvxOtJKtNiPo1XZC3u5taegBNOGOy3Xa6oyBVatNU0K/herqoJLC9pwS7PQ+ltGB8yh0sDEHI7nFEIQ9Y2S6zl8nADMRzQSOZDW+3a5RaxHH3Jab9wrrbJcunMabFHg3uieoF1DfFMrupOiHQeyvYfnX3U+gJN04x6l4+MaXvzuIPpAeKb+R3BjNUejCDufn69FKbf/7kPKHKsPgwtxi+X1mZcxlvWj5NJO9OraySVoMxhfOmC+olRnhwmW6T74RSifvpSFIeZUe0b7Z6WuOnCUMlGPoaCNbpnUpdGdJQq14wMM6T17WaxWqxGz+xjt767nY31+u42yrWZBpqJwZVcW1dhUE7XFnYdLo7L2JNWopfgy+1wSw5+6bIuUYbs3/UurSY2fQ/KCSEZNaTbGAptHZuczyla+mTKpuHpz544+pvtIIkgHCEt/wtIciwtveDzdx86EX8ffc3LbhLVKSiv9DyCGPZ0mjbODWfTglAwHTbnzqCL4w/3fMxwwLN01cSXHesso9q9aLsdpZa79f3731hfXYNehWQGBh852+Nj660Ojw+yDXNnKFHtfEhu0B7adH3fuFRPxRueNYvH+dxa3Os9qabp4XE8ZmSa5l9CRZNh +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},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"userId":{"type":"string"}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","userId"]}}}},"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 |
