diff --git a/components/fields.mdx b/components/fields.mdx index 196fae391..2bf07ab7d 100644 --- a/components/fields.mdx +++ b/components/fields.mdx @@ -6,6 +6,10 @@ icon: 'letter-text' There are two types of fields: Parameter Fields and Response Fields. + +Use Parameter Fields to document your API inputs and Response Fields to document your API outputs. This creates a consistent structure that helps developers understand your API quickly. + + ## Parameter Field A `ParamField` component is used to define the parameters for your APIs or SDKs. Adding a `ParamField` will automatically add an [API Playground](/api-playground/overview).