OperationQueryParameter interface

A parameter for an operation that will be added as a query parameter to the operation's HTTP request.

Extends

Properties

collectionFormat

If this query parameter's value is a collection, what type of format should the value be converted to.

skipEncoding

Whether or not to skip encoding the query parameter's value before adding it to the URL.

Inherited Properties

mapper

The mapper that defines how to validate and serialize this parameter's value.

parameterPath

The path to this parameter's value in OperationArguments or the object that contains paths for each property's value in OperationArguments.

Property Details

collectionFormat

If this query parameter's value is a collection, what type of format should the value be converted to.

collectionFormat?: QueryCollectionFormat

Property Value

skipEncoding

Whether or not to skip encoding the query parameter's value before adding it to the URL.

skipEncoding?: boolean

Property Value

boolean

Inherited Property Details

mapper

The mapper that defines how to validate and serialize this parameter's value.

mapper: Mapper

Property Value

Inherited From OperationParameter.mapper

parameterPath

The path to this parameter's value in OperationArguments or the object that contains paths for each property's value in OperationArguments.

parameterPath: ParameterPath

Property Value

Inherited From OperationParameter.parameterPath