Utiliser les attributs des types de données

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.

• OAS 3.0 et Swagger 2.0 : les propriétés requises sont listées dans un élément required au niveau de l'objet.
• RAML : required

Restrictions

Définit si la propriété est disponible dans la requête, dans la réponse ou dans les deux.

• OAS 3.0 : les propriétés peuvent avoir un élément writeOnly ou readOnly avec une valeur booléenne.
• Aucun élément correspondant en Swagger 2.0 ou RAML 1.0.

Exemples

Valeurs d'exemple pour la propriété. Elles peuvent être retournées à l'aide d'un mock d'API.

• OAS 3.0 et Swagger 2.0 : la première valeur est utilisée dans l'élément example. Les autres valeurs sont ignorées.
  Note InformationsRemarque : La spécification OAS 3.0 comprend un élément examples, mais il n'est pas supporté par Talend Cloud API Designer.
• RAML : examples

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

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.

• OAS 3.0 et RAML 1.0 : uniqueItems
• Aucun élément correspondant en Swagger 2.0.

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

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

Enum

Valeurs possibles pour la propriété.

enum

Default

Valeur à utiliser si aucune valeur n'est fournie.

Default

Enum

Valeurs possibles pour la propriété.

enum

Format

Format à utiliser pour un horodatage.

• RAML 1.0 : format
• OAS 3.0 : les propriétés d'horodatage en OAS 3.0 sont définies comme des chaînes de caractères avec le format date-time. Le format d'horodatage par défaut est RFC3339, mais si rfc2616 est sélectionné, un format personnalisé date-time-rfc2616 est utilisé.
• Swagger 2.0 : 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é.

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

• RAML 1.0 : fileTypes