Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OperationUpdateContract

Package version

API Operation Update Contract details.

Hierarchy

  • OperationUpdateContract

Index

Properties

Optional description

description: undefined | string

Description of the operation. May include HTML formatting tags.

Optional displayName

displayName: undefined | string

Operation Name.

Optional method

method: undefined | string

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.

Optional policies

policies: undefined | string

Operation Policies

Optional request

An entity containing request details.

Optional responses

responses: ResponseContract[]

Array of Operation responses.

Optional templateParameters

templateParameters: ParameterContract[]

Collection of URL template parameters.

Optional urlTemplate

urlTemplate: undefined | string

Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}

Generated using TypeDoc