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