Components
zio.http.endpoint.openapi.OpenAPI.Components
final case class Components(schemas: ListMap[Key, ReferenceOr[JsonSchema]], responses: ListMap[Key, ReferenceOr[Response]], parameters: ListMap[Key, ReferenceOr[Parameter]], examples: ListMap[Key, ReferenceOr[Example]], requestBodies: ListMap[Key, ReferenceOr[RequestBody]], headers: ListMap[Key, ReferenceOr[Header]], securitySchemes: ListMap[Key, ReferenceOr[SecurityScheme]], links: ListMap[Key, ReferenceOr[Link]], callbacks: ListMap[Key, ReferenceOr[Callback]])
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.
Value parameters
- callbacks
-
An object to hold reusable Callback Objects.
- examples
-
An object to hold reusable Example Objects.
- headers
-
An object to hold reusable Header Objects.
- links
-
An object to hold reusable Link Objects.
- parameters
-
An object to hold reusable Parameter Objects.
- requestBodies
-
An object to hold reusable Request Body Objects.
- responses
-
An object to hold reusable Response Objects.
- schemas
-
An object to hold reusable Schema Objects.
- securitySchemes
-
An object to hold reusable Security Scheme Objects.
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Members list
In this article