ParameterContract interface
A műveleti paraméterek részletei.
Tulajdonságok
| default |
Alapértelmezett paraméterérték. |
| description | Paraméter leírása. |
| examples | Példa a paraméterre. |
| name | Paraméter neve. |
| required | Megadja, hogy a paraméter kötelező-e vagy sem. |
| schema |
Sémaazonosító. |
| type | Paraméter típusa. |
| type |
Írja be a séma által definiált nevet. |
| values | Paraméterértékek. |
Tulajdonság adatai
defaultValue
Alapértelmezett paraméterérték.
defaultValue?: string
Tulajdonság értéke
string
description
Paraméter leírása.
description?: string
Tulajdonság értéke
string
examples
Példa a paraméterre.
examples?: {[propertyName: string]: ParameterExampleContract}
Tulajdonság értéke
{[propertyName: string]: ParameterExampleContract}
name
Paraméter neve.
name: string
Tulajdonság értéke
string
required
Megadja, hogy a paraméter kötelező-e vagy sem.
required?: boolean
Tulajdonság értéke
boolean
schemaId
Sémaazonosító.
schemaId?: string
Tulajdonság értéke
string
type
Paraméter típusa.
type: string
Tulajdonság értéke
string
typeName
Írja be a séma által definiált nevet.
typeName?: string
Tulajdonság értéke
string
values
Paraméterértékek.
values?: string[]
Tulajdonság értéke
string[]