# Utiliser les attributs des types de données

Les tableaux suivants décrivent les attributs pouvant être définis pour les différents types de données.

## Attributs généraux

Ces attributs sont disponibles pour tous les types de données.

| Champ | Description | Élément correspondant en OAS/Swagger et RAML |
| --- | --- | --- |
| Name (Nom) | Nom du type de données ou de la propriété. | Élément racine du type de données ou de la définition de la propriété. |
| Description | Description de la propriété. | description |
| Requise | Booléen, définit si une propriété est requise ou facultative. | <ul> <li>OAS 3.0 et Swagger 2.0&nbsp;: les propriétés requises sont listées dans un élément <span>required</span> au niveau de l'objet.</li> <li>RAML&nbsp;: <span>required</span> </li> </ul> |
| Restrictions | Définit si la propriété est disponible dans la requête, dans la réponse ou dans les deux. | <ul> <li>OAS 3.0&nbsp;: les propriétés peuvent avoir un élément <span>writeOnly</span> ou <span>readOnly</span> avec une valeur booléenne.</li> <li>Aucun élément correspondant en Swagger 2.0 ou RAML 1.0.</li> </ul> |
| Exemples | Valeurs d'exemple pour la propriété. Elles peuvent être retournées à l'aide d'un mock d'API. | <ul> <li>OAS 3.0 et Swagger 2.0&nbsp;: la première valeur est utilisée dans l'élément <span>example</span>. Les autres valeurs sont ignorées. <div><span>Note Informations</span><span>Remarque :</span> La spécification OAS 3.0 comprend un élément <span>examples</span>, mais il n'est pas supporté par <span>Talend Cloud API Designer</span>.</div> </li> <li>RAML&nbsp;: <span>examples</span> </li> </ul> |

## Attributs d'objet

| Champ | Description | Élément correspondant en OAS/Swagger et RAML |
| --- | --- | --- |
| Additional Properties (Propriétés supplémentaires) | Booléen, définit si l'objet accepte les propriétés non incluses dans la définition du type de données. Ceci est activé par défaut. | additionalProperties |

## Attributs de tableaux

| Champ | Description | Élément correspondant en OAS/Swagger et RAML |
| --- | --- | --- |
| Min items et Max items | Nombre minimal et nombre maximal d'éléments dans un tableau. | minItems et maxItems |
| Unique items | Booléen, définit si chaque élément dans un tableau doit être unique. | <ul> <li>OAS 3.0 et RAML 1.0&nbsp;: <span>uniqueItems</span> </li> <li>Aucun élément correspondant en Swagger 2.0.</li> </ul> |

## Attributs de chaînes de caractères

| Champ | Description | Élément correspondant en OAS/Swagger et RAML |
| --- | --- | --- |
| Enum | Valeurs possibles pour la propriété. | enum |
| Min length et Max length | Nombre minimal et nombre maximal d'octets dans la valeur. | minLength et maxLength |
| Pattern (Modèle) | Expression régulière à laquelle la valeur doit correspondre. | pattern |
| Default | Valeur à utiliser si aucune valeur n'est fournie. | Default |

## Attributs de nombres et d'entiers

| Champ | Description | Élément correspondant en OAS/Swagger et RAML |
| --- | --- | --- |
| Enum | Valeurs possibles pour la propriété. | enum |
| Format | Format à utiliser pour un nombre ou un entier. | format |
| Minimum et Maximum | Valeur minimale et valeur maximale d'un nombre ou d'un entier. | minimum et maximum |
| Default | Valeur à utiliser si aucune valeur n'est fournie. | Default |

## Attributs de date et heure

| Champ | Description | Élément correspondant en OAS/Swagger et RAML |
| --- | --- | --- |
| Enum | Valeurs possibles pour la propriété. | enum |
| Default | Valeur à utiliser si aucune valeur n'est fournie. | Default |

## Attributs d'horodatage (Datetime)

| Champ | Description | Élément correspondant en OAS/Swagger et RAML |
| --- | --- | --- |
| Enum | Valeurs possibles pour la propriété. | enum |
| Format | Format à utiliser pour un horodatage. | <ul> <li>RAML 1.0&nbsp;: <span>format</span> </li> <li>OAS 3.0&nbsp;: les propriétés d'horodatage en OAS 3.0 sont définies comme des chaînes de caractères avec le format <span>date-time</span>. Le format d'horodatage par défaut est RFC3339, mais si <kbd>rfc2616</kbd> est sélectionné, un format personnalisé <span>date-time-rfc2616</span> est utilisé.</li> <li>Swagger 2.0&nbsp;: les propriétés d'horodatage sont définies de la même manière qu'en OAS 3.0, mais Swagger 2.0 ne supporte pas les formats personnalisés.                             Ils seront interprétés comme RFC3339, quel que soit le format sélectionné.</li> </ul> |

## Attributs de fichiers

| Champ | Description | Élément correspondant en OAS/Swagger et RAML |
| --- | --- | --- |
| Min length et Max length | Nombre minimal et nombre maximal d'octets dans la valeur. | minLength et maxLength |
| File types | Type de fichier à utiliser, au format \*/\*. Par exemple : image/png | <ul> <li>RAML 1.0&nbsp;: <span>fileTypes</span> </li> </ul> |