Parameter and Expandable

Parameter renders the name/type/description row used throughout API reference content; Expandable wraps a nested set of them behind a “Show/Hide” toggle for a nested object’s own properties — the same pattern used on this site’s own OpenAPI-generated pages:

userUser Object

Hide properties

full_namestring

The full name of the user

is_over_21boolean

Whether the user is over 21 years old

<Parameter name="user" type="User Object">
  <Expandable title="properties">
    <Parameter name="full_name" type="string">
      The full name of the user
    </Parameter>
    <Parameter name="is_over_21" type="boolean">
      Whether the user is over 21 years old
    </Parameter>
  </Expandable>
</Parameter>

Every field table across this documentation (writedocs.json’s own configuration pages included) is written with Parameter rather than a plain Markdown table — the same reason it exists here: a name, an optional type badge, an optional “required”/“default” label, and a description that can hold more than a single table cell’s worth of prose.

Parameter props

namestringrequired

typestring

Omit to render with no type badge.

requiredboolean

Shows a red “required” label.

defaultany

Shows a “default: …” label. Any value works, including default={10} or default={false}.

deprecatedboolean

Shows an amber “deprecated” label and strikes the name through.

prestring[]

Extra labels shown before the name, e.g. pre={["readonly"]}.

poststring[]

Extra labels shown after the badges.

<ParamField> and <ResponseField> are the same row under Mintlify’s names, with the same props. ParamField also takes the name from Mintlify’s location props: <ParamField path="id">, query="limit", body="email", or header="Authorization".

Expandable props

titlestringdefault: "properties"

defaultOpenbooleandefault: true