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