ParameterContract interface
Détails des paramètres d’opération.
Propriétés
| default |
Valeur de paramètre par défaut. |
| description | Description du paramètre. |
| examples | Exemple défini pour le paramètre. |
| name | Nom du paramètre. |
| required | Spécifie si le paramètre est obligatoire ou non. |
| schema |
Identificateur de schéma. |
| type | Type de paramètre. |
| type |
Nom de type défini par le schéma. |
| values | Valeurs des paramètres. |
Détails de la propriété
defaultValue
Valeur de paramètre par défaut.
defaultValue?: string
Valeur de propriété
string
description
Description du paramètre.
description?: string
Valeur de propriété
string
examples
Exemple défini pour le paramètre.
examples?: {[propertyName: string]: ParameterExampleContract}
Valeur de propriété
{[propertyName: string]: ParameterExampleContract}
name
Nom du paramètre.
name: string
Valeur de propriété
string
required
Spécifie si le paramètre est obligatoire ou non.
required?: boolean
Valeur de propriété
boolean
schemaId
Identificateur de schéma.
schemaId?: string
Valeur de propriété
string
type
Type de paramètre.
type: string
Valeur de propriété
string
typeName
Nom de type défini par le schéma.
typeName?: string
Valeur de propriété
string
values
Valeurs des paramètres.
values?: string[]
Valeur de propriété
string[]