Compartilhar via


OperationQueryParameter interface

Um parâmetro para uma operação que será adicionada como um parâmetro de consulta à solicitação HTTP da operação.

Extends

Propriedades

collectionFormat

Se o valor desse parâmetro de consulta for uma coleção, em que tipo de formato o valor deve ser convertido.

skipEncoding

Se deseja ou não ignorar a codificação do valor do parâmetro de consulta antes de adicioná-lo à URL.

Propriedades herdadas

mapper

O mapeador que define como validar e serializar o valor desse parâmetro.

parameterPath

O caminho para o valor desse parâmetro em OperationArguments ou o objeto que contém caminhos para o valor de cada propriedade em OperationArguments.

Detalhes da propriedade

collectionFormat

Se o valor desse parâmetro de consulta for uma coleção, em que tipo de formato o valor deve ser convertido.

collectionFormat?: QueryCollectionFormat

Valor da propriedade

skipEncoding

Se deseja ou não ignorar a codificação do valor do parâmetro de consulta antes de adicioná-lo à URL.

skipEncoding?: boolean

Valor da propriedade

boolean

Detalhes das propriedades herdadas

mapper

O mapeador que define como validar e serializar o valor desse parâmetro.

mapper: Mapper

Valor da propriedade

Herdado deOperationParameter.mapper

parameterPath

O caminho para o valor desse parâmetro em OperationArguments ou o objeto que contém caminhos para o valor de cada propriedade em OperationArguments.

parameterPath: ParameterPath

Valor da propriedade

Herdado deOperationParameter.parameterPath