다음을 통해 공유


OperationUpdateContract interface

API 작업 업데이트 계약 세부 정보입니다.

속성

description

작업에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다.

displayName

작업 이름입니다.

method

유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드이지만 이러한 메서드로만 제한되지는 않습니다.

policies

작업 정책

request

요청 세부 정보가 포함된 엔터티입니다.

responses

작업 응답의 배열입니다.

templateParameters

URL 템플릿 매개 변수의 컬렉션입니다.

urlTemplate

이 작업의 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다. 예: /customers/{cid}/orders/{oid}/?date={date}

속성 세부 정보

description

작업에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다.

description?: string

속성 값

string

displayName

작업 이름입니다.

displayName?: string

속성 값

string

method

유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드이지만 이러한 메서드로만 제한되지는 않습니다.

method?: string

속성 값

string

policies

작업 정책

policies?: string

속성 값

string

request

요청 세부 정보가 포함된 엔터티입니다.

request?: RequestContract

속성 값

responses

작업 응답의 배열입니다.

responses?: ResponseContract[]

속성 값

templateParameters

URL 템플릿 매개 변수의 컬렉션입니다.

templateParameters?: ParameterContract[]

속성 값

urlTemplate

이 작업의 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다. 예: /customers/{cid}/orders/{oid}/?date={date}

urlTemplate?: string

속성 값

string