Volets

Permet d’afficher des propriétés imbriquées

Utilisez des volets pour afficher ou masquer du contenu imbriqué dans les champs de réponse. Ils sont particulièrement utiles pour présenter des propriétés d’objet complexes dans la documentation d’API.

user · User Object

Show properties

full_name · string

Le nom complet de l’utilisateur

is_over_21 · boolean

Indique si l’utilisateur a plus de 21 ans

Expandable example

<ResponseField name="user" type="User Object">
  <Expandable title="propriétés">
    <ResponseField name="full_name" type="string">
      Le nom complet de l'utilisateur
    </ResponseField>

    <ResponseField name="is_over_21" type="boolean">
      Indique si l'utilisateur a plus de 21 ans
    </ResponseField>
  </Expandable>
</ResponseField>

​

Propriétés

title · string

Le nom de l’objet affiché.

defaultOpen · boolean · default: "false"

Définissez sur true pour que l’élément extensible s’ouvre au chargement de la page.