Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 948 Bytes

responses.mdx

File metadata and controls

39 lines (29 loc) · 948 Bytes
title description icon
Response Fields
Display API response values
message

The <ResponseField> component is designed to define the return values of an API. Many docs also use <ResponseField> on pages when you need to list the types of something.

A response field example 
<ResponseField name="response" type="string" required>
  A response field example
</ResponseField>

Props

The name of the response value. Expected type of the response value The default value. Show "required" beside the field name.