final case class Components(schemas: Map[Key, SchemaOrReference], responses: Map[Key, ResponseOrReference], parameters: Map[Key, ParameterOrReference], examples: Map[Key, ExampleOrReference], requestBodies: Map[Key, RequestBodyOrReference], headers: Map[Key, HeaderOrReference], securitySchemes: Map[Key, SecuritySchemeOrReference], links: Map[Key, LinkOrReference], callbacks: Map[Key, CallbackOrReference]) extends OpenAPIBase with Product with Serializable
Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.
- schemas
An object to hold reusable Schema Objects.
- responses
An object to hold reusable Response Objects.
- parameters
An object to hold reusable Parameter Objects.
- examples
An object to hold reusable Example Objects.
- requestBodies
An object to hold reusable Request Body Objects.
- headers
An object to hold reusable Header Objects.
- securitySchemes
An object to hold reusable Security Scheme Objects.
- links
An object to hold reusable Link Objects.
- callbacks
An object to hold reusable Callback Objects.
- Alphabetic
- By Inheritance
- Components
- Serializable
- Product
- Equals
- OpenAPIBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Components(schemas: Map[Key, SchemaOrReference], responses: Map[Key, ResponseOrReference], parameters: Map[Key, ParameterOrReference], examples: Map[Key, ExampleOrReference], requestBodies: Map[Key, RequestBodyOrReference], headers: Map[Key, HeaderOrReference], securitySchemes: Map[Key, SecuritySchemeOrReference], links: Map[Key, LinkOrReference], callbacks: Map[Key, CallbackOrReference])
- schemas
An object to hold reusable Schema Objects.
- responses
An object to hold reusable Response Objects.
- parameters
An object to hold reusable Parameter Objects.
- examples
An object to hold reusable Example Objects.
- requestBodies
An object to hold reusable Request Body Objects.
- headers
An object to hold reusable Header Objects.
- securitySchemes
An object to hold reusable Security Scheme Objects.
- links
An object to hold reusable Link Objects.
- callbacks
An object to hold reusable Callback Objects.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val callbacks: Map[Key, CallbackOrReference]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val examples: Map[Key, ExampleOrReference]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- val headers: Map[Key, HeaderOrReference]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val links: Map[Key, LinkOrReference]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- val parameters: Map[Key, ParameterOrReference]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val requestBodies: Map[Key, RequestBodyOrReference]
- val responses: Map[Key, ResponseOrReference]
- val schemas: Map[Key, SchemaOrReference]
- val securitySchemes: Map[Key, SecuritySchemeOrReference]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toJson: String
- Definition Classes
- Components → OpenAPIBase
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])