ParameterContract interface
Vorgangsparameterdetails.
Eigenschaften
| default |
Standardwert. |
| description | Parameterbeschreibung. |
| examples | Beispiel für den Parameter. |
| name | Parametername. |
| required | Gibt an, ob der Parameter erforderlich ist oder nicht. |
| schema |
Schemabezeichner. |
| type | Parametertyp. |
| type |
Typname, der durch das Schema definiert ist. |
| values | Parameterwerte. |
Details zur Eigenschaft
defaultValue
Standardwert.
defaultValue?: string
Eigenschaftswert
string
description
Parameterbeschreibung.
description?: string
Eigenschaftswert
string
examples
Beispiel für den Parameter.
examples?: {[propertyName: string]: ParameterExampleContract}
Eigenschaftswert
{[propertyName: string]: ParameterExampleContract}
name
Parametername.
name: string
Eigenschaftswert
string
required
Gibt an, ob der Parameter erforderlich ist oder nicht.
required?: boolean
Eigenschaftswert
boolean
schemaId
Schemabezeichner.
schemaId?: string
Eigenschaftswert
string
type
Parametertyp.
type: string
Eigenschaftswert
string
typeName
Typname, der durch das Schema definiert ist.
typeName?: string
Eigenschaftswert
string
values
Parameterwerte.
values?: string[]
Eigenschaftswert
string[]