Torngen.Spec.Parameter (Torngen v0.1.2)
View SourceRepresents all parameters for OpenAPI requests.
External Resources
Summary
Types
@type parameter_locations() :: :path | :query | :header | :cookie
@type t() :: %Torngen.Spec.Parameter{ body: Torngen.Spec.Parameter.Schema.t() | Torngen.Spec.Parameter.Content.t() | nil, deprecated: boolean(), description: String.t() | nil, in: parameter_locations(), name: String.t(), reference: String.t() | nil, required: boolean() }
Represents all parameters.
Fields
name
- Name of the parameter. Correspond to the key used for the parameter (except for:header
parameters).in
- Location of the parameter.body
- N/Areference
- Reference identifier to a parameter's schema.description
- Description of the parameter (either text or markdown).required
- Mandatory parameter flag.deprecated
- Deprecated parameter flag.
Functions
@spec parse(parameter :: map(), spec :: Torngen.Spec.t()) :: t()
@spec parse_many(spec :: Torngen.Spec.t(), parameters :: map() | [term()]) :: Torngen.Spec.t()