ParameterContract interface
Szczegóły parametrów operacji.
Właściwości
| default |
Wartość parametru domyślnego. |
| description | Opis parametru. |
| examples | Na przykład zdefiniowany dla parametru . |
| name | Nazwa parametru. |
| required | Określa, czy parametr jest wymagany, czy nie. |
| schema |
Identyfikator schematu. |
| type | Typ parametru. |
| type |
Nazwa typu zdefiniowana przez schemat. |
| values | Wartości parametrów. |
Szczegóły właściwości
defaultValue
Wartość parametru domyślnego.
defaultValue?: string
Wartość właściwości
string
description
Opis parametru.
description?: string
Wartość właściwości
string
examples
Na przykład zdefiniowany dla parametru .
examples?: {[propertyName: string]: ParameterExampleContract}
Wartość właściwości
{[propertyName: string]: ParameterExampleContract}
name
Nazwa parametru.
name: string
Wartość właściwości
string
required
Określa, czy parametr jest wymagany, czy nie.
required?: boolean
Wartość właściwości
boolean
schemaId
Identyfikator schematu.
schemaId?: string
Wartość właściwości
string
type
Typ parametru.
type: string
Wartość właściwości
string
typeName
Nazwa typu zdefiniowana przez schemat.
typeName?: string
Wartość właściwości
string
values
Wartości parametrów.
values?: string[]
Wartość właściwości
string[]