Udostępnij za pośrednictwem


OperationUpdateContract interface

Szczegóły kontraktu aktualizacji operacji interfejsu API.

Właściwości

description

Opis operacji. Może zawierać tagi formatowania HTML.

displayName

Nazwa operacji.

method

Prawidłowa metoda operacji HTTP. Typowe metody HTTP, takie jak GET, PUT, POST, ale nie tylko przez nie.

policies

Zasady operacji

request

Jednostka zawierająca szczegóły żądania.

responses

Tablica odpowiedzi operacji.

templateParameters

Kolekcja parametrów szablonu adresu URL.

urlTemplate

Względny szablon adresu URL identyfikujący zasób docelowy dla tej operacji. Może zawierać parametry. Przykład: /customers/{cid}/orders/{oid}/?date={date}

Szczegóły właściwości

description

Opis operacji. Może zawierać tagi formatowania HTML.

description?: string

Wartość właściwości

string

displayName

Nazwa operacji.

displayName?: string

Wartość właściwości

string

method

Prawidłowa metoda operacji HTTP. Typowe metody HTTP, takie jak GET, PUT, POST, ale nie tylko przez nie.

method?: string

Wartość właściwości

string

policies

Zasady operacji

policies?: string

Wartość właściwości

string

request

Jednostka zawierająca szczegóły żądania.

request?: RequestContract

Wartość właściwości

responses

Tablica odpowiedzi operacji.

responses?: ResponseContract[]

Wartość właściwości

templateParameters

Kolekcja parametrów szablonu adresu URL.

templateParameters?: ParameterContract[]

Wartość właściwości

urlTemplate

Względny szablon adresu URL identyfikujący zasób docelowy dla tej operacji. Może zawierać parametry. Przykład: /customers/{cid}/orders/{oid}/?date={date}

urlTemplate?: string

Wartość właściwości

string