docs: Replace the OpenAPI rendering library

This commit is contained in:
Mohamed Bassem
2025-04-13 15:41:24 +00:00
parent 98ac31c30e
commit 969e774ac0
40 changed files with 7071 additions and 2068 deletions

View File

@@ -0,0 +1,72 @@
---
id: add-a-bookmark-to-a-list
title: "Add a bookmark to a list"
description: "Add the bookmarks to a list"
sidebar_label: "Add a bookmark to a list"
hide_title: true
hide_table_of_contents: true
api: eJzNVE1v2zAM/SsCTxugxenQYYVv2WFYh2EothQ7BDkwFhOrsS1Vkttkhv77QNn5arPuMgw72ZYfxcfHR3agyBdO26BNAzlMlBKhJLEwZl2jW3sRjEBRaR9AQsCVh3wGX7QPHuYSPBWt02EL+ayDBaEjN2lDCflsHucSLDqsKZDzCeCLkmqEvIOwtQQ5+OB0swIJtMHaVnykSatqs13Vj3dX783m57tyE4Iprji7DgnC2a8VRAmO7lvtSEEeXEsSGqwZUPUACZpLshhKiPKvpf8wSPMihcUBdEJjzhHemsaTZyZvx5f8OG3CVyMK0wRqgnhz0g3xiF6gUpRSX47Hz2N37ARWjlBthW523Rvu5Bi0ttIFckx25znwjDxmcUcFB1pnLLmge8qFUfRcxCihJu9xde7fiU6z/oYDfh5jTOWckYJ7LYw7KNCYIJambdT/XlCKD6VR3Ps2ZWUH5JBxO3zW9S6N2X7Usu7gmgg8XO5hNzqtqyCHDpVy5H3M0Ors4QIkPKDTuKj6SobfvYxLbKsAOZQhWJ9nWXDbUWnQKXIjtBbkE6mnJYnhAmGWyXcDXPRMIMZ4NPPfWd4+7/Hk77XivFxFgvFIJBDI4eWjcTUyv88/pklQ3SwNh3PNPaOL0Xg0Ppq8TwOdyc31WfaTm2uxNC5R32G50ijBGh9qTLYYJpQ3HR58dbzmTm7uDjb703bs6w60CZmtUDecODWuG3o/S6vJg4R8v6P2d/Hp0dqYSyiNDxzUdQv0dOuqGPn4viXHG3d+6H7yiNKe3xXkS6w8vVDHq2+DeV+L3/EeDrHZJpNVLX+BhDVtDxuWt+o/zHqkTpxHCSWhIpdq7wGToiAbjkKfrQU28H4sb26nIAFPbfvEpun2s7S6rkdMzZqaGPcsA38zwRh/AdhohEQ=
sidebar_class_name: "put 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={"Add a bookmark to a list"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/lists/{listId}/bookmarks/{bookmarkId}"}
context={"endpoint"}
>
</MethodEndpoint>
Add the bookmarks to a list
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"},{"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={{"204":{"description":"No content - the bookmark was added"},"400":{"description":"Bookmark already in list","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}},"404":{"description":"List or bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
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: eJztVcFu4zYQ/RVhTl2AjZJiiy508y5aNL002LjowdBhLI4txhKpJanYrsB/L2Ykx/LGG+yhx14EafQ4nPf4ZjiAplB500XjLBSwiBGrOsPM0j7DEChm0WWYrZ3bteh3oCDiNkCxgo9TKECpIFDVexOPUKwGWBN68os+1lCsylQq6NBjS5F8EECoamoRigHisSMoIERv7BYU0AHbruGQIaObw3Hb7p8+/OIO//xcH2J01QeuwESBnCq415AUePrSG08aiuh7UmCxZdD6DFJgmGOHsQauildQiB+dPnItl0osa5oJILKAgsrZSDYyHLuuMRUyPH8KvOYKMbd+oiqCgs67jnw0FPiv0a/JJwWy31KiV6Sxfcu6h8oT2VA7TisrHueRNVpL/r7FLYGCTd80D7ilha9q88yRZ6PJMW7SZcEZpECqPO4b0mdsb3fW7S2U6ULfFdc/r7ZMaUSEztkwUvzp9u4booqWpEd1/9f0bU3f375/LePJ+Jl1Mdu43ur/TsbK6StSJQUthcACvP73FRHJcMYLEVkfa6e5/1yQbbkNC8hPooV8OPdqykWJADxa/PNpcPS+gQIG1NpTCCnHzuTPd3wC6A2um5HC9HvUbYN9E6GAOsYuFHke/fGmdug1+RvsOlDXLDomyNwmizVlEzwbK4GU0mziPbKu477zufciEu/LLATG80hAbBZ5+c35Frm+P/5eipJ8Xp/Pg+nX00AcDX627szXc/smHnIbx3hWbeR0d3N7czsbnL9PhBYP91f5Lx7us43zQv6EZa2SksNrURw1DdjTlTF5/iLbcHbld10tI51Ih5h3DRrLO8qZD5NdVi89xtYoLob75JhSQc0OK1YwDGsM9JdvUuLwl54831Dl2S/iKm0Cv2soNtgEeoPDD58nn7/LvlXuFER7FFs2PX+Bgh0dL2+jVCYFNaEmL1WMgE/jXj/KyZ4TvOropE4rFlVFXXwTW8667+HPx6WMqvHSa6XdweMelDylWCfcxdQSG6BBu+2l/WHMyV7FS6t/ZW1hdVWOYRgRS7cjm9KLOpG/WZiU/gXqgvfh
sidebar_class_name: "post 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={"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":["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":["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>

View File

@@ -0,0 +1,72 @@
---
id: attach-tags-to-a-bookmark
title: "Attach tags to a bookmark"
description: "Attach tags to a bookmark"
sidebar_label: "Attach tags to a bookmark"
hide_title: true
hide_table_of_contents: true
api: eJytVU1v2zAM/SsGTxugxenQYYVv6bBh2WEr2gw7BD4oFhOrsS1Xottkhv/7QPkrWbKiGJpDYMtPFPn4+FSDQpdYXZI2BUQwI5JJGpDcuIBMIIOVMdtc2i0I4EWIlnDdLTmIBThMKqtpD9GyhhVKi3ZWUQrRMm5iAaW0MkdC6zzAJSnmEqIaaF8iRODI6mIDAnAn8zLjJY1aZbv9Jn+6v/podr8/pDsik1xxBpo8pM9grqARYPGh0hYVRGQrFFDInEGrESRAc3GlpBQ4K96Bjq6N2nMuxxQsUhzr93RMQEBiCsKCGC7LMtOJZHh473jPmcLM6h4TAgGlNSVa0uj8V8/hgJLWyj2nR5i7F+2eq1P2Gt+b777sk2/8O+Ro2eYQ9+uuNIVrw7+fTs/TkWlHgVl3dKBifgKt3Ovx0kd+ATf/J5mFp+6Ei+Hcjo/L6eUpBb3cgsJQsDZVoV6v8MSoc10TkKNzcnO2o8cl+AgjPu46niOlRrHqjfPHsvgjCPuxcGE9TkgTelHwONvHflgrm0EEtVTKonNNKEsdPl6AgEdptVxlXefazy1ra1llBBGkRKWLwpDsfpIaaRXaiSxLEGfE1QVgfVGKQQcP2ky4Ywcuc8estucees1AEZ/LVXgYe4AHgegevhibS87v26+F55G7dTuawedeUf2gLoeZG2U3jNrQkLhhg1kb3sfstbVdTKaT6YECv3aFzW7mZ3mY3cyDtbGehB7LnDXCtzCXXleduT3n00eh61Goz5t7SyDhjsIyk7rgc70C6k46y8FRWSjRkb22liIgZa1FS6jrlXT402ZNw8sPFVq+IeJRO55bpR0/K4jWMnP4TOpvbjvFvw3+lWxvG8XeSzSr+A0EbHF/fBv4fqUoFVqfRQv41J71bsFhxgAns92IfscsSbCkZ7HxwRze/LhbsBK7Syf3gw9WPoHw/z5Z42v3AvdrNWSy2FTeCKCNybqVx7L/S+atbs/RUdctYmG2WDTNwA7xOxPTNH8AhR3GGA==
sidebar_class_name: "post 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={"Attach tags to a bookmark"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/bookmarks/{bookmarkId}/tags"}
context={"endpoint"}
>
</MethodEndpoint>
Attach tags 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 tags to attach.","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"tagId":{"type":"string"},"tagName":{"type":"string"}}}}},"required":["tags"]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The list of attached tag ids","content":{"application/json":{"schema":{"type":"object","properties":{"attached":{"type":"array","items":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"}}},"required":["attached"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: create-a-new-bookmark
title: "Create a new bookmark"
description: "Create a new bookmark"
sidebar_label: "Create a new bookmark"
hide_title: true
hide_table_of_contents: true
api: eJzVWMFu4zYQ/RVjzmzsFD3p5iy6aIq2GzQpejB0GEtjixuJ1JKUs66gfy+GpC3FkRO5WRQtAgSyOEMOH98M36iFnGxmZO2kVpDAB0PoaIYzRU+ztdaPFZpHEOBwayFZwU18ZSEVYClrjHR7SFYtrAkNmWXjCkhWaZcKMPSlIetudL6HpD1Z6KGg4/wzp2eZXxgEZFo5Uo49sK5LmSF7zD9bdmvBZgVV6EfL8tPGL+32NUECev2ZMgcCaqNrMk6SZTsnXUn+IZhZZ6TaggDVlCWuecyZhgRU+PUXUlvewPVisegEoMkKuaN84L3WuiRU0AnY4E7z/s+NK+1G1u0E2Kaq0OxHxwIO+dK9HXHXdaIFrWgaDH705ZykmopPtpTqEdJOQGPKMbuNNhU6SKAxkgOtDWUGn0rKlwGl23xkQ12ggTQM0iqMhiVSDv59ITv66nzI/mEUad2YjP4Y29GZ0A5zvjc2tJZCcP7p4Q1zWeGWl6/zTe80iqiAjSzpN6zOcOviHffx9cumHf91wcPWWtmw6+8X1+OpHGk7LBmTE/l1oOU4CK/kSSeg0rncyIlpJKaWiHdXBIfbrVTbe4eusVNK0oEetskyspbTEGXZGE8VUjl7pWdLzUj8Z0vPGCq+5h8N0RjcgwDpqLL/+NzUOeKic5gVlN+MBndMKwkCiqZCBekpn2UOcf5ns3m7ARn/nYJ5Eaue5dMEe18tRnP8nPHyXD0Z40hmiJQttLvEa9OU5R2vFDLkEtcXV8klzjuZk74oUNzJbCLQhavKDz113rQ/bGOaNTau0GYaRM26lLagadY5OrqLHtNAYY9fY9Gcojz+s9f6xFD/19f8WM5egIgAK/8aTquaak1mlM+TuX+Jtng36o16VPpp5ArwDixd4nLf/v6adMx9BT3s+374Zo1KkbmNXDgpnBBLGttFMeWrG4zUSc65c1D427CPNu1GDXoZ9Uw0DYTOM1VzKmGiSOiJcsQ9Pd5/x54RgqD8YbF4qSFvMJ/FfvHbScdM5+NaoyJrGfw3JbKfobf3ktj7u0LnkECtfbw1ctMI8/WxO+bm2OzIWC80vEKAFvPckLXdHGs5313zSaORnEQ+3DgcwNlgU3K3VThX22Q+d2Z/VWg0OZkrrGsQIyI8TjDTm5kraBbNZyESRn/Qs98zhmHdYed+BITX5V14M1ax3ohJ6R8+HrrBn/988Kjx2fzeN/w/fsWqjuon0uCYJb2GDiJ3qJrDmyBne4+jau1fDfR//zLG7pVZ1GX94GjDOiCFVBvN8fKpBUyvrxZXC+iJ/FMEdHl3O4r/8u52ttHGg3+w5bPi+1tbx6I1aaMCPvul5UQLHlPh/KeZsGm+0eZ1idJ3GlGTBmKuYD38bFMwaZMVtO0aLd8ZXcevvzTEEK/Snpb+S46AgjBn5bFq4ZH4FKIk+i5W9h2Wja+wp7nKlT54LLOMaveqbTrIq7tP9w++AIZPR5VPZDD4BML/TwAEaA+Sp7B/10KJatv4xIYwZxdV1rAde07kYSOAaj+IsG2DxYN+JNV1IOJWHP8G3x7/DcCdo/I=
sidebar_class_name: "post 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={"Create a new bookmark"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/bookmarks"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new bookmark
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
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}}},{"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"]}]}]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
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"]},"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},"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":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","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"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: create-a-new-highlight
title: "Create a new highlight"
description: "Create a new highlight"
sidebar_label: "Create a new highlight"
hide_title: true
hide_table_of_contents: true
api: eJztVj1v2zAQ/SvCzaztFJm4OUWLpkuCxkUHQ8NZOluKJZIhqSSGwP9eHCVHsqMEHTJ06Gbrjvfx7t0jW8jJZbY0vtQKJHyxhJ4STBQ9JUW5K6pyV3gQ4HHnQK7h+/Gbg1SAo6yxpT+AXLewIbRkl40vQK7TkAqw9NCQ81c6P4Bsz1KtChoyJF4nWcwNAjKtPCnPR9CYqsyQj8zvHZ9rwWUF1ci//MEQSNCbe8q4SGO1IetLcmzdaL2v0e6v85Gv87ZUOwgCnEfrb7ZbR35kV029Ict2Uvk71kxX2r6Oy8eamoE6UFXpJ2AQchCws0QKBGyqhhi5nLbYVB7k0TEI8PTsp0KqpqpwUxFIbxsKApT29BeOoZtAyRXI9RiP0+7HvfZV9DnSELoozmjlOlg/Ly6mh9nNLz+hzf9RfswoBZTTrTeO7Buo9PNYThTyAdSIFb3kH2dLBfjSc+mDWkBHpMvF4jV3rnDEmaTXjI/jTqbzCYSDgJqcw92U7QydGGHwT4+9XE700gOZKO2TrW5U/q83Es/7QucgwegIvEGWcJgXg9az1NtHsi4qfWMrkNBinltyLszRlPPHCxDwiLZk1sZ6e3MH0nFFCu+Nk/O5t4dZodHmZGdoDIgJQekDJHqbeL4sOvekq4QZNbqB7hjEXixG99ALIpyXu4huIHsn3uL445u2NXJ9P36vImw8nJ/D9fX1GWtT0bkWDft6IkGLE8lZvEjMoCSdPozWPcrAaKal2mrOxph3iFzMFrMFjHarh2N5ez2J3vL2OtlqG6E7+jLSQcQ51xjJpzDC8ea9fxK3Haj8zkuhA5w7nJsKSxVlihnT9sxaQ3HyiiiYdnINbbtBR79sFQJ/fmjI8ssiHXgVHxYCCsKcbKTing5cTFfWpxXnZneWZvl624I4nlhmGRn/rm862ozbm7sVk6V/ydRxFcFivBXwCSSAAB1hihyM31qoUO2auJrQxWRq4Skzz5gYu+pNqA6jCtu281jpPakQQPSteP4Pgbf5D3zOXeg=
sidebar_class_name: "post 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={"Create a new highlight"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/highlights"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new highlight
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"description":"The highlight to create","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}},"required":["bookmarkId","startOffset","endOffset","text","note"]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"201":{"description":"The created 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"}}}},"400":{"description":"Bad highlight request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: create-a-new-list
title: "Create a new list"
description: "Create a new list"
sidebar_label: "Create a new list"
hide_title: true
hide_table_of_contents: true
api: eJy1VU1v2zAM/SsGz1o+hp58S4sN61BgxZphhyAH1mZitbakSnLbwNB/Hyg7sZN6KQZ0F8OSSJF875FqICeXWWm81ApSuLKEnhJMFL0kpXQeBHjcOkhXcCOdd7AW4CirrfQ7SFcN3BNasovaF5Cu1mEtwNJTTc5f6nwHaXMSYFlQvDfxOsliMBCQaeVJebZGY0qZIVtPHxy7NOCygirkP78zBCno+wfKODVjtSHrJTk+VVjRwMp5K9UWBFRS3ZDacoZzARW+7lcXsyCO8zvrPDtyns/YW2ZjbkF0G2/vI1VXjGaFqsYSBLgKrWdYc9pgXXpI92dBwFNNdvdeTUGAQUvKX+djpqouS7wvCVJvawqhZUhayjmPCFpXxzqE9tgZrVwL6ufZfJzFlr18r5IP4lCOlBDEX6h9n72T2s/w9Q8I/ndyzzMmcxBHtA2SXwvw0rNnbFdoCb2Yzd5yeIl50rXqx9GX6Xycp4qcw+3Y2Ul18YbePkoy+vtC55CC0TFfgyx9mJZxKPFMss9kXRxJtS0hhQbz3JJzYYpGTp/nIOAZrWRcY6rdcQvMnpzCe+PS6dTb3aTQaHOyEzQGxEgDdBckepP4gpLOPGkzYeQHo/KO8WvjDgfmAQyOy1VEM0g7IxDdz1dtK+T8vv9eRsSYl5/9nP3yipUpqR+CvZaO8z5st33Qr7s8DsLttNkb9P0xYFWqjeagDH0bYD6ZTWbQq/Bbh8ri9noUxMXtdbLRNiK4t2XAuSO18xWqQVFjr9PJADjoePwpa6v09OqnpkSpOE6US9MpagXl/pkrWGnpCprmHh39smUIvN0hs1r3eoovn4CCMCcbJfhIDN5Vm8ynJYdl87Lm8G8aLIi9xyLLyPiztutBM9z+uFuySLqntordBxZfQMRvCiBAR3Ci9uJeAyWqbR27Edo7WVJ4rMgTBcaquiNUu0GGTdNaLPUjqRBAdKV4XkPgBv4D5V7dCQ==
sidebar_class_name: "post 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={"Create a new list"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/lists"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new list
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"description":"The list to create","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","minLength":0,"maxLength":100},"icon":{"type":"string"},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","minLength":1},"parentId":{"type":"string","nullable":true}},"required":["name","icon"]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"201":{"description":"The created list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true}},"required":["id","name","icon","parentId"],"title":"List"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: delete-a-bookmark
title: "Delete a bookmark"
description: "Delete bookmark by its id"
sidebar_label: "Delete a bookmark"
hide_title: true
hide_table_of_contents: true
api: eJx9U01v1DAQ/SvWnEAymxYVgXJb1CKKEKpgEYdVDk4yu3E3iV170m6I/N/RONmvdmku8ccbz5s3bwYo0RdOW9KmhRSusUZCkRuzaZTbiLwXmrzQJUggtfaQLuHzdOkhk+Cx6JymHtLlADkqh27eUQXpMguZBKucapDQ+QjwRYWNgnQA6i1CCp6cbtcgAbeqsTUfadRlve3XzdP9p49m+/dDtSUyxSdmoClCdgxuSwgSHD502mEJKbkOJbSqYVB+AEnQXJxVVAGzcuitaT16ZvL+4op/pzr8MKIwLWFL4p2g6kiRJ+VFGVWKya/ORe/4idaQWJmuZQrTe4xW1ta6UIxO7j2HnJHG5PdYEEiwzlh0pEe6hSnxpYBBQoPeq/W5uxONluMLB3wW+OM9VaaEFMbqODHrlUKyq90nw0HUANx897hrbedqSGFQZenQ+5Aoq5PHS5DwqJxWeT2yn65HyVaqqwlSqIisT5OEXD+rjHIlupmyFuQzWRcViukBYVaxLRNcjEwghHDkyV8s6Zj32Jl7fTgvVxFh7JgIAjktvhjXKOb37c8iiqjbleFwrnlkdDm7mF0cGfPrRGd+d3uW/fzuVqyMi9R3WK40SLDGU6OiFSYDT7Oo9t57/uRw8NTrgzuWS7ilxNZKt5wv9muYerzcT4sHCenR6GQSKuOJIcOQK4+/XR0CHz906Hjss0OLoxFK7XldQrpStcdXOL/5Obnyrfgfy+lQtX10Ut3xDiRssD8d8ZAFCRWqEl1kMQLmRYGWjkJfTB77Ze/865vvN4sbkKBOjfLMGDHBWWbDMCIWZoNtCHuixHvmGMI/Dwbc/Q==
sidebar_class_name: "delete 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={"Delete a bookmark"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/bookmarks/{bookmarkId}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete 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={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"No content - the bookmark was deleted"},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: delete-a-highlight
title: "Delete a highlight"
description: "Delete highlight by its id"
sidebar_label: "Delete a highlight"
hide_title: true
hide_table_of_contents: true
api: eJytVMFu2zAM/RWDpw0QknTosMG3AO2wDANWbB12CHxQLCZWY0uqRLfJDP37QNtJnNbtdtgpjvgkPj4+sgGFIffakbYGUrjCEgmTQm+KUm8KSlb7RFNItAIBJDcB0iV8PkQDZAIC5rXXtId02cAKpUc/r6mAdJnFTICTXlZI6EMLCHmBlYS0Ado7hBQCeW02IAB3snIlH2nUqtztN9Xj3ccPdvf7fbEjsvlHpqCphRwpLBREAR7va+1RQUq+RgFGVowqBigBmgt0kgpgXh6DsyZgYC7vZjP+OdfitsBEtXqokyAgILeG0BBfkM6VOpd8YXoX+NZIhXZ1hzlfdN469KS7nCtrt5X024V6rkYUEEh6+rZeB6RB3NTVCj3H0ahXorktrR9V2dQV93CPZWkfgXVgbTYe0YCAVVkjN1XhWtYlQXoARgGEOxp70tRlKVfcFhY/CjCW8J+Aerz0OqB/QZXcoyRU8xEi8cwHy6G+52oOteur6jm3jI75h9myEetBjJzzcnb53DtHUGIsJWtbG/X/nJNbNaJvFFBhCHIzFnuiTfvCCZ/FrpQKqbAKUuhsz4l5XFKYHv0fps1gqiJLi/7hMN21LyGFRirlMYQ4lU5PHy5AwIP0mlvf8u/DnWoHnxVELqTTKfn9pLDSK/QT6RyIkansH0jsOqECkx6edEy4LYO19INF7SdusJyOCnFerqKFQdqDeBTaj0/WV5L5ffl128qozdryda65Y3QxmU1mw93U05nfLEbZz28Wydr6lvoBy5VGAc4GqmRrhn6F9QtZnm2gszebk63+sr67gtnwU1dKbdpZ4441fZ+Xp40ZQEA63J+ZgMIGYlDTrGTAn76MkY/va/S8/bNTm1szKB34W0G6lmXAV2i/+d57823yEs/+UJp96yZeUymAgC3unyz6mEUBBUqFvqXRIeZ5jo4Gd58NIJvmOABX11+vb69BgDx3yxN3tAlGqTVNh7i1WzQxHpkS/2eOMf4BcaSP2A==
sidebar_class_name: "delete 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={"Delete a highlight"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/highlights/{highlightId}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete 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={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The deleted 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>

View File

@@ -0,0 +1,72 @@
---
id: delete-a-list
title: "Delete a list"
description: "Delete list by its id"
sidebar_label: "Delete a list"
hide_title: true
hide_table_of_contents: true
api: eJx9U9FO2zAU/RXrPm2S18DENOS3SjCNCU1o67SHKg9uctuYJrGxb6BZ5H+frhNogUJfGtvHPueee+4AJYbCG0fGtqDgAmskFLUJJFa9MBSEKUEC6U0AtYRrEyhALiFg0XlDPajlACvUHv28owrUMo+5BKe9bpDQhwQIRYWNBjUA9Q5BQSBv2g1IwJ1uXM1bBk1Z7/pN83B7/tXu/n2pdkS2OGd2QwnC7FclRAke7zrjsQRFvkMJrW4YUI8ACYaLcZoqYDUeg7NtwMAKPp+c8d/zun9aUdiWsCXxSVCFYmXtttF+Kx50EGVyJRGfHbvNukRrSaxt1zL99BYjtXO1KTQjs9vA8CN22NUtFgQSnLcOPZlRamFLfG1alNBgCHpz7OyZN8vxhT0+j/zjNVW2BAVjZUzMXinI2MGQDaOREbjR/v6xjZ2vQcGgy9JjCDHTzmT3pyDhXnujV/WoejoebVrrriZQUBG5oLKMfD+rrPYl+pl2DuQLKxcViukBYdepFRNcjEogxniQv99s5ch7mMInX5iXq0gwUBMI5PTxzfpGs74ffxfJPNOuLV/nmkdFp7OT2clBCL9PcuY3V0fVz2+uxNr6JP0Ry5VGCc4GanSKwBTYad50mriXzw37HL09mGOZhDvKXK1NyzypT8PU02WaigAS1DQeuYTKBuKjYVjpgH98HSNv33XoeaTzfUtT40sT+LsEtdZ1wHd0fvg1pe+jeEvdtKnbPiWn7ngFErbY70c45lFChbpEnxSMh/OiQEcH115NF2fjKd0Xl9eXi0uQoJ+H4kUIEsFRVcMwIhZ2i22MTyKJ16wxxv9jlcnF
sidebar_class_name: "delete 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={"Delete a list"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/lists/{listId}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete list by its id
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"No content - the bookmark was deleted"},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: delete-a-tag
title: "Delete a tag"
description: "Delete tag by its id"
sidebar_label: "Delete a tag"
hide_title: true
hide_table_of_contents: true
api: eJx9U8Fu2zAM/RWBpw3Q4nbosMK3AO2wDsNQbBl2CHJgbCZWY1uqRLfJDP37QNlN0jadL7LEJ/Hx8bGHkkLhjWNjW8jhimpiUoxrtdwpw0GZEjQwrgPkc5jJutAQqOi84R3k8x6WhJ78tOMK8vkiLjQ49NgQkw8JEIqKGoS8B945ghwCe9OuQQNtsXG1HBkyZb3drZvHu8vPdvv3U7VltsWlJDecIDNc35QQNXi674ynEnL2HWlosZE4p7gGI4U45AqEi6fgbBsoSP6PZxeyPK/5h1WFbZlaVh8UV6SW1m4a9Bv1iEGVSZGU9+LU7RmuVWtZrWzXSvbxKQGic7UpUIDZXRD0CS3s8o4KBg3OW0eezcC0sCW9VixqaCgEXJ+KPVNmPrxwwC+ifLLnypaQw1CYJBapcsikyVmfVIwgPfYPTx3sfA059FiWnkKIGTqTPZyDhgf0Bpf1wHkMDxqtsKsZcqiYXcizjP1uUln0JfkJOgf6pY4VqfEBZVepDyNcDUwgxnhkvV8i5JD32IB7VSSvVJFgkI8g0OPPF+sbFH7f/sySdKZdWbkuNQ+Mzidnk7Mj/30d6Uxvb06yn97eqJX1ifoTViqNGpwN3GAywGjWcdBQRu3la/3BRG8O5FAk05YzV6NpJUvqUj/2cz4MrYZ8mIuFhsoGlkDfLzHQb1/HKMf3HXmZ5MWhnanppQnyX0K+wjrQf0i++zn67r16i9t4iO0uuabuZAcaNrTbj25cRA0VYUk+ERhi06Igx0e3Xo2V2GJv66vr79eza9CAz/3wov8pwUlSfT8gZnZDbYwHjrIXjjH+AzX6w8U=
sidebar_class_name: "delete 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={"Delete a tag"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/tags/{tagId}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete tag by its id
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"},"required":true,"name":"tagId","in":"path"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"No content - the bookmark was deleted"},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: detach-asset
title: "Detach asset"
description: "Detach an asset from a bookmark"
sidebar_label: "Detach asset"
hide_title: true
hide_table_of_contents: true
api: eJy9VE1v2zAM/SsCTxugxe3QYYVvGdphHYah2DLsEPjA2EzsxrZUiW6TGfrvA/2RjzYrdhiWSyzpiXp8fGQLGfnUFZYLU0MMV8SY5gprhd4Tq6UzlUK1MGZdoVuDBsaVh3gOH4YtD4kGT2njCt5CPG9hQejITRvOIZ4nIdFg0WFFTM53AJ/mVCHELfDWEsTg2RX1CjTQBitbylZBRVZutqvq8e7yvdn8epdvmE16KQwK7iAjg5sMggZH903hKIOYXUMaaqwEtNiDNBSSokXOIeh/RmMqQr3IAQfEEYFE4N6a2pMXDm/PLuTvuBxfjUpNzVSzejNU5BG9yroqUaZ8k6bk/bIpy60QuDgVZNRJ1YbV0jS1MBnCChqtLYsUBR3deblyQhuzuKOUQYN1xpLjomedmoyeKxg0VOQ9rk6dHek07yPs8UmQn6w5NxnEkFFJLIhOthiisaI+avfFDVGnjo/aQewA4kr3MHqucSXE0GKWOfI+RGiL6OEcNDygK3BR9ukMx72GS2xKhhhyZuvjKGK3neQGXUZugtaCfqLzLCc1BFBmqTgnNcBVzwRCCAfN8l007t89bJmdYPKuZNHBxModCPTw8dG4CoXf55+zTtWiXhq5Ljn3jM4nZ5OzA6t+GuhMb29Osp/e3qilcR31ESuZBg3WeK6w88bg6nFUiN5Po7V7f/3NSOnzZdpwZEssanmwK1g7VH2+62MPGuKjpu4LL9tjnyUacuNZrrXtAj39cGUIsn3fkJMhlezr3rkjK7x8ZxAvsfT0Qjavvg3efa3+xHzYxHrb2atsZAUa1rQ9HkgyhP7jy6M8IQkacsKMXJd8fzpNU7J8cO/ZWBDv7try6vrL9exa5D827ROTdg+cpNW2PWJm1lSHsGPJshaOIfwG11pC+w==
sidebar_class_name: "delete 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={"Detach asset"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/bookmarks/{bookmarkId}/assets/{assetId}"}
context={"endpoint"}
>
</MethodEndpoint>
Detach an asset from 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"},{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"AssetId"},"required":true,"name":"assetId","in":"path"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"No content - asset was detached successfully"},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: detach-tags-from-a-bookmark
title: "Detach tags from a bookmark"
description: "Detach tags from a bookmark"
sidebar_label: "Detach tags from a bookmark"
hide_title: true
hide_table_of_contents: true
api: eJytVd9v0zAQ/leiewLJNB0aAuWtY0UUITSNIh6qPrjxtfGaxJ592Vqi/O/onKQ/aBkTWh+qxPl8vvvuu881KPSp05a0KSGBaySZZhHJlY+WzhSRjBbGrAvp1iCAlyGZwVW35GEuwGNaOU1bSGY1LFA6dKOKMkhm82YuwEonCyR0PgB8mmEhIamBthYhAU9OlysQgBtZ2JyXNGqVb7ar4vHuw3uz+fUu2xCZ9ANnoClA+gwmChoBDu8r7VBBQq5CAaUsGLTYgwRoLs9KyoCz4h3o6cqoLedyTMI0w5YBMpEKhAxAQGpKwpIYLq3NdSoZHt953nOmMLO4w5RAgHXGoiONPnwNHO5Q0jm55fQIC/+s3RN1yl4TevMtlH3yjX+HHM3aHOb9urem9G34t8PheTpy7Skyy44OVMxPpJV/OV76yM/g5v8kMw3UnXCxO7fj43J4eUpBL7eoNBQtTVWqlys8Nepc1wQU6L1cne3ocQkhwh4/7zpeIGVGQQIKcyRGBPknEPeD4eN6PyNNHGTBA+0e+nGtXA4J1FIph943sbQ6frgAAQ/SabnI2xK6zy1vS1nlBAlkRNYncUxuO8iMdArdQFoL4oy8ugCsMMow6uBRmwn37MBnvjOv7bmHbrMjic/lKgKMXSCAQHQPn4wrJOf35ec0MMn9ut3bwbjXVD+qs93U7YW3G7ZdS+YNW8zS8D5mr63tYjAcDA80+LkrbHQzOcvD6GYSLY0LJPRY5qwRYI2nQgZldfb2tFcfBa/3Yv2XxbckEm4otrnUJZ8dVFB38pntfJXFkhyZbGssAjLjiZF1vZAef7i8aXj5vkLH98R8r5/Ar9KenxUkS5l7fCL5V7ed7l9Hf0u2N49yG2SaV/wGAta4Pb4TQs8ylApdyKIFfGzPejPlMPsAJxPeiH7HKE3R0pPY+cE0Xo+/jqdj1mN3+RTBAMDJRxDhP6RrQvVB5mGthlyWqyoYArRRWb3yWPx/iL1V7zlC6rpFTM0ay6bZ8UP8ztQ0zW8i/clR
sidebar_class_name: "delete 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={"Detach tags from a bookmark"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/bookmarks/{bookmarkId}/tags"}
context={"endpoint"}
>
</MethodEndpoint>
Detach tags from 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 tags to detach.","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"tagId":{"type":"string"},"tagName":{"type":"string"}}}}},"required":["tags"]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The list of detached tag ids","content":{"application/json":{"schema":{"type":"object","properties":{"detached":{"type":"array","items":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"}}},"required":["detached"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: get-a-bookmarks-in-a-list
title: "Get a bookmarks in a list"
description: "Get the bookmarks in a list"
sidebar_label: "Get a bookmarks in a list"
hide_title: true
hide_table_of_contents: true
api: eJytV99v20YM/lcEPm2AEKdDhxV6c4qty7CtwZphD4YeaIm2Lpbu1DvKsWvofy94kiXZkRtlzVMc3Ufy46878gApucSqkpXREMEH4oAzCpbGbAq0GxcoHWCQK8cQAuPaQbSAP5VjB3EIjpLKKt5DtDjAktCSnVecQbSI6ziEEi0WxGSdB7gkowIhOgDvS4IIHFul1xAC7bAoc/mkSKX5br8uHh/e/WJ2X37OdswmeSfWFXuIWL9NoQ7B0udKWUohYltRCBoLAeQNIAQlLpXIGdThiHldFUuyp4pWmLuhpkLxUdHniux+XFPnyJHj+8o6803VSYM41R0L3pVGO3Ki/qfra/lzmqOPywdKOHhUnPnEBCkyXkEIidFMmkUCyzJXCYrE7MGJ2Ahr4xVBCKU1JVlWjdEu9wMoWot7IctUuOdVqPRpcOoQEkvIlM559LQwqVqp8eMQdJXnuJTgSq7rLtQTkGiTTG1pyGlpTE6oxewKt0aK+NI543qt9PoTI1fueXshkK4K6RJXJQk5B2JC5ZUlCRPpVKTiOgRteBp/VxUF2v20qPgWfeW8NSU7coDMmGSU3oySOwYCFYSQVQVqiOuTlliIxVb/iTaPG9Sz0fRx5S+RbzvQnF6mkiu98cGvbD7q0fSqOmnKCXhV4Jr+HTN7CTx3juQim1QjiSXSLjP8EqlVled3YqnpkJeIlpYSi485pf9DeKtSMi8iiluVTAx0xkX+vi+dZ/FHN6ahseLM2Gkhqpa5chlNQ6fIdNdKTAuKSPzVXpoTBM46z6ObRojlUfu+xmLasW8s/2Oss5ypbDKxAcapHm18L1eUwvNk/a/7Z+C+F8VIuuqFxupW6lTl9PfobTnWsy+ISAhOfRmqbYeXsXqeXPvjYe6D0vv6ClGv9Eabx5EnwAvEdRfa13+/JqW5v0GPfn8aflmi1mRv21o4uzihvdIE105P/naDkXtSeu5SKPxr2LON61FAP0adDE2DQedkqjkfYdohoS+ULu5xP8DetG6AMNC043aifXFR9dPkiZ6BqTtcKy0O3XTQ2jv+9vrt0+lXpv9AGw5WptLp6029iUnHZ5yCnJOkPz0789Rr6PGSvNrLc2ZSiGDd1IOsIxHMZHJ3s0Ozq9SzYZgc2e1xZ/JzChwwTS05V8+wVLPtG6k3tEqi7sm3x020VljlDBFkzKWLZjO2+6vMoE3JXmFZwtnoAvcZBa2CwKz8+tfCg4aJpGOw7H2SiLarwmDl68IjdsULD5NZ2oOkNfyP34wtUPj98d+9j6HSKyPi4nPD6M3V9dX1YJv6vaUzv7sdZT+/uw1WxnrqR6x4Km+wcSyDZ3Q4Ll6y4uKFBfdsputK67m9uHFc3qdZmaPye0M7YTb5XvilVJIbddtpn/I4hMw4FtjhsEQnb0Jdy+dmL5RCSJWTdPd75Ib2gw11i3klHPx+egHbrZw9OO4LadzKxYj88E9b+j8GlyJwvMP1fmizZ96s8XLvZ4SpjEmLQ3s4TxIqh349aW2h3rXWh1/voRnNhjvcad0Nt4dTSodDg7g3G9J13TFk+V8I1vVX803oZQ==
sidebar_class_name: "get 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={"Get a bookmarks in a list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/lists/{listId}/bookmarks"}
context={"endpoint"}
>
</MethodEndpoint>
Get the bookmarks in a list
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"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"]},"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},"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":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: get-a-bookmarks-with-the-tag
title: "Get a bookmarks with the tag"
description: "Get the bookmarks with the tag"
sidebar_label: "Get a bookmarks with the tag"
hide_title: true
hide_table_of_contents: true
api: eJytV01v40YM/SsGTy0gxNliiy50cxbtNgXaDRoXPRg+0BJtTSzNaGcoJ15D/73gSLJkZ7xRujnF0fDj8ZGcIQ+QkkusKlkZDTF8Ip5wRpOVMdsC7dZNHhVn/hPjBiJg3DiIFzCXv8sIHCWVVbyHeHGAFaElO6s4g3ixrJcRlGixICbrvIBLMioQ4gPwviSIwbFVWuzSExZlLp8UqTR/2m+Kx4cPv5inrz9nT8wm+SDOFXuROW5uU6gjsPSlUpZSiNlWFIHGQs7Zn0egJKQSOYM6CjjXVbEie2pnjbnrDeWqUNwZ+lKR3YctHcPoEH6srDPfNJ00Eqe2lyLvSqMdOTH/0/W1/DnN0efVAyXcJCZXjicpMl5BBInRTJpFA8syVwmKxvTBiVoAtfGGIILSmpIsq8bpMfcDUbQW9wKWqXAvm1Dpc3LqCBJLyJTOOHhamFStVfg4Al3lOa6EXEl1faR6hCTaJFM7GmJaGZMTanG7xp2REr50zrjZKL25Z+TKvewvAtJVIS3iqiQh50BcqLyyJDSRTkVrWUegDY/D76qiQLsfx4rvzzfOW1OygQNkxiSj9CYIriMCFUSQVQVqWNYnLbEQj639E2teblDPRtPntb9Cvh1Ac3oZSq701pNf2TwY0fiqOmnKEfKqwA39E3J7SXjmHPFtICWhGkkskXaZ4ddoras8vxNPTYe8RrW0lFh8zCn9H8o7lZJ5FVDcqWQk0RkX+ce+dF6U78IYJ40VZ8aOo6ha5cplNE46Raa7VmMcKaLxZ3tpjlA46zwv3TTCUh6172sspif2jeV/hDrLmcomIxsgDLXz8b1YUQrPg/W/5i+I+14UJ+m6VwrVrdSpyumv4G0Z6tlXMBKBU1+HZtvhJVTPo2s/THNPSh/rG7Be6a02j4EnwCss6yO1b/9+jUpzf4N2cd8Pv6xQa7K3bS2cXZzQXmki105P/naDwD0pPXeJCv8a9miXdVCgH6NOhqbBoHMy1ZyPMO2Q0BfKkfdlP8DetGGAIND0xO1E++qi6qfJEzsDV3e4UVoCujmK1j7w99fvn0+/c9xMtOHJ2lQ6fbuhNzFpeMQpyDnJ+fOzs0C9hV5ecld7fc5MCjFsmnKQbSSGqaRgevCLSj0dcuTI7rp1yQ8pcMA0teRcPcVSTXfvpNjQKqHcQ2+PG6rWWOUMMWTMpYunU7b7q8ygTcleYVlCdE5nRpPWwMSs/aLXik8aJJKLwZ53L3y2e8Jg2zuSI34lCi8mg7QXkr7wP34ztkDB98e/c8+g0msj6hJzg+jd1fXV9WCV+r2FM7u7DaKf3d1O1sZ66J2sRCoPsHEsU2d86LYu2W/x8nZ7NtMda2vEXtyEL0/UtMxR+dWhHTKbnC+6tou79bRP+zKCzDgWocNhhU4ehbqWz81iKMWQKicp7xfJLe0HK+oO80oQ+AX1guxx5+yFl30xhb1cpOSHv9vi/3FyKf7uEtf7oc8OTUODv/czwlTGpMWhPZslCZXDsJ71tiA/9tanX+fQjGbDHe609Ibbwymiw6GRmJst6bruAcr/ArCu/wPDgue0
sidebar_class_name: "get 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={"Get a bookmarks with the tag"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/tags/{tagId}/bookmarks"}
context={"endpoint"}
>
</MethodEndpoint>
Get the bookmarks with the tag
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"},"required":true,"name":"tagId","in":"path"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"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"]},"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},"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":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: get-a-single-bookmark
title: "Get a single bookmark"
description: "Get bookmark by its id"
sidebar_label: "Get a single bookmark"
hide_title: true
hide_table_of_contents: true
api: eJytV8Fu4zYQ/RVhTi0gxNliiy508xbtNgXaDZoUPRg+jMWxxVgiteTIiVfQvxdDyZbsKImym5Nl8Q355vENNaxBkU+dLllbAwl8Io5W1m4LdNtotY80+0griIFx4yFZwMdu0MMyBk9p5TTvIVnUsCJ05OYVZ5Asls0yhhIdFsTkfAD4NKMCIamB9yVBAp6dNhuIgR6wKHN5pUmr/GG/Ke7vPvxiH77+nD0w2/SDMNAcIAcGVwqaGBx9qbQjBQm7imIwWAho1YNi0JJZiZyBsHLkS2s8eWHy0+Wl/JyK8Hl1RylH95qzXgyFjBcQQ2oNk2GJwrLMdYoSNbvzEjqSpA2TQQylsyU51u3CWj0WookhdYRMas6jo4VVeq3Hh2MwVZ7jSjQSKZqjYhOQ6NJM72jIaWVtTmhk2TXurOzzU+OMm402mxtGrvzL68VApirETL5KU/IeZAmdV45EJjJKopZNDMbyNP6+Kgp0+2mqBCcfgegc7sUkTIX/5n1rbTcygMyYZqQ+jpI7CIEaYsiqAg0smxNXLyCUX5j/ZLaAG5jRGvq8DnX2fALt6NNUcm22QfzK5aMZTXfVSVVNwOsCN/Tv2LJPgefeE1+NbMmYR1JHZHxm+TVR6yrPr2WltkJeE1o6Sh3e56S+IXinFdlXEcWdTicKnXGR/9pb50X8IY1paKw4s26aRNUq1z6jaWiFTNddxDRRJOKv7tCcEHBWeQHdFsKyib+3sJgeOBRWeBirLG8rl04sgHGqhzW+lyuK8QLZ8HT7AjzUoiyi1n3QmG/Fpzqnv0dPy7GafYUiMXj9dTitqYoVuVE/T/b+uMy9KH2ub6B6ZbbG3o98AkLAsjlK+/bfr0nb3J+gh7xvhm9WaAy5q84LZwcndEea4LqWKpxuMHJOSs09JUX4GvZsl80ooG+jTpqmQaNz0tWctzBdk9Ab5aj78nEfCk3g8P7y/eNO8oCJjOVobSuj3q6DTK0abzkK8l724PHYmVRhhh4vWjYhnjOrIIFNuz3SOCcwO2ybn9V9d92A3ALc7tDjh6YBalTKkffNDEs9272TzUenpa4C9W641WuNVc6QQMZc+mQ2Y7e/yCw6Re4CyxLO+gi4zSjqJojsOuKMog4etUxkQwaXkxvRs113eEU5iiPrShYBJo1tAIlPw8Pv1hUo/P787zYoqM3aSrjk3DJ6d3F5cTm4ofzR0ZlfX42yn19fRWvrAvUDVjKVD6L1LF1gUh9uMnIjw8hrs8npeBs5n7buTfXMFa7NV74RszJHHXr3rstrN3lxrE0xfzK4RC1jyKxngdT1Cr2cyU0jr79UJI33YtnvcXCC0l6eFSRrzD09Q/iHfzpP/hg9xfJw1pl9sFJeyT+IYUv708teOCMzQiUtxaLuAPM0pZIHoY/qTgxz9P2n326hbWOG951TWww77VNadd0ibu2WTNMcWbL8F4JN8z/lr1XF
sidebar_class_name: "get 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={"Get a single bookmark"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/bookmarks/{bookmarkId}"}
context={"endpoint"}
>
</MethodEndpoint>
Get 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={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with bookmark data.","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"]},"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},"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":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: get-a-single-highlight
title: "Get a single highlight"
description: "Get highlight by its id"
sidebar_label: "Get a single highlight"
hide_title: true
hide_table_of_contents: true
api: eJytVcFu2zAM/RWDpw0QknTosMG3HLauu7TYOuwQ5KBYjK3WllSJbpMZ+veBipM4qVvssFMc84l6fHykO1AYCq8daWsghyukrNJlVeuyomy1zTSFTCsQQLIMkC/g2z4aYCkgYNF6TVvIFx2sUHr085YqyBfLuBTgpJcNEvqQAKGosJGQd0Bbh5BDIK9NCQJwIxtX8yuNWtWbbdk833/+ZDd/PlYbIlt8ZgqaEuRA4VpBFODxsdUeFeTkWxRgZMOoaoASoLk6J6kC5uUxOGsCBubyYTbjn1Mhblb3WFD2rKkaCKIkyQkIKKwhNMTHpHO1LiQfm94HPjtSp03ZQIDz1qEnvbt5Ze1DI/3DtXqpSRQQSHq6Wa8D0iBu2maFnuNo1BvRwtbWj2pt2oY7ucW6ts/AarBCpUc0IGBVt8itVbiWbU2Q74FRAOGGxlKatq7lipvDLYgCjCX8J6AeL70N6F9RpfAoCdV8hEg8ccNiqO+pmkPt+qp6zonR4f7hbcsRA0KMfOfl7PKlgw6gzFjK1rY16v85p7BqRN8ooMEQZDkWO9MmZTjil3FXSoNUWQU5lEmaNDE5TA8jEKbdYLAi64r+aT/gra8hh04q5TGEOJVOT58uQMCT9Jr7nsj34Z1ke5NVRC7k0yn57aSy0iv0E+kciDNZ7yrM+gSZXWdUYdbDsx0T7slgM/1kRftxG+yngzx8L1eRYJD3IJ6D9PDV+kYyv++/75KG2qwtH+ead4wuJrPJbLieejrz2+tR9vPb62xtfaK+x3KlUYCzgRqZnNBvMV7IMgvalDUeF9F53u7oq7dW+K5itvvU1VKbNGncsq5v9OK4NQMIyIc7dCmgsoEY1HUrGfCXr2Pk148tev4CLI99Tm5QOvCzgnwt64BvcH73o3fm++w1nv1LabbJTrykcgABD7g9W/ZxGQVUKBX6RGOHmBcFOhqcfTF+7JqD/a++3IEAeeqVM2+k7KO8um6HuLMPaGI80CT+zwRj/Asdfo7e
sidebar_class_name: "get 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={"Get a single highlight"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/highlights/{highlightId}"}
context={"endpoint"}
>
</MethodEndpoint>
Get 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={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with highlight data.","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>

View File

@@ -0,0 +1,72 @@
---
id: get-a-single-list
title: "Get a single list"
description: "Get list by its id"
sidebar_label: "Get a single list"
hide_title: true
hide_table_of_contents: true
api: eJytVE1v2zAM/SsGTxsgxOnQYYVvOWxdhwErtg47BD4oFhOrtSVXott4hv77QNlpvtxhh538QYp8j++JPSj0hdMNaWsgg2ukpNKeklWXaPKJViCA5MZDtoSv2pOHXIDHonWaOsiWPaxQOnSLlkrIlnnIBTTSyRoJnY8JviixlpD1QF2DkIEnp80GBOBW1k3FvzRqVW27Tf18f/XBbn+/L7dEtrji7ppiCne/URAEOHxstUMFGbkWBRhZc0I1JAjQzKSRVAKjcegbazx6RvBuPufHMelvq3ssKHnWVA7klSQ5AwGFNYSG+IRsmkoXkk+k956PTRCzsRAIaJxt0JEemmp1Tj7sYE8EjtCdT820VSVXPBOmHwToYioxRCHQ8Ez+pcqQMCGSaWtWv5amlRUI8LV0xDZQuJZtRZDtYkHAY4uu+4d+RzIuIfosDmSkcwA+P/YAhMCnL+eX50pyPDGWkrVtjfp/ChZWTUtVo/dyMxU7IRgr7PPzMLCokUqrIIMNxq5s2gxSdqFP+8HRgWeO7ml3n1pXQQa9VMqh9yGVjU6fLkDAk3SaRxwhj+FhRjudSqLGZ2lKrpuVVjqFbiabBk48B3clJmOBxK4TKjEZ05MBCYtwsAh+8ByHvofr4GUo3JdZxDTIxiQQ48sn62rJ+L78uouT02Zt+ThzHhBdzOaz+cE2+DzCWdzeTKJf3N4ka+si9F0uM+VbYT3VMuo/bg7eejLx2mwqjBvgtGS/N9IrK3LgSbiltKmkNtwoCtWPoi7jfvIgIBsXVS6gtJ441Pcr6fGnq0Lg3+MlWuZ7TaPySnt+V5CtZeXxLyDffB+99zZ5Dd34U5ouWqdq+QsEPGC3X6YhDwJKlApdRDAEF0WBDR0cO7tbbI4Xb19/vAMB8tgSJxaI1Sch9f2QcWcf0ITwgpD4mwGG8AcMME3z
sidebar_class_name: "get 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={"Get a single list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/lists/{listId}"}
context={"endpoint"}
>
</MethodEndpoint>
Get list by its id
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true}},"required":["id","name","icon","parentId"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: get-a-single-tag
title: "Get a single tag"
description: "Get tag by its id"
sidebar_label: "Get a single tag"
hide_title: true
hide_table_of_contents: true
api: eJytVE1v00AQ/SurOYG0SgIqovItlaCUCwiCOEQ5TLwTe1vbu90dlwTL/x3N2m3T1JQLJ6933s68N18dGIp5sJ6tayCDS2LFWKjtQVmOyhrQwFhEyNawku9GQ6S8DZYPkK072BIGCsuWS8jWm36jwWPAmphCTICYl1QjZB3wwRNkEDnYpgANtMfaV3JlyZpqfyjqX9fn793+97tyz+zycwluOUFWWFwZ6DUEum1tIAMZh5Y0NFiLnZNdgxUVHrkE4RIoetdEihL/7WIhn6eCv2yvKWf1y3KpKhtZGWScgYbcNUwNywv0vrI5yov5dZRnE7JccgQafHCeAtshqDXPpff3rKcMbX3h3E2N4SYeAZq23lI4BVwclsyYl2RWCfYvMmgnXZZtjc2Epe+f5HsNqR0S9ROiL9LaPKni6PZscfa8GCssVONY7VzbmP9Xg9yZ6WTXFCMWU7YT4cnDI37TDyJq4tIZyKCgFFXaLoO5DMy8Sx3Zg8xLuLufhjZUkEGHxgSKsZ+jt/O7N6DhDoPFbTXWaTAPCdphWzFkUDL7mM3nHA6z0mEwFGboPejTJJakRgfK7RSXpEa4GphIBY7G+LtkcYh7PMwPKZG4oiLBIBtBoMfDRxdqFH6ff65S3myzc/JcNA+M3swWs8XRLH8a6Sy/Xk2yX369UjsXEvV7rCjtNXgXeWzWcfBlY6GKtikqktV16rF77KLp7TaoZNrz3FdoGwmTytSNBV0PG1BDNiyZjYbSRRZD120x0o9Q9b1c37YUZC1uHuuZqm5slLOBbIdVpBcYvvo2dt1r9Tdu4yU2h9Q2VSt/oOGGDg97sN/IWBMaConAYFvmOXk+evVsqKQvHpr68sMKNODTbjipfvI+yajrBsTK3VDT948E5V8I9v0f+f01pA==
sidebar_class_name: "get 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={"Get a single tag"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/tags/{tagId}"}
context={"endpoint"}
>
</MethodEndpoint>
Get tag by its id
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"},"required":true,"name":"tagId","in":"path"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"numBookmarks":{"type":"number"},"numBookmarksByAttachedType":{"type":"object","properties":{"ai":{"type":"number"},"human":{"type":"number"}}}},"required":["id","name","numBookmarks","numBookmarksByAttachedType"],"title":"Tag"}}}},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: get-all-bookmarks
title: "Get all bookmarks"
description: "Get all bookmarks"
sidebar_label: "Get all bookmarks"
hide_title: true
hide_table_of_contents: true
api: eJytV01v2zgQ/SvGnIU43aNubrHbZoHdBkgWewh0GEsji7VEquTQqdfQf18MJVtSyiRK21Mc8c0n3wxnTlCQy61qWRkNKXwkXmFdr7bG7Bu0ewcJMO4cpA/w/vItS8BR7q3iI6QPJ9gSWrIbzxWkD1mXJdCixYaYrAsAl1fUIKQn4GNLkMLWmJpQQ5eApa9eWSogLbF2lIDGRiBo80odqIAElLj21ZM9Qpf8mLYSD0YcXqRP+2ZL9iV1tWoUL9Dk2Cq9kyQqruXDB2+deVF13iPmujPBu9ZoR07U/3Z9LX/ml/d5+4VyXj0qruaXuCqQ8QoSyI1m0iyi2La1ylFE11+cyEfcN0EjJNBa05Jl1Vsf2TFC0Vo8itdMjXtdhSq+z1KXQG4JmYoNR08bU6hSxY8T0L6ucStZZuupu+R8AfLCtSinJtyJnjPudkrv7hjZu9ftJUDaN1JRzuc5OamxElXtLUmaSBcilXUJaMPL/He+adAel2UllPMvvreeu5EDZMa8ouJ91LlzIlBBApVvUEPWzWrjQSwO+mfaAm7CZ6PpcxmazcsB9KfPu1IrvQ/J97aORrScVbPqXIBXDe7on5jZ58Ab54hvIlcS40huibSrDL9FqvR1fSuW+gp5i2hrKbf4WFPxA8IHVZB5k6N4UPnCRFfc1B9G6ryKP4exDI2eK2OXpchva+UqWoYukOl2kFiWFJH4a2iaCwSeVF5A94WQyev2c4XF9I1DYYUfscpyxtt8YQHEXT3b+FlfUYgXnA2/7l+Bh1oUI0U5CsV4KzxVNf0d7Zaxmn1DRhJw6r+p2mGKifF5MffjaR6TMsb6C7Lu9V6bx8gTEASy7pLaX/9+LbrmsYOe476bftmi1mRvBi48aZwwtDTBDdNT6G4Q6ZNSc8+lIryGo7dZFwWMY9RsaEqmQ/VsIp6PMMOQMBLlkvdsnGTP6wCIB5q+8TDavplU011jomdi6hZ3SktA4wrSdSHyhrgyBaSw61OJsoLAeqrSkT2c95DwpsMJi8KSc90aW7U+vJO7QavEw8CR4bgfsEv0NUMKFXPr0vWa7fGqMmgLslfYtvDkmYf7ilaDgpUpV1zRaoCvek/E9ckCdScz9zBWT9aoSxLFrkQRYDJ3BpDQKPz4w9gGxb8//70PN6F0aURcYu49end1fXU9WUE+De5sbm+i3m9ub1alscH1M1YilffKOJYhLT2dt5XYwvhk7rl0m/h22YcpnXvd1qjCRD3MXv11ThmSJVAZx/LxdNqik97YdfK5X5Tkkgvl5CrHxWpPx/k+ecDai9Gwsz0Dn5XHEoHzSrgEe9nxRnA2kjAs0QlUhIVMBg+nQWqT59ROTXy3w4mWS0l8/P0e+mlkurbM6TMdmFEfJ7pPpx5xb/akuw7OrrP8D500nv8BF0eYEQ==
sidebar_class_name: "get 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={"Get all bookmarks"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/bookmarks"}
context={"endpoint"}
>
</MethodEndpoint>
Get all bookmarks
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"boolean"},"required":false,"name":"archived","in":"query"},{"schema":{"type":"boolean"},"required":false,"name":"favourited","in":"query"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with all bookmarks data.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"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"]},"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},"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":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: get-all-highlights
title: "Get all highlights"
description: "Get all highlights"
sidebar_label: "Get all highlights"
hide_title: true
hide_table_of_contents: true
api: eJyNVU1v2zAM/SsGz0LS7uhbMGxrd1mBddihyIGxmVirLHkU3S0w9N8H2k5it267XJLIT4+PX88dlBQLto3Y4CGHLyQZOpdV9lA5e6gkggHBQ4T8AW4uh1sDkYqWrRwhf+hgR8jEm1YqyB+2aWugQcaahDj2gFhUVCPkHcixIcjBt/WOGJIBpt+tZSoh36OLZMBjrQhnaytgwKqw3y3xEZJZYIrC1h9UpxWnBx9bjuFN6mJAzLm3io9N8JGi0n+4utKveYG+7X5RIdkfK9WzQmUlCq7AQBG8kBe9i03jbIF6d/0rKsGC/tBTgoGGQ0Msdgg/acEFi8x4VN1CdXyfYxfCY438eFu+rFcyEAVZvu33kWSxM+TLN54WwQVe6gP5ttZ5OZJz4Q9oWUswcGAiDwZ2riUdoJL22DqB/ARMBoT+yhKlb53DnXZXuKVkwAeh/wLa5dTbSPxKVQomFCo3C0LSbKYepvWdV3NauzGrUXOv6Bx/Gm17meDzpvURPf2Vcabfz/iZwtkiT4gmwe7wYL1qmOx30o+BmqQKJeRw6PNoUPcb1jPSSPx02vKWHeTQYVkyxZjW2Nj10zUYeEK2KrKfyvHxsFynGahEmpiv18LHVRWQS+IVNg2YZwt4X1E2EmRhn0lF2QjPBiWqfWJP33Xdxm2YmNS5jhpXs+hhkI8gHdP+x+fANaq+rz/v+2ZYvw96XXMeFF2vrlZXE/u5GeVs7m4X1W/ubrN94F76CauZJgNNiFJjbxOjUy0a8oyzuxjOK/Y9JKpDuG4cWt/Pv3aqGzs6G5OtgSpE0dOu22GkH+xS0uPBJ7XPpY3azYuvPtJx4thPqCueQ+/Xr2DPFnwBby9z0r9FDFSEJXEfcri1KQpqpiFeOKyynMf2y6d7MIDzjj/rcM9+sld/nHB33YC4D4/kU4KTdNH/kLYppX8AOXqa
sidebar_class_name: "get 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={"Get all highlights"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/highlights"}
context={"endpoint"}
>
</MethodEndpoint>
Get all highlights
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with all highlights data.","content":{"application/json":{"schema":{"type":"object","properties":{"highlights":{"type":"array","items":{"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"}},"nextCursor":{"type":"string","nullable":true}},"required":["highlights","nextCursor"],"title":"PaginatedHighlights"}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,64 @@
---
id: get-all-lists
title: "Get all lists"
description: "Get all lists"
sidebar_label: "Get all lists"
hide_title: true
hide_table_of_contents: true
api: eJyNVMtu2zAQ/BVhzoTl9qibD22aokAD1EUPhg9raR0xkUiGXKU1BP57QUp+xDHQnvTY2d3ZnSFHNBxqr51oa1DhjqWgris6HSRAQegxoNrgW/7eKgSuB6/lgGozYsfk2a8GaVFttnGr4Dk4awIHVCM+Lpfp8bbD990T11L81tKeOxUNCS2gUFsjbCSlkXOdrimllU8h5Y4Idcs9pTc5OEYFm6tBwXnr2IueOk/0zzDyng5Q0MJ9+He6bi4wQbw2j4gKhnq+GXgz4XVcwQxdR7uOUYkfOCro+hYwKjjybOT+RvsbVSbAeyCboU+a9WQG6qAQevKSxGt4T0MnqI6xqPAysD/8R7+YxH0ZtOcmFdcN5oXM41yQ3yqIlpSZfYN4nTzJs40xR3qW1jao8MhZCkp2Qnm0YGD/yj5kww2+Q4WRmsZzCLEkp8vXD1B4Ja8T2SzfHJ68d5y4FXGhKkvxh0VryTfsF+QcrtTDuuViLlDYfSEtFzO8mJikcS4Owo9kyanv5XE47TP1TVNkGKoZBDW/fLa+p8Tv66810ja02duUnmaeGH1YLBdLnHf6Zaazeri/yX71cF/src/Uj9g0afKXDdJT9t5k5ncH/srKp/P4/maYxhP+I6XrSJtUP+szzhKedFZobZD0Yxx3FPin72JMv2fvbbZnAfNFotAyNeyz5s98QIVVXbOTrHQ35CN9fT0kUU5Wuvu0hgK9leJq9bn68YIwh4va4zgh1vaZTYxQMwlJ34jJuH8BXvTHdg==
sidebar_class_name: "get 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={"Get all lists"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/lists"}
context={"endpoint"}
>
</MethodEndpoint>
Get all lists
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with all lists data.","content":{"application/json":{"schema":{"type":"object","properties":{"lists":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true}},"required":["id","name","icon","parentId"],"title":"List"}}},"required":["lists"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,64 @@
---
id: get-all-tags
title: "Get all tags"
description: "Get all tags"
sidebar_label: "Get all tags"
hide_title: true
hide_table_of_contents: true
api: eJyFVMFu2zAM/RWDZyHOdvQtBbauu6zAPOxQ5MDYTKzGtlSK7mYY+veBspumabCeZFvk4yPfoyeoKVRsvVjXQwG3JBm2bSZ4CGAgHcUDlHpuDQSqBrYyQvEwwY6QiTeDNFA8bOPWAFPwrg8UoJjg83qtx1v8H7tHqiT7Y6U51clqFFyBgcr1Qr1oFnrf2go1K38MmjpBqBrqUJ9k9AQFuAQGBjw7Tyx2LjyTPkUhM45gwAp14eNsW5/FBGHbHyAa6LGj6xdDd+PcsUM+nqP3Q7cjvgy4GTciWDVUlynsIzJor0I2Q4f9lZsYo4rwNFimWnWzNSzUL4j+l9bWgFhpFbnEA7xDTQPexrlcR9K4Ggo4UOKPagfIFwMF4mfikPwycAsFTFjXTCHEHL3Nnz+BgWdki7t2aXm+nq2zx6EVKKAR8aHIc+Fx1TjkmniF3oO5sFfZULYAZG6fSUPZEp7NTLSZMx//VEvNdc/dfBqs1tUuUhgUSxCY5eGr4w6V3/ffJegwbL93mq49z4w+rdarNbwO9NtCZ3N/d5X95v4u2ztO1F9itdNowLsgi+6zGy+39Q3a9LpO77Z6bk7or+S+RdsrelJnWvR70dhA44Lo+zTtMNAvbmPUz08Dsf4Ftq/qpZ+AgYawJk6CH2mEAjZVRV6SzO2QFvJyt1WRk41uv5RgAN/qcDH3hP6y3v14hj1Nc0TpjtTHCGYhIfoOUU37DyemsKc=
sidebar_class_name: "get 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={"Get all tags"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/tags"}
context={"endpoint"}
>
</MethodEndpoint>
Get all tags
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with all tags data.","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"numBookmarks":{"type":"number"},"numBookmarksByAttachedType":{"type":"object","properties":{"ai":{"type":"number"},"human":{"type":"number"}}}},"required":["id","name","numBookmarks","numBookmarksByAttachedType"],"title":"Tag"}}},"required":["tags"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,64 @@
---
id: get-current-user-info
title: "Get current user info"
description: "Returns info about the current user"
sidebar_label: "Get current user info"
hide_title: true
hide_table_of_contents: true
api: eJyNU7Fy2zAM/RXdm3mW01GbhzZNl+Za5zr4PNASHDGRRAaE0vp0/PceKDWxkw7RIokE8ID3HiY0FGt2QZwfUOEHychDLNxw9IU9+FEKaamoR2YapBgjMQzE3kdUO9xF4oi9QaR6ZCcnVLsJB7JMvBmlRbXbp70BUwx+iBRRTfi0XuvrEvf74YFqKX47aTNI0VixKxjUfhAaRDNsCJ2rrWaUD1HTJsS6pd7ql5wCoYLPhWAQ2AdicTOoa85iorAb7pEMBtvT+wuDYew6e+gIlfBIyYB667oPRCYd9ml0TI0S5Brskz4GPUnrG1S4p9yeVXpQ6rCx7AlKIj8rn8rhyB0qTLZpmGJMpQ2ufL6CwbNlp3h5quV6pvNox05QoRUJsSpL4dOq9ZYb4pUNAeYN5duWiqVA4Y9Z5iW8mDtBSulM259K9Yx7rvALJYqrU+QwVEsQzPLxxXNvtb9vv7ZQQtRimq4zzx1drdartdrLiRKKr0s7m9ub/3a/ub0pjp5z6/9iddJkEHyU3maLzBrjmuTCxtnib8tOr3776CrMwwv9kTJ01g2KntWbFo13yBpDLaC70vooejpNBxvpjruU9PhpJNb92b9qnNfHoCXbEGdbPNIJFTZ1TUGyGbpR0d9thur2Yrjrz1sY2Eu13qiTqy9Xdjid1Z6mOWLrH2lICWZpQvQfSe39F505dr4=
sidebar_class_name: "get 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={"Get current user info"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/users/me"}
context={"endpoint"}
>
</MethodEndpoint>
Returns info about the current user
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with user data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}},"required":["id"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,64 @@
---
id: get-current-user-stats
title: "Get current user stats"
description: "Returns stats about the current user"
sidebar_label: "Get current user stats"
hide_title: true
hide_table_of_contents: true
api: eJyNU01v2zAM/SsGz0Kc7uhbBqwfw4AVW4odghwUm4nU2JZKUdkCQ/99oOy2SZYC88WySfE98j0O0GCoyXq2rocKfiBH6kMRWHMo9MZFLthgUUci7LmIAQkUsN4FqFbwFJACrBUErCNZPkK1GmCDmpAWkQ1Uq3VaKyAM3vUBA1QDfJrP5XUO/H3zjDUXvy2bDDIymIGC2vWMPcsV7X1ray1Xyucg9wYItcFOy4mPHqEClyuBAk/OI7EdUfvYfXZu32nah5PsPnYbJEhKTrf64MgyfpiwoNrYAzYfxZd5Ltdj32zgD4P3dmdauzNXM5IM8CVaEuDVeScXvM9ZvnM6YXCJt07yKOiQjWuggh3m6WmRD0oRI5QdllkQEKnpIKqL0pFaqGDQTUMYQiq1t+XhBhQcNFm9acdJTuFR9K2OLUMFhtmHqiyZjjPjNDVIM+09qAtjLA0WU4HCbbMZp/RiZAIppRMH/hQ/jLinPnwbquBKFzkNqikJ1HS4ddRp4ff11zJP3vZbJ9el55HRzWw+m8sSWG6lwv1EZ/H4cJX94vGh2DrK1F9zpdOkwLvAnc4+7nWmc4d8tmzF69jP6g7vW/HfKzu2z/iHS99q2wt+1m+YtF5B1hrECjKhDLxWYFxgiQ7DRgd8ojYl+f0SkWTf1+9q53VXYFA3SNkgezxCBYu6Rs/ZFm0UFv8ssij4ZsC7L0tQoM91u9ApV59Cuj+e1B6GMWPp9tinBGoiwfINSez+F2frt00=
sidebar_class_name: "get 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={"Get current user stats"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/users/me/stats"}
context={"endpoint"}
>
</MethodEndpoint>
Returns stats about the current user
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with user stats.","content":{"application/json":{"schema":{"type":"object","properties":{"numBookmarks":{"type":"number"},"numFavorites":{"type":"number"},"numArchived":{"type":"number"},"numTags":{"type":"number"},"numLists":{"type":"number"},"numHighlights":{"type":"number"}},"required":["numBookmarks","numFavorites","numArchived","numTags","numLists","numHighlights"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: get-highlights-of-a-bookmark
title: "Get highlights of a bookmark"
description: "Get highlights of a bookmark"
sidebar_label: "Get highlights of a bookmark"
hide_title: true
hide_table_of_contents: true
api: eJytVU1v2zgQ/SvCnFqAiNyiRQvdXKAf6aXFbhY9BD7Q0thiIpHscJTaFfjfF0NLkZyoTQ89WSYfh2/evBn2UGEoyXg2zkIBH5Gz2uzrxuxrDpnbZTrbOnfbaroFBaz3AYpreDcsBdgoCFh2ZPgIxXUPW9SEtO64huJ6EzcKvCbdIiOFBAhlja2Gogc+eoQCApOxe1CAB936RpYMmqo5HPftj5u3b9zh5+v6wOzKt8LAcIKMDC4riAoIv3eGsIKCqUMFVrcC2k4gBUby85prEFaEwTsbMAiTl6uV/JxLcVVj1pjAIsIkCSgonWW0LCe0940ptZzIb4IcW0jQbW+wZFDgyXkkNqdLZzEnrCbSRyHL2IanY8wSfCRoVBBYE3/Z7QLybN927RZJ9tFWv9ktXeNosVC2a8UFR2wa9wNETBF4T4gWFGybDsUXFe501zAUIzAqYDzwUkjbNY3eSmWlgFGBdYx/BDTLqXcB6ReqlISasVovEIlnXro+N9Bczbl2Q1YD58To/v75bZvJvZ/G2kN8eOXMFpuYdl+tXj125+j/zDrOdq6z1d9zZumqBe2jghZD0PulvQdJpAgTPiWSznPtKihgn2RLzVhAPqoc8n4SPOZnTReQ7sYR0lEDBfS6qghDiLn2Jr97AQruNBkxR8pi2D5JNzqxZvahyHOm40XtNFVIF9p7UAvNPwSQ/ucaswGenZhI4Waz71+RdujJ2QS810nulSwSTCZTAkmzpI8Pjlot/D5/u0piGrtzclxyPjF6cbG6WM0G4KeBzvrr5SL79dfLbOcoUR+xkmlU4F3gVidLDIPyibF/Fr2fbPbkc3FKXtoj9402NnWmVK8fij+1mBS5OOu3eScoqF1gwff9Vgf8j5oYZfl7hyQvz2aqfvJIZYJ8V1DsdBPwNzk8+2cw7vPsV5TH4WyPyWQy3woABbd4PH9l4iYqqFFXSInFCbAuS/Q8O/qoOcVK983x8f0VKNDnBnpgmBR9kVbfnxBX7hZtjPcsWf4LwRj/B3Qvuxk=
sidebar_class_name: "get 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={"Get highlights of a bookmark"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/bookmarks/{bookmarkId}/highlights"}
context={"endpoint"}
>
</MethodEndpoint>
Get highlights of 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={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The list of highlights","content":{"application/json":{"schema":{"type":"object","properties":{"highlights":{"type":"array","items":{"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"}}},"required":["highlights"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,82 @@
---
id: hoarder-api
title: "Hoarder API"
description: "The API for the Hoarder app"
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---
import ApiLogo from "@theme/ApiLogo";
import Heading from "@theme/Heading";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";
<span
className={"theme-doc-version-badge badge badge--secondary"}
children={"Version: 1.0.0"}
>
</span>
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Hoarder API"}
>
</Heading>
The API for the Hoarder app
<div
style={{"marginBottom":"2rem"}}
>
<Heading
id={"authentication"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Authentication"}
>
</Heading><SchemaTabs
className={"openapi-tabs__security-schemes"}
>
<TabItem
label={"HTTP: Bearer Auth"}
value={"bearerAuth"}
>
<div>
<table>
<tbody>
<tr>
<th>
Security Scheme Type:
</th><td>
http
</td>
</tr><tr>
<th>
HTTP Authorization Scheme:
</th><td>
bearer
</td>
</tr><tr>
<th>
Bearer format:
</th><td>
JWT
</td>
</tr>
</tbody>
</table>
</div>
</TabItem>
</SchemaTabs>
</div>

View File

@@ -0,0 +1,72 @@
---
id: remove-a-bookmark-from-a-list
title: "Remove a bookmark from a list"
description: "Remove the bookmarks from a list"
sidebar_label: "Remove a bookmark from a list"
hide_title: true
hide_table_of_contents: true
api: eJzNVE1v1DAQ/SvWnEAyzRYVUeW2iCKKKlSVIg6rHGbj2cZtEru20+4S+b+jcbJf7VJxQIhTEueN582bN9ODIl86bYM2LeRwRY15IBEqEnNj7hp0d14snGkEilr7ABIC3njIZ3ChffBQSPBUdk6HFeSzHuaEjty0CxXksyIWEiw6bCiQ8wngy4oahLyHsLIEOfjgdHsDEmiJja35SJNW9XJ10zzenr43y5/vqmUIpjzl7DokCGc/VxAlOLrvtCMFeXAdSWixYUA9ACRorstiqCDKv5b+wyjOixTmW9AejYIjvDWtJ89M3k5O+LHfia9GlKYN1AbxZq8f4hG9QKUopT6ZTJ7HrtkJrB2hWonWBKHbdQfHezkOra11iRyX3XoOPiCRmd9SyYHWGUsu6IF2aRQ9FzJKaMh7vDn0b0+r2XDDFl/EGFNJB+TgfgvjtipwSQvTtep/LyjFh8ooyEFRTYERyQg5ZNwRn/WDWWO2mbms35onAs+Ye1hPUOdqyKFHpRx5HzO0Ons4BgkP6DTO66GY8feg5AK7OkAOVQjW51kW3OqoMugUuSO0FuQTta8rEuMFwiyS/Ua4GJhAjHFn9L+xwkPe3QWwkYvzchUJxpORQCDHl0/GNcj8vvy4TprqdmE4nGseGB0fTY4mOwP4eaQzvTw/yH56eS4WxiXqayxXGiVY40ODyRnjoI5bD7fu2l95e9f3W7v90bocFAi0DJmtUbdMIbWwH10wS7vKg4R8s7Q2t/Hpzh4pJFTGBw7q+zl6+u7qGPn4viPHK7jY+iC5RWnP7wryBdaeXijm1dXo5Nfid7zHQ2xXyW51x18g4Y5W25XLa/YfZt1RJxZRQkWoyKXaB8C0LMmGndBnO4KtvJnRj2cXZ9dnIAH3PfzEsynBQWZ9PyCuzR21MW6IBv5mjjH+AghTjis=
sidebar_class_name: "delete 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={"Remove a bookmark from a list"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/lists/{listId}/bookmarks/{bookmarkId}"}
context={"endpoint"}
>
</MethodEndpoint>
Remove the bookmarks from a list
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"},{"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={{"204":{"description":"No content - the bookmark was added"},"400":{"description":"Bookmark already not in list","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}},"404":{"description":"List or bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: replace-asset
title: "Replace asset"
description: "Replace an existing asset with a new one"
sidebar_label: "Replace asset"
hide_title: true
hide_table_of_contents: true
api: eJy9VF1v2zoM/SsCn+4Are6GDXfwWzZsWPcwFF2G+xDkgbGZWK1taRLdJjP03y8o2/loswIDhr0EjnRIHR7ysIeSQuGNY2NbyOGGXI0FKWwVbU1g024UhkCsHgxXClVLD8q2BBoYNwHyBby39q5BfxdgqSFQ0XnDO8gXPawIPflZxxXki2VcanDosSEmHxIgFBU1CHkPvHMEOQT2pt2ABtpi42o5MmTKervbNA+37/61259vqy2zLd4JA8MJMjG4KiFq8PSjM55KyNl3pKHFRkCrA0iDkVodcgVR/zEaM9HpWQ44Ik4ILAc4BX5vy52wOG3JvKKk+tAGtsqPPZKOgIbCtkwtSyA6V5sCJTC7DRJ9pji7uqWCQYPz1pFnQyHFjtyeqBBP6lnsgcsYh6vgbBuGJK8v3zwt4KtVI0f1chomDFMZpQpdUVAI666udyLem3NJph6r1rJa264t/1zphS3pTN0aGgoBN+fuHmmSMhzwSZoUz5UtpdNdelX6nUM2jWLI+sNUxixJE7J+FDiC2MnfT2bpfA059FiWnkKIGTqT3b8CDffoDa7qsY3D9SDgGruaIYeK2YU8y9jvLiqLviR/gc6BPjNqYwJl14orUiNcDUwgxnjk8m8i8PDusdf3asm7UkWCiQcTCPT48cn6BoXfl//mSVJp3M3BCx8n9x1N51F3TLu2cicKDfxfXVxeXB458vNIfnZ9dbbW2fWVWlufCp2wokvU4GzgBtMYjebdr0ah8jhdf5jF39qhg05MW85cjaaVp1Oj+3FaFvvFFUBDfrLFhoGR470nNVQ2sIT1/QoDffd1jHL8oyMvW3l5mJc0VaUJ8l1CvsY60DNl/XMzDvwL9Svm4yG2uzSWdSf/QMMd7U43sGzdv/jyJE9cRg0VYUk+FT/cfhgeejmXHIfoJxtFSA8Rs6Igx89il0fuv/4+l5kft3uTtg14fACdfhNRm+pOVkpnPdTYbrq0fWBIKQ7BU4M9MlQq6qwUfT8g5vaO2hj3yrD8F11i/B/x1cPF
sidebar_class_name: "put 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={"Replace asset"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/bookmarks/{bookmarkId}/assets/{assetId}"}
context={"endpoint"}
>
</MethodEndpoint>
Replace an existing asset with a new one
<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"},{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"AssetId"},"required":true,"name":"assetId","in":"path"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"description":"The new asset to replace with","content":{"application/json":{"schema":{"type":"object","properties":{"assetId":{"type":"string"}},"required":["assetId"]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"No content - asset was replaced successfully"},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: search-bookmarks
title: "Search bookmarks"
description: "Search bookmarks"
sidebar_label: "Search bookmarks"
hide_title: true
hide_table_of_contents: true
api: eJytV0tv20gM/isGT1tAiNM96uYW+0iB3QabLPYQ6EBLlDW1NKPMcJx6Df33BUeyJafjRtnmFEfDx0cOyfl4gIJcblXLymhI4Y7Q5tVibcy2Qbt1kADjxkH6AB9O37IEHOXeKt5D+nCANaElu/JcQfqQdVkCLVpsiMm6IODyihqE9AC8bwlScGyV3kCXgKVHrywVkLL1lIDGRgQeIQElgB492T10ScSI9s2a7LmREms3WqlVo3iGpQFOAqy4lg8fvXXmu6bzXuLcdibyrjXakRPzP19fy5/zFH9ef6GcF0+KqwVXtHB9yi05X7O7ggRyo5k0iyq2ba1yFNXlFyf6EfgmWIQEWmtasqx67+MljqJoLe4FNVPjXjahiuil5ZaQqVhx9LQxhSpV/DgB7esa15JlufDulPMZkpIntaMpprUxNaEWtyXujNTkpXPGzUbpzR0je/eyvwRI+0YK3/k8JyetUKKqvSVJE+lCtLIuAW14Hn7nmwbtfl5WQte98b31tRs5QGbMKyo+RMEdE4EKEqh8gxqy7qw3HsTjYP/MWpCb1LPR9LkMM+H7AfSnl6HUSm9D8r2toxHNr6qz7pwhrxrc0N8xt5eEV84R30SuJFYjuSXSrjL8Gq3S1/WteOo75DWqraXc4lNNxf9Q3qmCzKuA4k7lMxNdcVN/HEvnRfljGPOk0XNl7LwU+XWtXEXzpAtkuh005iVFNP4YhuYMhWedF6T7RsjkdfuxxmL6yqGxwo9YZznjbT6zAeJQjz5+FCtK4QWw4df9C+KhF8VJUY5KsbqVOlU1/RmdlrGefUVGEnDq36nZgcXE6nl27cfTPCZljPUNsu71VpunyBMQFLLulNq3f79mXfM4QY9x302/rFFrsjdDLTwbnDCMNJEb2FOYbhCZk9Jzl1IRXsMRbdZFBUYadUaaJkTnjNU8pzADSRgL5ZT3bGSyR9YOgkDTVx6o7auLaroSTOxMXN3iRmkJaNwUui5E3hBXpoAUNn0qUTYFWJ5MLnsODLJX2N1xawhPOxywKCw51y2xVcvde7kitEqAhlIZjnueXaKvGVKomFuXLpds91eVQVuQvcK2hWevPdxXtBgMLEwZ6PggvuiRSASTdedOqPfAridLzymX4leiCGJCP4OQVFP48auxDQq+T//chwtRujSiLjH3iN5fXV9dTzaR3wc4q9ubKPrV7c2iNDZAP8pKpPJsGcfC1dLDcWmJbHfP2M9p5kQ3wT5IGd/LtkYVaPVAwPo7PS+T4VazBCrjWE4PhzU6mZRdJ5/7tUnuulBObnRcsy7i+umvoSjfLS5B2tJ+WCF3WHs5D2vfNz56ueOSOEf2tPWNwtlYj2H7TaAiLIQrPBwGrVWeUzt18c1WJ1ZOTfLbL/fQ85PpInNeSVMKjXo/sX049BL3Zku66+AIneV/6GQU/QeDC3/n
sidebar_class_name: "get 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={"Search bookmarks"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/bookmarks/search"}
context={"endpoint"}
>
</MethodEndpoint>
Search bookmarks
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string"},"required":true,"name":"q","in":"query"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with the search results.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"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"]},"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},"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":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
>
</StatusCodes>

240
docs/docs/API/sidebar.ts Normal file
View File

@@ -0,0 +1,240 @@
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
const sidebar: SidebarsConfig = {
apisidebar: [
{
type: "doc",
id: "API/hoarder-api",
},
{
type: "category",
label: "Bookmarks",
items: [
{
type: "doc",
id: "API/get-all-bookmarks",
label: "Get all bookmarks",
className: "api-method get",
},
{
type: "doc",
id: "API/create-a-new-bookmark",
label: "Create a new bookmark",
className: "api-method post",
},
{
type: "doc",
id: "API/search-bookmarks",
label: "Search bookmarks",
className: "api-method get",
},
{
type: "doc",
id: "API/get-a-single-bookmark",
label: "Get a single bookmark",
className: "api-method get",
},
{
type: "doc",
id: "API/delete-a-bookmark",
label: "Delete a bookmark",
className: "api-method delete",
},
{
type: "doc",
id: "API/update-a-bookmark",
label: "Update a bookmark",
className: "api-method patch",
},
{
type: "doc",
id: "API/summarize-a-bookmark",
label: "Summarize a bookmark",
className: "api-method post",
},
{
type: "doc",
id: "API/attach-tags-to-a-bookmark",
label: "Attach tags to a bookmark",
className: "api-method post",
},
{
type: "doc",
id: "API/detach-tags-from-a-bookmark",
label: "Detach tags from a bookmark",
className: "api-method delete",
},
{
type: "doc",
id: "API/get-highlights-of-a-bookmark",
label: "Get highlights of a bookmark",
className: "api-method get",
},
{
type: "doc",
id: "API/attach-asset",
label: "Attach asset",
className: "api-method post",
},
{
type: "doc",
id: "API/replace-asset",
label: "Replace asset",
className: "api-method put",
},
{
type: "doc",
id: "API/detach-asset",
label: "Detach asset",
className: "api-method delete",
},
],
},
{
type: "category",
label: "Lists",
items: [
{
type: "doc",
id: "API/get-all-lists",
label: "Get all lists",
className: "api-method get",
},
{
type: "doc",
id: "API/create-a-new-list",
label: "Create a new list",
className: "api-method post",
},
{
type: "doc",
id: "API/get-a-single-list",
label: "Get a single list",
className: "api-method get",
},
{
type: "doc",
id: "API/delete-a-list",
label: "Delete a list",
className: "api-method delete",
},
{
type: "doc",
id: "API/update-a-list",
label: "Update a list",
className: "api-method patch",
},
{
type: "doc",
id: "API/get-a-bookmarks-in-a-list",
label: "Get a bookmarks in a list",
className: "api-method get",
},
{
type: "doc",
id: "API/add-a-bookmark-to-a-list",
label: "Add a bookmark to a list",
className: "api-method put",
},
{
type: "doc",
id: "API/remove-a-bookmark-from-a-list",
label: "Remove a bookmark from a list",
className: "api-method delete",
},
],
},
{
type: "category",
label: "Tags",
items: [
{
type: "doc",
id: "API/get-all-tags",
label: "Get all tags",
className: "api-method get",
},
{
type: "doc",
id: "API/get-a-single-tag",
label: "Get a single tag",
className: "api-method get",
},
{
type: "doc",
id: "API/delete-a-tag",
label: "Delete a tag",
className: "api-method delete",
},
{
type: "doc",
id: "API/update-a-tag",
label: "Update a tag",
className: "api-method patch",
},
{
type: "doc",
id: "API/get-a-bookmarks-with-the-tag",
label: "Get a bookmarks with the tag",
className: "api-method get",
},
],
},
{
type: "category",
label: "Highlights",
items: [
{
type: "doc",
id: "API/get-all-highlights",
label: "Get all highlights",
className: "api-method get",
},
{
type: "doc",
id: "API/create-a-new-highlight",
label: "Create a new highlight",
className: "api-method post",
},
{
type: "doc",
id: "API/get-a-single-highlight",
label: "Get a single highlight",
className: "api-method get",
},
{
type: "doc",
id: "API/delete-a-highlight",
label: "Delete a highlight",
className: "api-method delete",
},
{
type: "doc",
id: "API/update-a-highlight",
label: "Update a highlight",
className: "api-method patch",
},
],
},
{
type: "category",
label: "Users",
items: [
{
type: "doc",
id: "API/get-current-user-info",
label: "Get current user info",
className: "api-method get",
},
{
type: "doc",
id: "API/get-current-user-stats",
label: "Get current user stats",
className: "api-method get",
},
],
},
],
};
export default sidebar.apisidebar;

View File

@@ -0,0 +1,72 @@
---
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: eJytVUuP2zYQ/ivCnFqAsJwiRQPdnEPQ7SWL7BY9GD6MxbHFXYlkyJFjR+B/L4aSX7vO45CTJM7rm4/fjAbQFOtgPBtnoYIFM9YNxQKL2HcdhkPBruCGirVzzx2G5wKtLgJxH2zMht5rZJKz2gU9AwWM2wjVEt5PIRFWCiLVfTB8gGo5wJowUFj03EC1XKWVAo8BO2IKMTvEuqEOoRqAD56ggsjB2C0ooD12vpUjQ0a3+8O2+/L07i+3//pns2d29TtBYDi7HBHcaUgKAn3uTSANFYeeFFjsxGl9dlJghAWP3ICgChS9s5GiIPljPpfHNWGPFwycKPpiuDnyBwpqZ5ksSzB635oaJbh8ipLhRq9u/UQ1gwIfnKfAZqxv9Gs+koI6kFRf8E1r57TZmNtmBbZvW1wLVcJIOhH3E54Y6sbs6BLT2rmW0ErZDe6cXPe37IzbrbHbB0bu44/rKSDbd6Kp2Nc1xQhSwrR9IKGJrJaoVVJgHf8c/uP1/Nj3SjlLuYZL0q8ovqDlioOXDa9SkrRv529fK+qo2cI6Ljaut/rXSah2+gY7IhOKEbe3bC+6zxnO/rmRHM+N0zI6LuayMkEVlMeRiOVwHrNUjuSbr5IqUtgdx74PLVQwoNaBYkwlelPu3oCCHQYjV5K7mMwjdRvsW4YKGmYfq7LkcJg1DoOmMEPvQd0Y2ClB4TZ5g03uxYgEUkoX++pBqB3rXm6tE09SV7rIbiLy7ARqevngQoeC75//HjOZxm6chEvPI6I3s/lsfrG0/p7gLO7vbqJf3N8VGxcy9KOvdJpUZr/DLIlpuT0cmS7wtJ9eZh3O8vpFP4CRGqY9l75Fk0c+3+0wKWN52royytXVCj6LY6WgET1VSxiGNUb6N7QpyfHnnmR2l6uzNLKAtInyrqHaYBvpO43+9mlS9e/FtxBPh2gPWYFtL1+g4JkO17+NJJunIdQUMorRYVHX5Pki9NXkis5Ok3P/8eFRFsi1vF7IKae/iWsYRo9H90w2pRNMlm9BmNL/WQ2+Kg==
sidebar_class_name: "post 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={"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"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
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/SvCnFpAtb1Figa6OUGLbNGii2SDHgwfxuLY4q5EKvzwWhX034uhZH1ktRsBzR4WJjUkh2/ee8MaBNnUyNJJrSCBz6VAR9FB68cCzWN0qCLpbCQFxODwZCHZwbvuo4V9DJZSb6SrINnVcCA0ZLbeZZDs9s0+hhINFuTI2BBg04wKhKQGV5UECVhnpDpBDHTBosx5SpIU+aU6FU8Pb3/Vl39/yS7O6fQtZyBdCLlmcCugicHQFy8NCUic8RSDwoKDDkNQDJIvV6LLgLPiFWTdOy0qzmUKwX1GkUCHkdORD3Csor9VXkUuo+goKRc2qrSPnlC5ISZSRIKHB4pKo89SkFhBDKlWjpTjY7Asc5kiH7N+sHzWDCD68ECpgxhKo0syTpINa02ayTPfsY88aJ0TKkbgiGfNVXjpu/VFgaaaw135PMcDo8rgNTEo7eh5YNOD/60tYijw8iepE5PgZrPZNDGkhtCR2LpFGXiTz8UdtSnQQQLeSM5nUrUF26J3mTaLQkt/yKXNaFk0l/+uWyEWr/hLC3mUCxc4uizDDq0l937g3DcWhD/Wgy21si3Vft5s5kXREl305vD92C1nUHidNk0MRQfgQlYtpC9j+L+05vB0kur0yaHzdolcSPmCbdX6NCVrmekoc2+IYSIleNX+RWHO5L9c7RPz3EFw+QH0CcQjWCYYfH3hfcuoN5s3z0l0te1IaRcdtVfi+1Eo1WLetgqyFk9z3766fdhhiN932ijIZVq03SPN+FzuIgmsrzKw63poNQ1wSzTna8MLXgY1CmHI2maNpVyfbyCGMxrJlWjdvf3cInZEn7PNZc6VNlmvnalWmUYjyKywLCGekWa3QaSPoUt14VGbCTRNM+rUnxjR9txxv+7h4XP5FiGMuR2CIO5+/H614T/+uQ8YcqU+Dg31t2sjHzetlulj6bQzPVVHFA00H8bXnt9PjFxhmGxx7odThPrpawsYZkZOP1o9NfTph8G3RzkGex6dM3HhERmlOmpGhvnR5naz2qw2o2t+6Eq3vbudrfT27jY6ahPKfI1lVnDX0tYVGFTTPYG61xyOLfurttnL7/WnX0sNvue6zFEGp+v6dKuHXf/eYgdLRo+vfQyZto5D6vqAlj6bvGl4+osnrv1uP8ghiEZIy78FJEfMLb2S8w8fOwH/GL2UZTeJqgqqyz2PIIZHqqaPxIZNNiMUTIZd3QV0VfzpnrcZNnhmVU18XbFNUyrdq7H7ka3cbe/ff2B1dY/RIhgZGHyCOPwP2epw+SDaMFdDjurkg7FBu2nTvXHGbWkq3XCtWTzquo2414+kmqaHx/GYkWma/wA9UDRf
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 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"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -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>

View File

@@ -0,0 +1,72 @@
---
id: update-a-list
title: "Update a list"
description: "Update list by its id"
sidebar_label: "Update a list"
hide_title: true
hide_table_of_contents: true
api: eJytVd9v2zYQ/leIe9oAznaGDCv05hUtmqHAgs7FHgw90OLZYiqRKnlKrAn634cj5chOlBQD4gdD5B3vx3ff3fWgMRTeNGSchQy+NloRisoEErtOGArCaJBA6hAg28JnEyhALiFg0XpDHWTbHnaoPPp1SyVk23zIJTTKqxoJfYgKoSixVpD1QF2DkEEgb+wBJOBR1U3FVwaNro7doX64e/e7O/77W3kkcsU79m4oqrD3Gw2DBI/fW+NRQ0a+RQlW1axQJQUJhpNpFJXA0bA2BvrD6Y5juEx5U6LQipQgJ9qY/kL8ZatOUIlib7DSQXSuFQ/K0qQjLKLm4w5F49290agXIKFwltASu1FNU5lCsZvlXWBfM0C43R0WBBIa7xr0ZDCwNOXzHK7a2M9oDwz0lYRaHU+n69UgLxN7/ti2VaV2jGQC7czY6sLY1YqtmWLOzBCLi5Zx/qGPQcL3Fn33o1SG+ONChcbZkDD4dbWar1aqgI4sfTvIzUw+g3yhEv8X7DeDMynM9JFta27QWtlWVSAh1MoTd6rGvWorguwke60oT/xddNoW4iiIgIzpnAWfX7YppIJer66f15DlwjoSe9da/XYVLJyeL1WNIajDnOxJgtHCpJ+PtKyRSqfTRCnKmDXTFpbMwLDs09gZGHX096eh1/oKMuiV1h5DGJaqMcv7K5Bwr7xhkGPQozihdKpUSdSEbLkk3y1Kp7xGv1BNA3KmG0YDwu3jxBrVRYqEy3A2rf9mJJPf85n9CAv75SyiGmSjEsjx46PzteL4/vxnE7HjCn2ZhuuH0zA/DbCJWJdxP16nppjOUy9MdyNZz+pp7N6xE4Y6GbxarBars03xaURhfXszC9r69kbsnY+InXQZYG5HF6hW9iyJcSmq08B50vmP7H15eyZ0CY+0bCplLPuJ9OhHKm3j6gogIRt3WC6hdIFY1Pc7FfCrr4aBr0c8tvnEpMg3bQJ/a8j2qgr4Spw/fRk5/7N4KbrxUtkuErZq+QQSvmE37dkhHySUqDT6GEESvk9+ftmwienxs84e5OnFuiiwoVd187MuvF1v3n9iUo77vI59D149gIz/MVIXE49cj3c9VMoe2jgHIBllCqvLDnjC+JjWLBZ9nzQ27hvaYXiEhvjMyAzDfypDMuk=
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 list"}
>
</Heading>
<MethodEndpoint
method={"patch"}
path={"/lists/{listId}"}
context={"endpoint"}
>
</MethodEndpoint>
Update list by its id
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","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":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","nullable":true,"minLength":0,"maxLength":100},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"query":{"type":"string","minLength":1}}}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The updated list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true}},"required":["id","name","icon","parentId"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -0,0 +1,72 @@
---
id: update-a-tag
title: "Update a tag"
description: "Update tag by its id"
sidebar_label: "Update a tag"
hide_title: true
hide_table_of_contents: true
api: eJytVcFu4zYQ/RViTi3A2t5iiy50cxYtNr002HrRg+HDWBxbTCSSS46SqIL+vRhKXtupkl7WB1vSPHHezLw37sFQKqMNbL2DAr4Eg0yK8aj2nbKclDWggfGYoNjCRn53GhKVbbTcQbHtYU8YKa5brqDY7oadhoARG2KKKQNSWVGDUPTAXSAoIHG07gga6BmbUMsjS9bUz92xebr/8Kt//ueX6pnZlx8kueUM2eDx1sCgIdLX1kYyUHBsSYPDRuKc4xqsFBKQKxAuAqbEN950wuC63E1FyiCjYq/aXPpC/enqTnFF6mCpNkl1vlVP6PiMUY7IyO2eVIj+0RoyC9BQesfkWNJgCLUtUdIs75PkmmmD399TyaAhRB8osqUk0bGcl80a8kfqScG7NEJ/Xq3mixqJGhnk9yNmzQwt/RpfDa5tbrx/aDA+pAuAa5s9xZeAm27NjGVFZpNh/0cG7eyRVdugm4lMvTsJZwtZ15n6C6Jv0tpdyXE69v3q/cwU8KicZ3XwrTPfbwalN/PNbiglPM4K57rwfMIZv5t01RBX3ozOKSvJKw4qYCneX/bZXAOI9ePjydhtrKGAHo2JlNKwxGCXj+9AwyNGi/t6mtQYHlt0wLZmKKBiDqlYLjl2i8pjNBQXGALoGTFPByh/yL6c4GpkIjO42Eh/SR/HvJd76VtTJK9UkWFQTCDQ08XvPjYo/P74e5M7J/P5fF4hv50W1smmFxOw7uAlIO0Zyb9brBariw32aWK+vrudLXR9d6sOPuYqT1hpyqAh+MSTsqfE06rGyeNXp/Vnub260sd+MD3zMtRonWTJA+2n0W/Hta+hGDfrTkPlE0ug7/eY6Eush0Eef20pyn/B7jz5rA9jk1wbKA5YJ3qD5A+fJ4X+qF7jNj1E12WB1a3cgYYH6r4t/2EnK4DQUMwExtjHMc1P2cHnd/9jw0Gf3liXJQV+E7u7sMzdevPxk2ho+pNpskkh4hPo/J2J+lx3lmZ+1kON7thm08J4qCgOrwX7QqC5rNlW9P2I2PgHcsNw7ozcS2eG4V8oW7cC
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 tag"}
>
</Heading>
<MethodEndpoint
method={"patch"}
path={"/tags/{tagId}"}
context={"endpoint"}
>
</MethodEndpoint>
Update tag by its id
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"},"required":true,"name":"tagId","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":{"name":{"type":"string"}}}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The updated tag","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"numBookmarks":{"type":"number"},"numBookmarksByAttachedType":{"type":"object","properties":{"ai":{"type":"number"},"human":{"type":"number"}}}},"required":["id","name","numBookmarks","numBookmarksByAttachedType"],"title":"Tag"}}}},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>

View File

@@ -1,129 +1,148 @@
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import type * as OpenApiPlugin from "docusaurus-preset-openapi";
import type * as Preset from "@docusaurus/preset-classic";
import type { Config } from "@docusaurus/types";
import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs";
import { themes as prismThemes } from "prism-react-renderer";
const config: Config = {
title: 'Karakeep Docs',
tagline: 'Dinosaurs are cool',
favicon: 'img/favicon.ico',
title: "Karakeep Docs",
tagline: "Dinosaurs are cool",
favicon: "img/favicon.ico",
// Set the production url of your site here
url: 'https://docs.karakeep.app',
url: "https://docs.karakeep.app",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',
baseUrl: "/",
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'karakeep-app', // Usually your GitHub org/user name.
projectName: 'karakeep', // Usually your repo name.
organizationName: "karakeep-app", // Usually your GitHub org/user name.
projectName: "karakeep", // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
locales: ['en'],
defaultLocale: "en",
locales: ["en"],
},
presets: [
[
'docusaurus-preset-openapi',
({
"classic",
{
docs: {
sidebarPath: './sidebars.ts',
editUrl:
'https://github.com/karakeep-app/karakeep/tree/main/docs/',
sidebarPath: "./sidebars.ts",
sidebarItemsGenerator: async ({
defaultSidebarItemsGenerator,
...args
}) => {
const sidebarItems = await defaultSidebarItemsGenerator(args);
return sidebarItems.filter(
(item) => !(item.type == "category" && item.label === "API"),
);
},
editUrl: "https://github.com/karakeep-app/karakeep/tree/main/docs/",
routeBasePath: "/",
},
api: {
path: "../packages/open-api/hoarder-openapi-spec.json",
routeBasePath: '/api',
docItemComponent: "@theme/ApiItem",
},
blog: false,
theme: {
customCss: './src/css/custom.css',
customCss: "./src/css/custom.css",
},
}) satisfies OpenApiPlugin.Options,
} satisfies Preset.Options,
],
],
plugins: [
[
"docusaurus-plugin-openapi-docs",
{
id: "api",
docsPluginId: "classic",
config: {
karakeep: {
specPath: "../packages/open-api/hoarder-openapi-spec.json",
outputDir: "docs/API",
sidebarOptions: {
groupPathsBy: "tag",
},
} satisfies OpenApiPlugin.Options,
},
},
],
],
themes: ["docusaurus-theme-openapi-docs"],
themeConfig: {
image: 'img/opengraph-image.png',
image: "img/opengraph-image.png",
navbar: {
title: '',
title: "",
logo: {
alt: 'Karakeep Logo',
src: 'img/logo-full.svg',
srcDark: 'img/logo-full-white.svg',
alt: "Karakeep Logo",
src: "img/logo-full.svg",
srcDark: "img/logo-full-white.svg",
width: "120px",
},
items: [
{
type: 'docsVersionDropdown',
position: 'right',
type: "docsVersionDropdown",
position: "right",
},
{
to: '/api',
label: 'API',
position: 'right',
href: "https://karakeep.app",
label: "Homepage",
position: "right",
},
{
href: 'https://karakeep.app',
label: 'Homepage',
position: 'right',
href: "https://github.com/karakeep-app/karakeep",
label: "GitHub",
position: "right",
},
{
href: 'https://github.com/karakeep-app/karakeep',
label: 'GitHub',
position: 'right',
},
{
href: 'https://discord.gg/NrgeYywsFh',
label: 'Discord',
position: 'right',
href: "https://discord.gg/NrgeYywsFh",
label: "Discord",
position: "right",
},
],
},
footer: {
style: 'dark',
style: "dark",
links: [
{
title: 'Docs',
title: "Docs",
items: [
{
label: 'Introduction',
to: '/',
label: "Introduction",
to: "/",
},
],
},
{
title: 'Community',
title: "Community",
items: [
{
label: 'GitHub',
href: 'https://github.com/karakeep-app/karakeep',
label: "GitHub",
href: "https://github.com/karakeep-app/karakeep",
},
],
},
{
title: 'More',
title: "More",
items: [
{
label: 'Homepage',
href: 'https://karakeep.app',
label: "Homepage",
href: "https://karakeep.app",
},
{
label: 'GitHub',
href: 'https://github.com/karakeep-app/karakeep',
label: "GitHub",
href: "https://github.com/karakeep-app/karakeep",
},
{
label: 'Demo',
href: 'https://try.karakeep.app',
label: "Demo",
href: "https://try.karakeep.app",
},
],
},

View File

@@ -15,20 +15,21 @@
"typecheck": "tsc"
},
"dependencies": {
"@docusaurus/core": "3.5.2",
"@docusaurus/preset-classic": "3.5.2",
"@docusaurus/core": "3.7.0",
"@docusaurus/preset-classic": "3.7.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.1.0",
"docusaurus-preset-openapi": "^0.7.5",
"prism-react-renderer": "^2.3.0",
"docusaurus-plugin-openapi-docs": "^4.3.7",
"docusaurus-theme-openapi-docs": "^4.3.7",
"prism-react-renderer": "^2.4.1",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"url": "^0.11.4"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.5.2",
"@docusaurus/tsconfig": "3.5.2",
"@docusaurus/types": "3.5.2",
"@docusaurus/module-type-aliases": "3.7.0",
"@docusaurus/tsconfig": "3.7.0",
"@docusaurus/types": "3.7.0",
"typescript": "^5.7.3"
},
"browserslist": {

View File

@@ -1,31 +1,14 @@
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
import openapiSidebar from "./docs/API/sidebar";
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
const sidebars: SidebarsConfig = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
// But you can create a sidebar manually
/*
tutorialSidebar: [
'intro',
'hello',
sidebar: [
{ type: "autogenerated", dirName: "." },
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
API: openapiSidebar,
},
],
*/
};
export default sidebars;

View File

@@ -2,5 +2,8 @@
"extends": "@docusaurus/tsconfig",
"compilerOptions": {
"baseUrl": "."
}
},
"include": [
"../node_modules/docusaurus-plugin-openapi-docs/src/plugin-content-docs-types.d.ts"
]
}

6285
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff