Partilhar via


OperationQueryParameter interface

Um parâmetro para uma operação que será adicionado 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, para que tipo de formato o valor deve ser convertido.

skipEncoding

Se deve 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 de Propriedade

collectionFormat

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

collectionFormat?: QueryCollectionFormat

Valor de Propriedade

skipEncoding

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

skipEncoding?: boolean

Valor de Propriedade

boolean

Detalhes da Propriedade Herdada

mapper

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

mapper: Mapper

Valor de Propriedade

herdado de OperationParameter.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 de Propriedade

herdado de OperationParameter.parameterPath