openapi-model/io.github.hfhbd.kfx.openapi/OpenApi/Components/Schema/OBJECT

OBJECT

@Serializable(with = OpenApi.Components.Schema.OBJECT.CustomSerializer::class)

@SerialName(value = "object")

data class OBJECT(val ref: String? = null, val required: List<String>? = null, val properties: OpenApi.Components.Schema.OBJECT.Properties = emptyProperties(), val additionalProperties: JsonElement? = null, val description: String? = null, val title: String? = null, val extensions: Map<String, JsonElement> = emptyMap(), val discriminator: OpenApi.Components.Schema.OBJECT.Discriminator? = null, val oneOf: OpenApi.Components.Schema.OBJECT.OneOf = emptyOneOf(), val allOf: OpenApi.Components.Schema.OBJECT.OneOf = emptyOneOf(), val anyOf: OpenApi.Components.Schema.OBJECT.OneOf = emptyOneOf(), val example: JsonElement? = null, val nullable: Boolean? = null, val maxProperties: Int? = null, val enum: List<String> = emptyList(), val deprecated: Boolean = false, val readOnly: Boolean = false) : OpenApi.Components.Schema(source)

Constructors

OBJECT

constructor(ref: String? = null, required: List<String>? = null, properties: OpenApi.Components.Schema.OBJECT.Properties = emptyProperties(), additionalProperties: JsonElement? = null, description: String? = null, title: String? = null, extensions: Map<String, JsonElement> = emptyMap(), discriminator: OpenApi.Components.Schema.OBJECT.Discriminator? = null, oneOf: OpenApi.Components.Schema.OBJECT.OneOf = emptyOneOf(), allOf: OpenApi.Components.Schema.OBJECT.OneOf = emptyOneOf(), anyOf: OpenApi.Components.Schema.OBJECT.OneOf = emptyOneOf(), example: JsonElement? = null, nullable: Boolean? = null, maxProperties: Int? = null, enum: List<String> = emptyList(), deprecated: Boolean = false, readOnly: Boolean = false)

Types

Discriminator

@Serializable

data class Discriminator(val propertyName: String, val mapping: Map<String, String> = emptyMap())

OneOf

@Serializable

@JvmInline

value class OneOf(oneOf: List<OpenApi.Components.Schema>) : List<OpenApi.Components.Schema>

Properties

@Serializable

@JvmInline

value class Properties(properties: Map<String, OpenApi.Components.Schema>) : Map<String, OpenApi.Components.Schema>

Properties

additionalProperties

open override val additionalProperties: JsonElement?

additionalPropertiesSchema

val additionalPropertiesSchema: Nothing?

allOf

val allOf: OpenApi.Components.Schema.OBJECT.OneOf

anyOf

val anyOf: OpenApi.Components.Schema.OBJECT.OneOf

deprecated

open override val deprecated: Boolean

description

open override val description: String?

discriminator

val discriminator: OpenApi.Components.Schema.OBJECT.Discriminator?

enum

val enum: List<String>

example

val example: JsonElement?

extensions

open override val extensions: Map<String, JsonElement>

maxProperties

val maxProperties: Int?

nullable

open override val nullable: Boolean?

oneOf

val oneOf: OpenApi.Components.Schema.OBJECT.OneOf

properties

val properties: OpenApi.Components.Schema.OBJECT.Properties

readOnly

open override val readOnly: Boolean

ref

@SerialName(value = "$ref")

val ref: String?

required

val required: List<String>?

title

open override val title: String?