Freigeben über


ParameterContract interface

Details zu Vorgangsparametern.

Eigenschaften

defaultValue

Standardparameterwert.

description

Beschreibung des Parameters.

examples

Beispiel, das für den Parameter definiert ist.

name

Parametername.

required

Gibt an, ob der Parameter erforderlich ist oder nicht.

schemaId

Schemabezeichner.

type

Der Parametertyp.

typeName

Typname, der durch das Schema definiert wird.

values

Parameterwerte.

Details zur Eigenschaft

defaultValue

Standardparameterwert.

defaultValue?: string

Eigenschaftswert

string

description

Beschreibung des Parameters.

description?: string

Eigenschaftswert

string

examples

Beispiel, das für den Parameter definiert ist.

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

Der Parametertyp.

type: string

Eigenschaftswert

string

typeName

Typname, der durch das Schema definiert wird.

typeName?: string

Eigenschaftswert

string

values

Parameterwerte.

values?: string[]

Eigenschaftswert

string[]