diff options
Diffstat (limited to 'docs/versioned_docs/version-v0.29.0/api/get-a-single-bookmark.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.29.0/api/get-a-single-bookmark.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.29.0/api/get-a-single-bookmark.api.mdx b/docs/versioned_docs/version-v0.29.0/api/get-a-single-bookmark.api.mdx new file mode 100644 index 00000000..150fe90b --- /dev/null +++ b/docs/versioned_docs/version-v0.29.0/api/get-a-single-bookmark.api.mdx @@ -0,0 +1,71 @@ +--- +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: eJzNWN9v3DYM/lcMvmwDjFw6dFhxb9di67JhbbCk2ENwD7RFn9WTJVeSL7ke/L8XlH9e4mucNsD2dD6LFD9+IinSBxDkUitLL42GJbwlHyXGbAu02yjZR9K7SAqIwePGwfIGXreLDtYxOEorK/0eljcHSAgt2VXlc1jerOt1DCVaLMiTdUHApTkVCMsD+H1JsATnrdQbiIHusCgVv5Ikhbrbb4rbj69+NXeff8nvvDfpK0YgfRDpEFwIqGOw9KmSlgQsva0oBo0FCyWDUAySPSvR51DHEzASYxShhhgEZVgp3+11TM1FFjnykTdRWO1p+sFFqdGetI9upVJRQpHUqaoEiUjqyOcUWXKl0Y7OonfGUxz5XA5KKWrWUWg3FGXGRs4U1O/uzo69zFC5/w+0nu922zeNYsf5p4rsHjgUOjOOef/5/Jx/jn14n3yklHH6fIhAgR7ZSguItbAslUyRtRYfHatOHKkJm0EMpTUlWS8bw1I8jL46htQSehIrP7laGCEzOb0cg66UwoQDk6mv+zCdIYk2zeWOxEQo1jFkuDOcXKfWPW42Um+uPPrKPW4vBtJVwRnsqjQl54BNSFVZYppIC9Za1zG4qijQys+B4uffXhs/j54Gx36erKlsOmPbASaWEmK4pYSjS/FzYRKpKFQjT9pxVMbgpN4oypoFG9ySRWmsD75UjuzFdEw19bJfQGtxz8qeCvfNgdok28QCeo9pTuL1JF29z+xmXhWoYV0fVZUbCEU+7H+0W5AbZZ/R9D4L1fzrDjSrp6EoqbcNhVZN8zc7jY7KyAx5WeCGPkyZPSW8co781DlPRWJqibTLjX+KVlYpdcmWmpLwFNXSUmrxVpH4BuWdFGSeBBR3Mp1JdO4L9WYInUfl2zB7CpzO83kGsPK5sfNYrRIlXU7zpAV6umw15gFnjb/bi2WGwr1kDdJN7qy5pfm+XPR015Sz8DCVjE15nZcz01A7G9+LFTk4AtjwdP2IeEhfNiKyQelExeYi/26ywJ68cOZWESc/j7fVVZGQ/UoKfDPNAymDr8/AeqW32txO3BpBYV331D7/lTfrmPk2+WNUbcZluGPiavwmQa3JXrTRca/6QlsXWa5tRENNgoliC00T8KFUBgXxHTpw9aSQmrqOB9/X9aTA0Lgetamj1vKoj7zfNE73en1b0zYxQ1T2h7x+OI1BHSC+PH/5sLXvZCJtfJSZSovna+lTI6ZbooKc4+N9uHaPybDDIM9U10Hf50bAEjbNyfP4uIRFP/wsDsOMWTOVZHfdpBuaGjigEJacqxdYysXuBccVWsmHHqC3yw1f7eAJufelWy4W3u7PtmhxS1SeYVnC/ZnvOqeo3SEyWZjl/mrlowYLH8loSL9iRhvL41G9p4cth8xhMZ41ghAnQXj43dgCGeGf/14HDqXODKuz1w2kF2fnZ+ejSb3Hs7q8mMS/urwIY+UReHaWb2DjPHeqy0M3Y/K3CYyajrwfEe/vexgC6ysfMxqP+VJalAplGKjaTrQ56Js+9TkBlqPPCesYcuM8ixwOCTq+BOqaXzfTLp+/kI5P+cS4Pob4H07ukyRsaT81ze9QVSwcZvkuiJ/o6o//tEn3U3TKendz6P3YZodqdAjhxskJBTdoN4dWYJWmVI7hPigsDL9P7Le/XUPTFI4n7OOoH486x7AOh0bi2mxJ13WP0vN/BljXXwC+YbOA +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={"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"},{"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 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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"userId":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"contentAssetId":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","userId","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> + + +
\ No newline at end of file |
