ParameterContract interface
Podrobnosti o parametrech operace
Vlastnosti
default |
Výchozí hodnota parametru. |
description | Popis parametru. |
examples | Příklad definovaný pro parametr. |
name | Názvy parametrů. |
required | Určuje, jestli je parametr povinný nebo ne. |
schema |
Identifikátor schématu. |
type | Typ parametru. |
type |
Zadejte název definovaný schématem. |
values | Hodnoty parametrů. |
Podrobnosti vlastnosti
defaultValue
Výchozí hodnota parametru.
defaultValue?: string
Hodnota vlastnosti
string
description
Popis parametru.
description?: string
Hodnota vlastnosti
string
examples
Příklad definovaný pro parametr.
examples?: {[propertyName: string]: ParameterExampleContract}
Hodnota vlastnosti
{[propertyName: string]: ParameterExampleContract}
name
Názvy parametrů.
name: string
Hodnota vlastnosti
string
required
Určuje, jestli je parametr povinný nebo ne.
required?: boolean
Hodnota vlastnosti
boolean
schemaId
Identifikátor schématu.
schemaId?: string
Hodnota vlastnosti
string
type
Typ parametru.
type: string
Hodnota vlastnosti
string
typeName
Zadejte název definovaný schématem.
typeName?: string
Hodnota vlastnosti
string
values
Hodnoty parametrů.
values?: string[]
Hodnota vlastnosti
string[]