ParameterContract interface
Dettagli dei parametri dell'operazione.
Proprietà
| default |
Valore del parametro predefinito. |
| description | Descrizione del parametro. |
| examples | Esempio definito per il parametro . |
| name | Nome parametro. |
| required | Specifica se il parametro è obbligatorio o meno. |
| schema |
Identificatore dello schema. |
| type | Tipo di parametro. |
| type |
Nome del tipo definito dallo schema. |
| values | Valori dei parametri. |
Dettagli proprietà
defaultValue
Valore del parametro predefinito.
defaultValue?: string
Valore della proprietà
string
description
Descrizione del parametro.
description?: string
Valore della proprietà
string
examples
Esempio definito per il parametro .
examples?: {[propertyName: string]: ParameterExampleContract}
Valore della proprietà
{[propertyName: string]: ParameterExampleContract}
name
Nome parametro.
name: string
Valore della proprietà
string
required
Specifica se il parametro è obbligatorio o meno.
required?: boolean
Valore della proprietà
boolean
schemaId
Identificatore dello schema.
schemaId?: string
Valore della proprietà
string
type
Tipo di parametro.
type: string
Valore della proprietà
string
typeName
Nome del tipo definito dallo schema.
typeName?: string
Valore della proprietà
string
values
Valori dei parametri.
values?: string[]
Valore della proprietà
string[]