diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-07-20 13:24:58 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-07-20 13:24:58 +0000 |
| commit | 0cd9eea0da130ea855c0e63fb8e0de717c8336e0 (patch) | |
| tree | c4118d290c44cbff80f37adc95ac311620c77550 /docs/versioned_docs/version-v0.26.0/API/attach-asset.api.mdx | |
| parent | 705e46dc6caa7c84de7458bb2f43f619d5d100ca (diff) | |
| download | karakeep-0cd9eea0da130ea855c0e63fb8e0de717c8336e0.tar.zst | |
docs: Release the 0.26.0 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.26.0/API/attach-asset.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.26.0/API/attach-asset.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.26.0/API/attach-asset.api.mdx b/docs/versioned_docs/version-v0.26.0/API/attach-asset.api.mdx new file mode 100644 index 00000000..689300db --- /dev/null +++ b/docs/versioned_docs/version-v0.26.0/API/attach-asset.api.mdx @@ -0,0 +1,71 @@ +--- +id: attach-asset +title: "Attach asset" +description: "Attach a new asset to a bookmark" +sidebar_label: "Attach asset" +hide_title: true +hide_table_of_contents: true +api: eJztVUGP0zoQ/ivRnB6S2ewiECi3gkAs7/BWbJ84VDlM42njbWIb29m2RP7vT+Okm5YWBNI7comSyefxfJ+/GfcgyVdO2aCMhgJmIWBVZ5hp2mboPYUsmAyzpTGbFt0GBARceygW8HYMeSgFeKo6p8IeikUPS0JHbtaFGopFGUsBFh22FMj5BPBVTS1C0UPYW4ICfHBKr0EA7bC1DYcUKdns9ut2+/Dmtdl9e1XvQjDVG65AhQQ5VHArIQpw9LVTjiQUwXUkQGPLoOUEEqCYo8VQA1fFK8iHt0buuZZTJeY1HQmQZAEBldGBdGA4WtuoChmeP3hec4GYWT5QFUCAdcaSC4o8/1XynHwUkPabp+gFaXTXsu6N0puPoW3ejaUI8JUj0r42/JFy3B9Hlqg1udsW1wQCVl3T3OGaZq6q1SNHHpUkw7hRqRlnSCVT5XDbkJywnd5os9VQxhPFF8zouP4yxgHhrdF+IP3i+uYHMid1SQ56/1H5d1V+ef3yXNhDc2TahGxlOi3/P2ErIy+IFwW05D0LcP7vOyIpw4RPRNL6UBvJPWp82pZbtYD8IJrP+6mfY56U8Hw25B4Pw6VzDRTQo5SOvI85WpU/3vAJoFO4bAYK4+9BtxV2TYAC6hCsL/I8uP3VBh1uiOwVWgvikmuHDJlZZaGm7O8Rnw21QIzxaC7es7LDzsfT8Ukm3jl5jGE8tRKI7ZJePhjXIlf46cs8ackn9nkaX+8PY3Mw/WTnI6+fWTryPFwZXsTiDcxurq6vro9m7BOt2d3tRRlmd7fZyrhTDVizKNIptpisNU7jw/0ymv8kXT/Z85fuoYFVoF3IbYNK847p8PvRN4unZmOPFCc3wWidUkDNVisW0PdL9PSva2Lk8NeOHF9n5WScZC+pPL9LKFbYePoJh78+j4Z/lv2o3DGIep/82XT8BQI2tD+9umIZBdSEklyqYgCMJ/k8HfCU4Ky1ozismFUV2fBTbHnUhnf/3M/TzBpuyDb1PTjcgkjPVKxJ3JO3U6yHBvW6S3MAhpxsWTx1/HcOT6wuytH3A2JuNqRjfFIn8DcLE+N/AisISA== +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={"Attach asset"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/bookmarks/{bookmarkId}/assets"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Attach a new asset to a bookmark + +<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 asset to attach","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"The attached asset","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}}},"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 |
