Partager via


ParameterContract interface

Détails des paramètres d’opération.

Propriétés

defaultValue

Valeur par défaut du paramètre.

description

Description du paramètre.

examples

Exemple défini pour le paramètre .

name

Nom du paramètre.

required

Indique si le paramètre est obligatoire ou non.

schemaId

Identificateur de schéma.

type

Type de paramètre.

typeName

Nom de type défini par le schéma.

values

Valeurs du paramètre.

Détails de la propriété

defaultValue

Valeur par défaut du paramètre.

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

Indique 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 du paramètre.

values?: string[]

Valeur de propriété

string[]