swagger-model/io.github.hfhbd.kfx.swagger/Swagger

Swagger

data class Swagger(val version: String, val info: Swagger.Info, val host: String? = null, val basePath: String? = null, val schemes: List<Swagger.Schema> = emptyList(), val consumes: List<String> = emptyList(), val produces: List<String> = emptyList(), val paths: Map<String, Swagger.Paths>, val definitions: Map<String, Swagger.Definition>, val parameters: Map<String, Swagger.Parameter> = emptyMap(), val responses: Map<String, Swagger.Path.Response> = emptyMap(), val securityDefinitions: Map<String, Swagger.SecurityDefinition>? = null, val security: List<Map<String, List<String>>> = emptyList(), val tags: List<Swagger.Tag> = emptyList(), val externalDocs: Swagger.ExternalDocs? = null)(source)

Constructors

Swagger

constructor(version: String, info: Swagger.Info, host: String? = null, basePath: String? = null, schemes: List<Swagger.Schema> = emptyList(), consumes: List<String> = emptyList(), produces: List<String> = emptyList(), paths: Map<String, Swagger.Paths>, definitions: Map<String, Swagger.Definition>, parameters: Map<String, Swagger.Parameter> = emptyMap(), responses: Map<String, Swagger.Path.Response> = emptyMap(), securityDefinitions: Map<String, Swagger.SecurityDefinition>? = null, security: List<Map<String, List<String>>> = emptyList(), tags: List<Swagger.Tag> = emptyList(), externalDocs: Swagger.ExternalDocs? = null)

Types

Definition

@Serializable

data class Definition(val required: List<String> = emptyList(), val properties: Map<String, Swagger.Definition> = emptyMap(), val description: String? = null, val additionalProperties: Swagger.Definition? = null, val readOnly: Boolean? = null, val example: JsonElement? = null, val items: Swagger.Definition? = null, val ref: String? = null, val allOf: List<Swagger.Definition> = emptyList(), val default: JsonElement? = null, val discriminator: String? = null, val types: List<Swagger.Definition.Type> = listOf(Type.Object), val minLength: Int? = null, val maxLength: Int? = null, val format: String? = null, val nullable: Boolean = false, val enum: Set<String> = emptySet(), val minimum: Int? = null, val maximum: Int? = null, val minItems: Int? = null, val maxItems: Int? = null)

ExternalDocs

@Serializable

data class ExternalDocs(val description: String? = null, val url: String)

Header

@Serializable

data class Header(val description: String? = null, val type: Swagger.Header.Type, val format: String? = null, val items: Swagger.Definition? = null, val collectionFormat: Swagger.Header.CollectionFormat = CollectionFormat.Csv, val default: JsonElement? = null, val maximum: Int? = null, val exclusiveMaximum: Boolean? = null, val minimum: Int? = null, val exclusiveMinimum: Boolean? = null, val maxLength: Int? = null, val minLength: Int? = null, val pattern: String? = null, val maxItems: Int? = null, val minItems: Int? = null, val uniqueItems: Int? = null, val enum: Set<String> = emptySet(), val multipleOf: Int? = null)

Info

@Serializable

data class Info(val title: String, val description: String? = null, val version: String)

Parameter

@Serializable

data class Parameter(val name: String? = null, val description: String? = null, val position: Swagger.Parameter.Position? = null, val required: Boolean? = null, val type: Swagger.Parameter.Types? = null, val enum: Set<String> = emptySet(), val default: JsonElement? = null, val minimum: JsonElement? = null, val maximum: JsonElement? = null, val schema: Swagger.Definition? = null, val ref: String? = null, val items: Swagger.Definition? = null)

Path

@Serializable

data class Path(val description: String? = null, val operationId: String? = null, val tags: List<String> = emptyList(), val produces: List<String> = emptyList(), val consumes: List<String> = emptyList(), val parameters: List<Swagger.Parameter> = emptyList(), val responses: Map<String, Swagger.Path.Response>, val deprecated: Boolean = false)

Paths

@Serializable

data class Paths(val head: Swagger.Path? = null, val get: Swagger.Path? = null, val post: Swagger.Path? = null, val put: Swagger.Path? = null, val patch: Swagger.Path? = null, val delete: Swagger.Path? = null)

Schema

@Serializable

enum Schema : Enum<Swagger.Schema>

SecurityDefinition

@Serializable

sealed interface SecurityDefinition

Tag

@Serializable

data class Tag(val name: String)