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[]