Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OperationQueryParameter

Package version

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

Hierarchy

Index

Properties

Optional collectionFormat

collectionFormat: QueryCollectionFormat

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

mapper

mapper: Mapper

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

parameterPath

parameterPath: ParameterPath

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

Optional skipEncoding

skipEncoding: undefined | false | true

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

Generated using TypeDoc