open_api_spex v3.2.0 OpenApiSpex.Components View Source
Defines the OpenApiSpex.Components.t
type.
Link to this section Summary
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %OpenApiSpex.Components{
callbacks:
%{
optional(String.t()) =>
OpenApiSpex.Callback.t() | OpenApiSpex.Reference.t()
}
| nil,
examples:
%{
optional(String.t()) =>
OpenApiSpex.Example.t() | OpenApiSpex.Reference.t()
}
| nil,
headers:
%{
optional(String.t()) => OpenApiSpex.Header.t() | OpenApiSpex.Reference.t()
}
| nil,
links:
%{optional(String.t()) => OpenApiSpex.Link.t() | OpenApiSpex.Reference.t()}
| nil,
parameters:
%{
optional(String.t()) =>
OpenApiSpex.Parameter.t() | OpenApiSpex.Reference.t()
}
| nil,
requestBodies:
%{
optional(String.t()) =>
OpenApiSpex.RequestBody.t() | OpenApiSpex.Reference.t()
}
| nil,
responses:
%{
optional(String.t()) =>
OpenApiSpex.Response.t() | OpenApiSpex.Reference.t()
}
| nil,
schemas:
%{
optional(String.t()) => OpenApiSpex.Schema.t() | OpenApiSpex.Reference.t()
}
| nil,
securitySchemes:
%{
optional(String.t()) =>
OpenApiSpex.SecurityScheme.t() | OpenApiSpex.Reference.t()
}
| nil
}
t() :: %OpenApiSpex.Components{ callbacks: %{ optional(String.t()) => OpenApiSpex.Callback.t() | OpenApiSpex.Reference.t() } | nil, examples: %{ optional(String.t()) => OpenApiSpex.Example.t() | OpenApiSpex.Reference.t() } | nil, headers: %{ optional(String.t()) => OpenApiSpex.Header.t() | OpenApiSpex.Reference.t() } | nil, links: %{optional(String.t()) => OpenApiSpex.Link.t() | OpenApiSpex.Reference.t()} | nil, parameters: %{ optional(String.t()) => OpenApiSpex.Parameter.t() | OpenApiSpex.Reference.t() } | nil, requestBodies: %{ optional(String.t()) => OpenApiSpex.RequestBody.t() | OpenApiSpex.Reference.t() } | nil, responses: %{ optional(String.t()) => OpenApiSpex.Response.t() | OpenApiSpex.Reference.t() } | nil, schemas: %{ optional(String.t()) => OpenApiSpex.Schema.t() | OpenApiSpex.Reference.t() } | nil, securitySchemes: %{ optional(String.t()) => OpenApiSpex.SecurityScheme.t() | OpenApiSpex.Reference.t() } | nil }
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.