OperationQueryParameter interface

操作の HTTP 要求にクエリ パラメーターとして追加される操作のパラメーター。

Extends

プロパティ

collectionFormat

このクエリ パラメーターの値がコレクションの場合、値を変換する必要がある形式の種類。

skipEncoding

URL に追加する前に、クエリ パラメーターの値のエンコードをスキップするかどうか。

継承されたプロパティ

mapper

このパラメーターの値を検証およびシリアル化する方法を定義するマッパー。

parameterPath

OperationArguments のこのパラメーターの値へのパス、または OperationArguments の各プロパティの値のパスを含む オブジェクト。

プロパティの詳細

collectionFormat

このクエリ パラメーターの値がコレクションの場合、値を変換する必要がある形式の種類。

collectionFormat?: QueryCollectionFormat

プロパティ値

skipEncoding

URL に追加する前に、クエリ パラメーターの値のエンコードをスキップするかどうか。

skipEncoding?: boolean

プロパティ値

boolean

継承されたプロパティの詳細

mapper

このパラメーターの値を検証およびシリアル化する方法を定義するマッパー。

mapper: Mapper

プロパティ値

OperationParameter.mapperから継承

parameterPath

OperationArguments のこのパラメーターの値へのパス、または OperationArguments の各プロパティの値のパスを含む オブジェクト。

parameterPath: ParameterPath

プロパティ値

OperationParameter.parameterPathから継承