aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.28.0/api/update-a-bookmark.api.mdx
diff options
context:
space:
mode:
Diffstat (limited to 'docs/versioned_docs/version-v0.28.0/api/update-a-bookmark.api.mdx')
-rw-r--r--docs/versioned_docs/version-v0.28.0/api/update-a-bookmark.api.mdx71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.28.0/api/update-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/update-a-bookmark.api.mdx
new file mode 100644
index 00000000..3cc383fe
--- /dev/null
+++ b/docs/versioned_docs/version-v0.28.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/QRbJBD4YPI3FkcS2RCkl5rRj678VQsj52lY2Krk4iOSSHb+bNmwsIsomRpZNaQQSfSoGOgljrY4HmGMR1IJ0NpIAQHB4sRDt41y1a2IdgKamMdDVEuwvEhIbMtnIZRLt9sw+hRIMFOTLWG9gkowIhuoCrS4IIrDNSHSAEOmNR5jwlSYr8XB+Kx4e3P+vzl5+ys3M6ecseSOdNrh7cCmhCMPS5koYERM5UFILCgo3iwSgEyY8r0WXAXvEOsu6dFjX7MoXgPqNAoMPA6aDycKyCv1VeBy6jIJWUCxvUugoeUbnBJlBEgocxBaXRJylIrCCERCtHyvE1WJa5TJCvWT9YvmsGEB0/UOIghNLokoyTZP1ek2TyxG/sLWOtc0LFCKR40hyFr63bqijQ1HO4qyrPMWZUGbwmBKUdPTdsevC/dUQIBZ7/JHXgJLjZbDZNCIkhdCS2bpEHlcnn7FJtCnQQQWUk+zOJ2oJjsXKZNotMyyrOpc1omTWH/67bIRbv+EsLmcqFGxydl2GH1pJ7P+TcNzb4j/lgS61sm2o/bjbzpGgTXfTF4fWyW86g8HLaNCEUHYALs2ph+jKG/4trDg8HqQ4fHbrKLqELqargsmqrJCFrOdNR5pUhhomU4F37nsTyi4f49Y+f5/0MPP+lmFhdmWRR0bi6iaWEEB4p5uzK+b/QsczJS4QjZTkfQ7BSHXJK2wXjnyWLUhsH+2YiCTvw2jWk0iRxRsGeRPZpGOfR37fsebN585wwV4kKlHZBqislXo8uiRbzJboga/Ewt/YEE3/CYL/v6kBBLtOiVcok43tZMSNYXylv15dBVhuGhczpKu6+bsMFhTBkbbPGUq5PNxDCCY3kWLdK1i63iKVY5VzSM+dKG63XztSrIxo8EpUrLEsIZ+pQd0KgUy/Jf3T2QesLNE0z6ks+MqbtzePupAeIb+Z3eDNmsjeCsPv59So6v/9z71HkWH0Y2odfrm3LWKLbjB4XinamZ86IBp51w/ja4fQToxo4TLZI98MpRP30VfCGmZGujXZP5Wu6MKjUyEcvRqN7JpozSkepUs3IcIa0vt2sNqvN6Jl97LZ3t7Ox3t7dBqk200BzYrBKa+sK9MzpWr6ue8WxRD1pE3oKvtzqtsnBL12XOUpf2bu+pOXEru8vuTpEo2ZzH0KmrWOTyyVGS59M3jQ8/bkijv5uP1DCE0dIy/8CohRzSy/4/N2HjsTfB1/zsptEVXvm5RWPIIQj1dOmuOGqnxEKTofdpTPo4vjDPR8zHPCsXDXhdcc2Sah0L9ruR6Xlbnv//jfmV9d8F76YgcFHruT42Hqr/eM9bf3cBXJUh8oXN2gPbbqebizDU/L6Z83icbm0Fvf6SKppengcjxmZpvkXS5iHXA==
+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"]}},"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