ParameterContract interface
Details van bewerkingsparameters.
Eigenschappen
default |
Standaardparameterwaarde. |
description | Parameterbeschrijving. |
examples | Voorbeeld gedefinieerd voor de parameter. |
name | Parameternaam. |
required | Hiermee geeft u op of parameter is vereist of niet. |
schema |
Schema-id. |
type | Parametertype. |
type |
Typ de naam die is gedefinieerd door het schema. |
values | Parameterwaarden. |
Eigenschapdetails
defaultValue
Standaardparameterwaarde.
defaultValue?: string
Waarde van eigenschap
string
description
Parameterbeschrijving.
description?: string
Waarde van eigenschap
string
examples
Voorbeeld gedefinieerd voor de parameter.
examples?: {[propertyName: string]: ParameterExampleContract}
Waarde van eigenschap
{[propertyName: string]: ParameterExampleContract}
name
Parameternaam.
name: string
Waarde van eigenschap
string
required
Hiermee geeft u op of parameter is vereist of niet.
required?: boolean
Waarde van eigenschap
boolean
schemaId
Schema-id.
schemaId?: string
Waarde van eigenschap
string
type
Parametertype.
type: string
Waarde van eigenschap
string
typeName
Typ de naam die is gedefinieerd door het schema.
typeName?: string
Waarde van eigenschap
string
values
Parameterwaarden.
values?: string[]
Waarde van eigenschap
string[]