Back to Neko

Upload and Drop File

webpage/docs/api/upload-drop.api.mdx

3.1.42.2 KB
Original Source

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={"Upload and Drop File"}

</Heading>

<MethodEndpoint method={"post"} path={"/api/room/upload/drop"} context={"endpoint"}

</MethodEndpoint>

Upload a file and drop it at a specified location.

<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"} children={"Request"}

</Heading>

<ParamsDetails parameters={undefined}

</ParamsDetails>

<RequestSchema title={"Body"} body={{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"x":{"type":"number","description":"X coordinate of drop."},"y":{"type":"number","description":"Y coordinate of drop."},"files":{"type":"array","description":"Files to be uploaded.","items":{"type":"string","format":"binary"}}}}}},"required":true}}

</RequestSchema>

<StatusCodes id={undefined} label={undefined} responses={{"204":{"description":"File uploaded and dropped successfully."},"400":{"description":"Unable to upload file.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"500":{"description":"Unable to process uploaded file.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}

</StatusCodes>