final case class Components(schemas: ListMap[Key, ReferenceOr[JsonSchema]] = ListMap.empty, responses: ListMap[Key, ReferenceOr[Response]] = ListMap.empty, parameters: ListMap[Key, ReferenceOr[Parameter]] = ListMap.empty, examples: ListMap[Key, ReferenceOr[Example]] = ListMap.empty, requestBodies: ListMap[Key, ReferenceOr[RequestBody]] = ListMap.empty, headers: ListMap[Key, ReferenceOr[Header]] = ListMap.empty, securitySchemes: ListMap[Key, ReferenceOr[SecurityScheme]] = ListMap.empty, links: ListMap[Key, ReferenceOr[Link]] = ListMap.empty, callbacks: ListMap[Key, ReferenceOr[Callback]] = ListMap.empty) extends 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
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Components(schemas: ListMap[Key, ReferenceOr[JsonSchema]] = ListMap.empty, responses: ListMap[Key, ReferenceOr[Response]] = ListMap.empty, parameters: ListMap[Key, ReferenceOr[Parameter]] = ListMap.empty, examples: ListMap[Key, ReferenceOr[Example]] = ListMap.empty, requestBodies: ListMap[Key, ReferenceOr[RequestBody]] = ListMap.empty, headers: ListMap[Key, ReferenceOr[Header]] = ListMap.empty, securitySchemes: ListMap[Key, ReferenceOr[SecurityScheme]] = ListMap.empty, links: ListMap[Key, ReferenceOr[Link]] = ListMap.empty, callbacks: ListMap[Key, ReferenceOr[Callback]] = ListMap.empty)
- 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
- def ++(other: Components): Components
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val callbacks: ListMap[Key, ReferenceOr[Callback]]
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @IntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val examples: ListMap[Key, ReferenceOr[Example]]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- val headers: ListMap[Key, ReferenceOr[Header]]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val links: ListMap[Key, ReferenceOr[Link]]
-
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: ListMap[Key, ReferenceOr[Parameter]]
- val requestBodies: ListMap[Key, ReferenceOr[RequestBody]]
- val responses: ListMap[Key, ReferenceOr[Response]]
- val schemas: ListMap[Key, ReferenceOr[JsonSchema]]
- val securitySchemes: ListMap[Key, ReferenceOr[SecurityScheme]]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )