Skip to content

Commit d9ef832

Browse files
MohamedBassemMohamedBassem
committed
release(docs): release the 0.28 docs
1 parent 7339d1d commit d9ef832

File tree

88 files changed

+5308
-23
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+5308
-23
lines changed

‎docs/docs/api/attach-asset.api.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Attach a new asset to a bookmark"
55
sidebar_label: "Attach asset"
66
hide_title: true
77
hide_table_of_contents: true
8-
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==
8+
api: eJztVcGO2zYQ/RVhTg3ArnaLFA10c4oW3RZoF1kHPRg+jMWxxTVFMiS1tivw34Oh5JUde4McesxFkEaP5Lw3b4Y9SAq1Vy4qa6CCWYxYNwUWhnYFhkCxiLbAYmXttkW/BQERNwGqBbwfQwGWAgLVnVfxANWihxWhJz/rYgPVYpmWAhx6bCmSDxkQ6oZahKqHeHAEFYToldmAANpj6zSHFCmp94dNu3t694vd//dzs4/R1u84AxUz5JjBvYQkwNOnTnmSUEXfkQCDLYNWE0iAYo4OYwOcFa+gEN9beeBczpWYN3QiQJYFBNTWRDKR4eicVjUyvHwKvOYKMbt6ojqCAOetIx8VBf6r5CX5JCCfN8/RK9KYrmXdtTLbP2Krfx1TERBqT2RCY/kj7/F4GlmhMeTvW9wQCFh3Wj/ghma+btQzR56VJMu4UakZ75BTptrjTpOcsF0g/9Fpi5JYz85sjd0ZWKazAiyY4CmdZUoDIjhrwqDBT7d3r6iexSY5yP9d9NdFF7BWmv7ORr/M3XRa44o7hRvi2yr09vbtZVGOfVYYG4u17Yz8/4pSW3kl+SSgpRBYvMt/XxDJO0z4TCSvj42V3O425GO56ysoj4KHsp9GQyqzEoHrSv75OKc6r6GCHqX0FEIq0any+Y6rh16xtJnC+HvQbY2djlBBE6MLVVlGf7jZosctkbtB50Bcc/ywQ2HXRWyo+GvEF0MukFI6GbGPrOxw8umgfZGJT87+ZBgPwAxiq+WX361vkTP889951pIr9mGahL8dJ/DQMJOdTvrkoh0Sj9a15UUs3sDs7ub25vZkXL/Qmj3cX5Vh9nBfrK0/14A1SyJXscVsrXGwH6+qsXHOtusne37TlTawirSPpdOoDJ+Yi9+Pvlm8NCp7pDq7VEbrLAU0bLVqAX2/wkAfvU6Jw5868nwzLifjZHtJFfhdQrVGHegrHH74MBr+TfFaumMQzSH7U3f8BQK2dDi/BRPPjYZQks9ZDICxkj/mAk8bXLR2EscVs7omF7+KXZ604cM/j/M874bLts19Dx53IPIzJ2sz9+ztHOtBo9l0eQ7AsCdbFs8d/4XDM6urcvT9gJjbLZmUXtSJ/M3CpPQZ2d8imQ==
99
sidebar_class_name: "post api-method"
1010
info_path: api/karakeep-api
1111
custom_edit_url: null
@@ -54,15 +54,15 @@ Attach a new asset to a bookmark
5454

5555
<RequestSchema
5656
title={"Body"}
57-
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"]}}}}}
57+
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","userUploaded","unknown"]}},"required":["id","assetType"]}}}}}
5858
>
5959

6060
</RequestSchema>
6161

6262
<StatusCodes
6363
id={undefined}
6464
label={undefined}
65-
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"]}}}}}}
65+
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","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
6666
>
6767

6868
</StatusCodes>

‎docs/docs/api/create-a-new-bookmark.api.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Create a new bookmark"
55
sidebar_label: "Create a new bookmark"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: eJzVWN9v4zYM/lcCPntNOuzJb+lhw7pfV6wd9hD4gbGZWBdb8klyejnD//tASbWd1kmdazFsKFA4EilSn0jqoxrIyKRaVFYoCTF80ISWZjiT9DhbK7UrUe8gAotbA/EKbsKQgSQCQ2mthT1AvGpgTahJL2ubQ7xK2iQCTZ9rMvZGZQeIm2eGHnLq1p9ZNUudYYggVdKStKyBVVWIFFlj/smwWgMmzalEN1sUHzfOtD1UBDGo9SdKLURQaVWRtoIMy1lhC3IfXsxYLeQWIpB1UeCa56yuKYISv/xGcssbuF4sFm0EqNNc7CkbaK+VKggltBFscK94/6fmpbIjdtsITF2WqA+jcx6HbGlf99hJ42Nxp4Xyx/BSg2Rd8rkV6pH1lS6xgKRt26gBJWkagG72zNpC7iBpI6h1MSa3YasWYqi14C1WmpzflC09vrfZCBStDyChGd6Vn/UmEnb+bS5b+mKdy+5j9IxUrVP6a2xHJ1x7WvOtvqEx5J1zXw+viIsSt2y+yja90iiiEWxEQX9geSIqL95x719vNmn5r/UaplLS+F1/v7geLwIh4IfFZnIJOA+0GAfhTIa1EZQqExsxOQEnFpc31xKL262Q23uLtjav2+vDw9RpSsZwGqIoau1ChWTGWklXi8RXB/H7Lz9eA0fgOVkTx0B3l1EniFrjASIQlkrzzWEhT+UFWotpTtnN2QKLAiLI6xIll9fjdBEZhPWPVnNyg1j/d+rxRUF7lK4T5F0xGi0hp4SXp8rVWIykmkiaXNlLtDZ1UdyxJZ+Al6i+uKkuUd6LjNRFjuJepBOBzm1ZfOhD53Wi4GUvcedp59MMYG1zpaehWq8LYXKaJp2hpbugMc1x1vg9lPEJCv9dojHR1f818RhL8wsQicCIr8NlZV2uSZ9JgW+GeZztvBn1Wu6kehy5NZwCk6lg7v2vvEnHzLfJz4NqMyzDT0jcD0fWKCXp2xAdz6ovhLrIcoHwuZoEI8WWs/AUOO5K7f1P2lGBnuodEbsBGTtiXs9p1jg7CvyjD6jufJLuau36ZPBU+IfF4iX7vcFsFnrk9yO9qcrGaUxJxvCRvEru3Qq9vCPzTt/mKoMYKuX8rZAbZZivuxcBfhDQe9LGcRhHPqDBLNNkTDvHSsz313z+qAUnm3M3THtwNlgX3Cfm1lYmns+tPlztUOOOqLrCqoJopH8IK8zUZmZzmv0a5GfeF8Z/8FJxzyh6y8P3ig4StuwinMWYgTshDlb38dNTJ/vL3w8ONz6dP/tnjh+/YFkFahUCocunnv97Bj1k/H7Ec+Veo6PE/dCgdxkOHj0ChF4/7MiRwUAFe5XRFnwQLEJuFO+CT9NDfX21uFpAH+Adzsu729FzWd7dzjZKHx8KHyIzAGUsM+W4CbT75LvTMwLaJcnphyq/bb4T51WBwnVPgQj7kF3BeviIlXM4xytomjUavnXaloc/18TQr5I+YN27VgQ5YcbcZdXAjhjvUBm/C3fDHova1ejnWcx3hddYpilV9qxsMsi4u4/3D65g+oe00qU4aORj5v8xQATKgeRC2401UKDc1i7lwa/ZBp42bDGPA3zYfaA8DDxsGi/xoHYk2xaisBXLv8G1/P8ASqIDtw==
8+
api: eJztWktv2zgQ/ivGnLWxU+zJN6fYYrOvBpsUezB8GElji7VEqiTlxBX03xdD0pacSrHdBMUuYAQIFHGGM5znR01qSMkkWpRWKAlTeK8JLY1wJOlxFCu1LlCvIQKLKwPTOdyEVwYWERhKKi3sFqbzGmJCTXpW2Qym80WziEDTl4qMvVHpFqb1M0EPGe33H1k1SpxgiCBR0pK0zIFlmYsEmWP82TBbDSbJqEC3mucfl0603ZYEU1DxZ0osRFBqVZK2ggzTWWFzcg+ezFgt5AoikFWeY8xrVlcUQYFPf5Bc8QGuJ5NJEwHqJBMbSjvcsVI5oYQmgiVuFJ9/aF0q2yO3icBURYF627vm7ZDO7HGNHTU+5ndaKO+GbzlIVgX7LVePzK90gTksmghEUSpt78kYoeRt2q+nqnTSa7rdtlgKiOCRYnZczs+FikXOfqQnS5I3hwiMkKucln5BGwM7+bBomiaqQUk6zZdu9YVjCrl2x6t03ke3ZANYmEKlBZ+w1ORMSOnMu7rXEo2PZaHZ03O/6kUsWPnXqWzpyTqV3cOwGz71nWhAtd2er9UNjSGvnHt6OEIuClyx+DJdtkwDscXB8BcWAwly9olb/Vqxi4Z/Gs9hSiWNP/W7yeRIPcJcE6bbET0JY805Relle4t+W7yQ8w1nVCqW4uSScGK5e3V1s7haCbm6t2grc1xeGyWmShJyNWCJIq+0ixiSKXMt9tVRfHUmfvvt+6tyj3kGq3Qf7WClHFLzDSrnrivvhaLWuGUKS4X57miUQ1mJ1mKSUXrzYqdBPktWFSi5uB8mq0gh7H+wm6PrpNiP6QZn5cpBsTiB3pXC3gI2RDwbKpZ94ZZoImkyZc/hWlZ5fseSfN6fw/pNnzyHeSNSUmcpihuRnGjozBb5+zZ0jiMmT3uOOruTnyYAK5spfZpVqzgXJqPTqFO0dBc4TlOcOf4M3eMEhv8uzDlR1f817BnsKqdWESO+dreVVRGTfiEFvtvM/Vjr1Vav5Fqqx56u4RgYygVxb9/yTnIzd5NfO9WmW4Z3lrjvvolRStK3ITqeVV8IdZHpAux0NQl6ii1noSH9qcwVpsQ9tLXVWSHV147bsy+aXoIWnR5g0Q5+PACLz5FhP6AL2KUNxr1vF/u2vP/YAB7Ev5tcH8HtK2XDh4T0AtovoP0C2i+g/QLaL6D9AtovoP0C2i+g/QLafzxo/7nvY/sNpqMwHXw7nJ6otB8CFWQMu/PoLMHt0NK72YHjt5lKYQqlcvqWyCNCGMf7WSiPQvWGtHH4xwEXqDFNNRnTjLEU4801xw5qwY516oZlb5wlVjmPpTJrSzMdj63eXq1R45qovMKyhKjn2hN2GKnlyGY0+j3Qj7wubP/OjPaeregldye1e5OwZJcdTMaXBkfEge4ePuwGZ7/98+Dsxt75ux3w/vKERRlgWQiEfTy3VxaPpruXFP/Gw/uWY4/i21ed61b35cH4M0w5vxltdjYOkD8g+XB2BzkD4Gxpe2eDnbAScqn4vOx375Trq8nVBNpU2Htkdnfb68HZ3e1oqfSh+9jdjDOUsYzHp3UA94Oz+Wcwd59Ow8N8f2zuvOMyR+GuhgFu++CeQ9wd9Gcc+NM51HWMhntb0/DrLxWxk+aLNrTd7D+CjDBlhDSvYU3smVB/fwodaIN55d3wLN+5I3mOWZJQaV+kXXRy8+7j/YMry/6fDQpXDEAjBwT/ngJEoJyRXBK4dzXkKFeVKw7g92wCGuzenw9ToXvHQbntaFjXnuJBrUk2DUThKJb/BjeL/Bepno+R
99
sidebar_class_name: "post api-method"
1010
info_path: api/karakeep-api
1111
custom_edit_url: null
@@ -54,15 +54,15 @@ Create a new bookmark
5454

5555
<RequestSchema
5656
title={"Body"}
57-
body={{"description":"The bookmark to create","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"title":{"type":"string","nullable":true,"maxLength":1000},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"note":{"type":"string"},"summary":{"type":"string"},"createdAt":{"type":"string","nullable":true},"crawlPriority":{"type":"string","enum":["low","normal"]}}},{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string","format":"uri"},"precrawledArchiveId":{"type":"string"}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["type","assetType","assetId"]}]}]}}}}}
57+
body={{"description":"The bookmark to create","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"title":{"type":"string","nullable":true,"maxLength":1000},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"note":{"type":"string"},"summary":{"type":"string"},"createdAt":{"type":"string","nullable":true},"crawlPriority":{"type":"string","enum":["low","normal"]},"importSessionId":{"type":"string"},"source":{"type":"string","enum":["api","web","cli","mobile","extension","singlefile","rss","import"]}}},{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string","format":"uri"},"precrawledArchiveId":{"type":"string"}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["type","assetType","assetId"]}]}]}}}}}
5858
>
5959

6060
</RequestSchema>
6161

6262
<StatusCodes
6363
id={undefined}
6464
label={undefined}
65-
responses={{"201":{"description":"The created 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},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"contentAssetId":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","tags","content","assets"],"title":"Bookmark"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
65+
responses={{"200":{"description":"The bookmark already exists","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"]},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"contentAssetId":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","tags","content","assets"],"title":"Bookmark"}}}},"201":{"description":"The bookmark got created","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"]},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"contentAssetId":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","tags","content","assets"],"title":"Bookmark"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
6666
>
6767

6868
</StatusCodes>

0 commit comments

Comments
 (0)
⚡