diff options
Diffstat (limited to 'docs/versioned_docs/version-v0.23.2/API/update-a-highlight.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.23.2/API/update-a-highlight.api.mdx | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.23.2/API/update-a-highlight.api.mdx b/docs/versioned_docs/version-v0.23.2/API/update-a-highlight.api.mdx new file mode 100644 index 00000000..929ac8d7 --- /dev/null +++ b/docs/versioned_docs/version-v0.23.2/API/update-a-highlight.api.mdx @@ -0,0 +1,72 @@ +--- +id: update-a-highlight +title: "Update a highlight" +description: "Update highlight by its id" +sidebar_label: "Update a highlight" +hide_title: true +hide_table_of_contents: true +api: eJytVcGO2zYQ/RViTi3A2k6QooFuTtAim0sWqYMeDB1ocWxxVyIVcrRrVeC/F0PJtryrbAI0Psmap5k3j2+GPWgMhTcNGWchgy+NVoSiNIeyMoeSxK4ThoIwGiSQOgTItvDhFA2QSwhYtN5QB9m2hx0qj37dUgnZNo+5hEZ5VSOhDwkQihJrBVkP1DUIGQTyxh5AAh5V3VT8yqDR1bE71I93b/9wx39/L49ErnjLFAwlyJnCjYYowePX1njUkJFvUYJVNaPKCUqC4QYbRSUwL/4EA71zumM21zJsShRakRLkRJskWYhPtuoElSj2BisdROda8agsXTDCImr+u0PRePdgNOoFSCicJbTEZVTTVKZQXGZ5F7jWjCRud4cFgYTGuwY9GQwcLVzl/Kxytq35XDqsKvcI3Bv3e/CIFiTsqhYhj+nHsdA4G4aUr1er+eaHhvTFCD+vjZ1z97Xy9zf6eS9RQiDl6dN+H5AmcdvWO/QcR6tfiP4/jSRo3Ku2IshOwCiB8EhzKW1bVWrHdmTTRQnWEf4Q0My33gb031Cl8MjnsZ4hEq/8v53qe63mVLuxq5FzYnSuP62Wz4wcDEZ6s3rz3DtnkLCOxN61Vv/MAdAz+kYJNYagDnOxJ9qkDBd8Ps5EjVQ6PWyHouS6vCUyWJ7tH5b9ZJlEVhb9w2mptb6CDHqltccQ4lI1ZvnwCiQ8KG/45BP9MTyIdrJZSdSEbLkk3y1Kp7xGv1BNA3JmKMcEwu3THhrhYmDCpzLZxn+zpuPATXbyWSCuy10kGGQjiCchPfzlfK2Y38d/NklFPqvPl5X552lZn9fSZGCM3TuOsD4D+1eL1WI1Xd8j9fXtzWyn69sbsXc+tXnCsipRQuMC1Sr5Ztzy452lrpbVVc7+4sDv3HCDODwby6ZSxqax5NPtR09sL5dKAAnZ9IrJJZQuEIP6fqcCfvFVjPz6a4ueL8j8YolkHG0CP2vI9qoK+ALtXz6PNv5VfIvn+FLZLjmPN1oGIOEeuyd3YcyjhBKVRp9oDIj3Q7HfNpznkuHZxEZ5+mJdFNjQi9h8Ml236837D2yx8c6t0zyDV2kfq8eBrkvdJ+emdz1Uyh7aNN8wJGVDqms/P/FvamtWkL4fEBt3jzbGsz7E/1mZGP8DJSweBw== +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 highlight"} +> +</Heading> + +<MethodEndpoint + method={"patch"} + path={"/highlights/{highlightId}"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Update highlight by its id + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"HighlightId"},"required":true,"name":"highlightId","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":{"color":{"type":"string","enum":["yellow","red","green","blue"]}}}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The updated highlight","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}}}},"404":{"description":"Highlight 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 |
