openapi-model/io.github.hfhbd.kfx.openapi/OpenApi/Parameter

Parameter

@Serializable(with = OpenApi.Parameter.CustomSerializer::class)

data class Parameter(val ref: String? = null, val name: String? = null, val position: OpenApi.Parameter.Position? = null, val description: String? = null, val required: Boolean = false, val deprecated: Boolean = false, val allowEmptyValue: Boolean = false, val schema: OpenApi.Components.Schema? = null, val example: JsonElement? = null, val examples: JsonElement? = null, val extensions: Map<String, JsonElement> = emptyMap())(source)

Constructors

constructor(ref: String? = null, name: String? = null, position: OpenApi.Parameter.Position? = null, description: String? = null, required: Boolean = false, deprecated: Boolean = false, allowEmptyValue: Boolean = false, schema: OpenApi.Components.Schema? = null, example: JsonElement? = null, examples: JsonElement? = null, extensions: Map<String, JsonElement> = emptyMap())

Types

enum Position : Enum<OpenApi.Parameter.Position>

Properties

allowEmptyValue

val allowEmptyValue: Boolean

val deprecated: Boolean

val description: String?

val example: JsonElement?

val examples: JsonElement?

val extensions: Map<String, JsonElement>

val name: String?

@SerialName(value = "in")

val position: OpenApi.Parameter.Position?

@SerialName(value = "$ref")

val ref: String?

val required: Boolean

val schema: OpenApi.Components.Schema?