OperationUpdateContract interface
API Operation Update Contract details.
Properties
description | Description of the operation. May include HTML formatting tags. |
display |
Operation Name. |
method | A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. |
policies | Operation Policies |
request | An entity containing request details. |
responses | Array of Operation responses. |
template |
Collection of URL template parameters. |
url |
Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} |
Property Details
description
Description of the operation. May include HTML formatting tags.
description?: string
Property Value
string
displayName
Operation Name.
displayName?: string
Property Value
string
method
A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
method?: string
Property Value
string
policies
Operation Policies
policies?: string
Property Value
string
request
responses
templateParameters
Collection of URL template parameters.
templateParameters?: ParameterContract[]
Property Value
urlTemplate
Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
urlTemplate?: string
Property Value
string