Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OperationSpec

Package version

A specification that defines an operation.

Hierarchy

  • OperationSpec

Index

Properties

Optional baseUrl

baseUrl: undefined | string

The URL that was provided in the service's specification. This will still have all of the URL template variables in it. If this is not provided when the OperationSpec is created, then it will be populated by a "baseUri" property on the ServiceClient.

Optional contentType

contentType: undefined | string

The content type of the request body. This value will be used as the "Content-Type" header if it is provided.

Optional formDataParameters

formDataParameters: ReadonlyArray<OperationParameter>

The parameters to the operation method that will be used to create a formdata body for the operation's HTTP request.

Optional headerParameters

headerParameters: ReadonlyArray<OperationParameter>

The parameters to the operation method that will be converted to headers on the operation's HTTP request.

httpMethod

httpMethod: HttpMethods

The HTTP method that should be used by requests for this operation.

Optional isXML

isXML: undefined | false | true

Whether or not this operation uses XML request and response bodies.

Optional path

path: undefined | string

The fixed path for this operation's URL. This will still have all of the URL template variables in it.

Optional queryParameters

queryParameters: ReadonlyArray<OperationQueryParameter>

The parameters to the operation method that will be added to the constructed URL's query.

Optional requestBody

requestBody: OperationParameter

The parameter that will be used to construct the HTTP request's body.

responses

responses: object

The different types of responses that this operation can return based on what status code is returned.

Type declaration

serializer

serializer: Serializer

The serializer to use in this operation.

Optional urlParameters

urlParameters: ReadonlyArray<OperationURLParameter>

The parameters to the operation method that will be substituted into the constructed URL.

Generated using TypeDoc