webpage/docs/api/batch.api.mdx
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={"Batch Request"}
</Heading>
<MethodEndpoint method={"post"} path={"/api/batch"} context={"endpoint"}
</MethodEndpoint>
Execute multiple API requests in a single call.
<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"} children={"Request"}
</Heading>
<ParamsDetails parameters={undefined}
</ParamsDetails>
<RequestSchema title={"Body"} body={{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"The API endpoint path."},"method":{"type":"string","enum":["GET","POST","DELETE"],"description":"The HTTP method to be used."},"body":{"description":"The request body for the API call."}},"title":"BatchRequest"}}}},"required":true}}
</RequestSchema>
<StatusCodes id={undefined} label={undefined} responses={{"200":{"description":"Batch request executed successfully.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"The API endpoint path."},"method":{"type":"string","enum":["GET","POST","DELETE"],"description":"The HTTP method used."},"body":{"description":"The response body from the API call."},"status":{"type":"integer","description":"The HTTP status code of the response."}},"title":"BatchResponse"}}}}}}}
</StatusCodes>