diff options
Diffstat (limited to 'docs/versioned_docs/version-v0.23.2/API/search-bookmarks.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.23.2/API/search-bookmarks.api.mdx | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.23.2/API/search-bookmarks.api.mdx b/docs/versioned_docs/version-v0.23.2/API/search-bookmarks.api.mdx new file mode 100644 index 00000000..85c3db60 --- /dev/null +++ b/docs/versioned_docs/version-v0.23.2/API/search-bookmarks.api.mdx @@ -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> + + +
\ No newline at end of file |
