Ariadocs

OpenAPI.Response

Edit on GitHub

The responses an endpoint can return.

Preview
200

OK

<OpenAPI.Operation id="emails-send">
  <OpenAPI.Operation.Responses />
</OpenAPI.Operation>

Each status code gets a row, colored by type: success, redirect, client error or server error. Open a row to see the response headers and body fields. Write-only fields are hidden, since the server doesn't return them.

To render a single response with your own layout:

<OpenAPI.Response response={operation.responses[0]}>
  <OpenAPI.Response.Status />
  <OpenAPI.Response.Description />
  <OpenAPI.Response.Content />
</OpenAPI.Response>