diff options
Diffstat (limited to 'docs/versioned_docs/version-v0.28.0/api/summarize-a-bookmark.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.28.0/api/summarize-a-bookmark.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.28.0/api/summarize-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/summarize-a-bookmark.api.mdx new file mode 100644 index 00000000..23bd3d61 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.0/api/summarize-a-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +id: summarize-a-bookmark +title: "Summarize a bookmark" +description: "Attaches a summary to the bookmark and returns the updated record." +sidebar_label: "Summarize a bookmark" +hide_title: true +hide_table_of_contents: true +api: eJytVU2P4zYM/SsGT1tASLLFFrvwLT0UmPbQQWeKPQQ50DYda2JLWonOJGvovy8o53PG285hTnFEinx8fKQGqCiUXjvW1kAOS2YsGwoZZqHvOvSHjG3GDWWFtdsO/TZDU2WeuPcmJEPvKmSSs9L6agYKGDcB8hX8frwSYK0gUNl7zQfIVwMUhJ78sucG8tU6rhU49NgRkw/JIZQNdQj5AHxwBDkE9tpsQAHtsXOtHGnSVbs/bLrnpy+f7f77b82e2ZZfBIHm5HJCcFdBVODpW689VZCz70mBwU6ciouTAi0sOOQGBJWn4KwJFATJr4uF/NwS9njFwJmiZ83NiT9QUFrDZFguo3OtLlEuz5+CRJio1RZPVDIocN468qzH/Lp6zUdUUHqS7EuetHa20rWeNiswfdtiIVQJI/FM3Bs80ZeN3tE1psLaltBI2hp3Vtr9MzvjZqPN5oGR+/D/+RSQ6TvRVOjLkkIASaHb3pPQRKaSW+uoYGRdf08Uv394Y/lt9Jy6/yZf2/vyDWEvMNFpUPBMhairle/OFrqlNB9MJog4FQRtNi3Vo8GnsnTnrGdYx5t5WIm4rqV0I5yrZt909mUbp9lfxyjJPi0+vZ6e03xmxnJW295U7zcupa0mOJWRoBBwM2V7wUmKcPFPhaT73NhK1oQNKa1sixzmp/EP8+GyUuL8xImECuR3pxXX+xZyGLCqPIUQ5+j0fPcRFOzQa2l6quJoHqmrsW8ZcmiYXcjnc/aH2RY9boncDJ0DNbGdjhEyW6d1/dfRPxuxQIzxajs/CLlj5usdfWZKMksdyU1GOjmBOn78YX2HgvDPr4+JTm1qK9el6hHSx9litrha0Wc8y/u7SfzL+7ustv4WvBQbVepAh0kWx2X+cGI7w/M+fhl2uEjsnR68kRymPc9dizqtuNTf4aiO1fmVkTHJb56ci0DWChrRVL6CYSgw0L++jVGOv/Uky2S1vsgjiajSQb4ryGtsA/1HoR/+OSr7l+xniI+HaA5JhW0v/0DBlg63z2SUVdgQVuQTitFhWZbk+Orqq+kVpZ2n5/7vh0dZLbcCeyGoFH4S1zCMHo92SybGM0yW/4Iwxh/uYBE2 +sidebar_class_name: "post 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={"Summarize a bookmark"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/bookmarks/{bookmarkId}/summarize"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Attaches a summary to the bookmark and returns the updated record. + +<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={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"The updated bookmark with summary","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 |
