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