main.io.github.smiley4.ktorswaggerui.data.OpenApiRequestParameterData.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ktor-swagger-ui Show documentation

Ktor plugin to document routes and provide a Swagger-UI

There is a newer version: 3.4.0

package io.github.smiley4.ktorswaggerui.data

import io.swagger.v3.oas.models.parameters.Parameter

/**
 * Information about a request (query, path or header) parameter.
 */
data class OpenApiRequestParameterData(
    val name: String,
    val type: TypeDescriptor,
    val location: ParameterLocation,
    val description: String?,
    val example: ExampleDescriptor?,
    val required: Boolean,
    val deprecated: Boolean,
    val allowEmptyValue: Boolean,
    val explode: Boolean,
    val allowReserved: Boolean,
    val style: Parameter.StyleEnum?,
)