mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
d53a36bd09
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
58 lines
1.5 KiB
Plaintext
58 lines
1.5 KiB
Plaintext
---
|
|
title: "Response fields"
|
|
description: "Document API response fields using the ResponseField component with type annotations, descriptions, and required or optional indicators."
|
|
keywords: ["API output", "return values", "response structure"]
|
|
---
|
|
|
|
Use the `<ResponseField>` component to define the return values of an API. Many docs also use `<ResponseField>` on pages when you need to list the types of something.
|
|
|
|
<ResponseField name="response" type="string" required>
|
|
A response field example
|
|
</ResponseField>
|
|
|
|
```mdx
|
|
<ResponseField name="response" type="string" required>
|
|
A response field example
|
|
</ResponseField>
|
|
```
|
|
|
|
## Props
|
|
|
|
<ResponseField name="name" type="string" required>
|
|
The name of the response value.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="type" type="string" required>
|
|
Expected type of the response value. This can be any arbitrary string.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="default" type="string">
|
|
The default value.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="required" type="boolean">
|
|
Show "required" beside the field name.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="deprecated" type="boolean">
|
|
Whether you have deprecated a field or not.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="pre" type="string[]">
|
|
Labels that appear before the name of the field.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="post" type="string[]">
|
|
Labels that appear after the name of the field.
|
|
</ResponseField>
|
|
|
|
<RequestExample>
|
|
|
|
```mdx Response Field Example
|
|
<ResponseField name="response" type="string" required>
|
|
A response field example
|
|
</ResponseField>
|
|
```
|
|
|
|
</RequestExample>
|