Components

zio.http.api.openapi.OpenAPI$.Components
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])

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.

Attributes

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.

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def toJson: String

Attributes

Definition Classes
OpenAPIBase

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product