diff options
Diffstat (limited to 'docs/versioned_docs/version-v0.25.0/API/search-bookmarks.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.25.0/API/search-bookmarks.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.25.0/API/search-bookmarks.api.mdx b/docs/versioned_docs/version-v0.25.0/API/search-bookmarks.api.mdx new file mode 100644 index 00000000..0822161c --- /dev/null +++ b/docs/versioned_docs/version-v0.25.0/API/search-bookmarks.api.mdx @@ -0,0 +1,71 @@ +--- +id: search-bookmarks +title: "Search bookmarks" +description: "Search bookmarks" +sidebar_label: "Search bookmarks" +hide_title: true +hide_table_of_contents: true +api: eJzNWEtv4zYQ/ivCXNoCgp3t0TdvsC3SopugSdFDoMNYGllcU6RCUs56Df33YihZkh06kbsB2lMccR7fPDnDPWRkUyMqJ7SCBdwTmrSIVlpvSjQbCzE4XFtYPMLH/lsSg6W0NsLtYPG4hxWhIbOsXQGLx6RJYqjQYEmOjPUENi2oRFjswe0qggVYZ4RaQxODoadaGMpg4UxNMSgsmeAJYhAM6Kkms4MmPi8kBlJ1yQjRphB7g4AFS9qiSonhZpRjLR0sRp+PlOco7aDdauNuTUZmAgpVlysyr0mTohTuEnuccJI/XNfG6ldFpy3F27JXWktCBSNXtP4+Dv9NHllykdORP+3z4AcbpVo5Ui56FlJGK4qESmWdURYJFbmCIkO20srSLPqsHcWRK8TAlKJiHolmTVGuTWR1SUOWzYI2/k+g9c7uxF63jCdOT9iAVo1lv/98dcV/jm24XX2hlHG6wgOzbbUZsrV0XlWHilmxqqRIkVnnXyzzB+KqvUSIoTK6IuNEq32o34EUjcEdo3ZU2rdFiCxYr6khdJQtXfC01JnIRfg4BlVLiStObQ5h0yf6BEr2k9hSFkjpJoYct5rb0blzh+u1UOt7h662b+sbOoqt05Qsd8EchawNsZtIZcyVNDHYuizRiG8+Su8vXmk3zT0tjt00p/t+/s5p0ZZI4ACdw7Sg7GMQXN+5BcRQ1CUqSJqjXvDIGjv5R9I83ahctKLb3N82rxvQnp6HIoXaeOfXRgYtmp60R8U/gV6UuKa/QmrPES+tJXcTCEkoR1JDpGyh3SVceS3lHWtqC/AS1spQavBZUvYvmLciI30RUNyKdKKjC1fK6yF13qQ/mDGNGmtXaDPNRfVKClvQNOoMHd11HNOcwhx/dD15AsNJ5XnqthASniq+r7AcfXW+sPyPUGVZXZt0YgGEoR50fC9W5MTzYP2vhzfIfS2ykiwfmEJ5y3kqJH0OdstQzV7gkRis+DYW202moXyenPthNw9OGWx9B6/XaqP0c+AK8AxJ07v2/e+vSWEeOujB7vvxlxUqReamy4WTxgldS2O6bjjz3Q0CfZJr7pwr/G04oE2aIMEwpR3NZKM56mhoOp2QwoNNNzoM6dNHIxl2lsOWCIxL0VfXLTEXp9p4BR3JGam6w7VQbOawmTaN90dJrtAZLGDdOhh5M4V5L3LeDt5sJ5ntYUv1Fz7sMcsMWdvMsRLz7QcOHBrBQH0CdcftcH/YKgvnKruYz53ZzTZocENUzbCq4HSLeSgo6iREOvdLwO8dfdRiYRtGC/Y9T/zdUD9as3tvsma2w5Px1OuJOMv8j1+0KZER/vb3gw+JULlmdra6hfRhdjW7Gm2dPZ7l3U0Q//Luxi9KR+DZWL7QtHU8xS32h60p8KJwMhf13Sj4+tCayY19XkkUfp7vRrM2rsep0kU2iaHQ1vHpfr9Cyz20afhzu69xvDNhOapnFs4xrh//7BLzp+gcpA3tumeLLcqaz/0i/kJHSzd+YJhCf3hCmELbvwm8TnzW2P9w0X7Fsy+W78G6ZKhQ//4UQ0HIvuUgt9zLNKVqzPViuWYpfdv49dMDtHPceJ88rqzxqoFqN5K937cUD3pDqmngYILj/6Hhlv0PsLS5YA== +sidebar_class_name: "get api-method" +info_path: API/karakeep-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + +<Heading + as={"h1"} + className={"openapi__heading"} + children={"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":"string","enum":["asc","desc","relevance"],"default":"relevance"},"required":false,"name":"sortOrder","in":"query"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"boolean","default":true,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks."},"required":false,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks.","name":"includeContent","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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"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","summarizationStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file |
