common-plugin/dev.akif.tapik.plugin.metadata/QueryParameterMetadata

QueryParameterMetadata

data class QueryParameterMetadata(val name: String, val type: TypeMetadata, val required: Boolean, val default: Option<String?>) : ParameterMetadata(source)

Metadata describing a Tapik query parameter.

Constructors

QueryParameterMetadata

constructor(name: String, type: TypeMetadata, required: Boolean, default: Option<String?>)

Properties

val default: Option<String?>

optional default value applied when the parameter is omitted.

val name: String

query parameter name.

val required: Boolean

whether the parameter must be supplied by callers.

val type: TypeMetadata

Kotlin type metadata for the parameter.

Functions

toGeneratedTypeInfo

fun QueryParameterMetadata.toGeneratedTypeInfo(): GeneratedQueryParameterTypeInfo

Resolves the Kotlin argument type information used by generated clients/controllers for a query parameter.