Components

data class Components(val schemas: Map<String, JsonSchema>? = null, val responses: Map<String, ReferenceOr<Response>>? = null, val parameters: Map<String, ReferenceOr<Parameter>>? = null, val examples: Map<String, ReferenceOr<ExampleObject>>? = null, val requestBodies: Map<String, ReferenceOr<RequestBody>>? = null, val headers: Map<String, ReferenceOr<Header>>? = null, val securitySchemes: Map<String, ReferenceOr<SecurityScheme>>? = null, val links: Map<String, ReferenceOr<Link>>? = null, val callbacks: Map<String, ReferenceOr<Callback>>? = null, val pathItems: Map<String, ReferenceOr<PathItem>>? = null, val servers: Map<String, ReferenceOr<Server>>? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

Holds a set of reusable objects for different aspects of the OAS. All objects defined within the component object will have no effect on the API unless they are explicitly referenced from properties outside the component object.

Report a problem

Constructors

Link copied to clipboard
constructor(schemas: Map<String, JsonSchema>? = null, responses: Map<String, ReferenceOr<Response>>? = null, parameters: Map<String, ReferenceOr<Parameter>>? = null, examples: Map<String, ReferenceOr<ExampleObject>>? = null, requestBodies: Map<String, ReferenceOr<RequestBody>>? = null, headers: Map<String, ReferenceOr<Header>>? = null, securitySchemes: Map<String, ReferenceOr<SecurityScheme>>? = null, links: Map<String, ReferenceOr<Link>>? = null, callbacks: Map<String, ReferenceOr<Callback>>? = null, pathItems: Map<String, ReferenceOr<PathItem>>? = null, servers: Map<String, ReferenceOr<Server>>? = null, extensions: ExtensionProperties? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val extensions: ExtensionProperties?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard

Returns true if this object has no properties.

Link copied to clipboard

Returns true if this object has at least one property.