ParameterContract interface
操作パラメーターの詳細。
プロパティ
default |
パラメーターの既定値。 |
description | パラメーターの説明。 |
examples | パラメーターに対して定義された例。 |
name | パラメーター名です。 |
required | パラメーターが必要かどうかを指定します。 |
schema |
スキーマ識別子。 |
type | パラメーターの型。 |
type |
スキーマによって定義された型名。 |
values | パラメーター値。 |
プロパティの詳細
defaultValue
パラメーターの既定値。
defaultValue?: string
プロパティ値
string
description
パラメーターの説明。
description?: string
プロパティ値
string
examples
パラメーターに対して定義された例。
examples?: {[propertyName: string]: ParameterExampleContract}
プロパティ値
{[propertyName: string]: ParameterExampleContract}
name
パラメーター名です。
name: string
プロパティ値
string
required
パラメーターが必要かどうかを指定します。
required?: boolean
プロパティ値
boolean
schemaId
スキーマ識別子。
schemaId?: string
プロパティ値
string
type
パラメーターの型。
type: string
プロパティ値
string
typeName
スキーマによって定義された型名。
typeName?: string
プロパティ値
string
values
パラメーター値。
values?: string[]
プロパティ値
string[]