+ A unique parameter is defined by a combination of a name and location.
+
+ ## Parameter Locations
+
+ There are four possible parameter locations specified by the in field:
+
+ path - Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.
+ query - Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.
+ header - Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.
+ cookie - Used to pass a specific cookie value to the API.
+ """
@type t :: %__MODULE__{
name: atom,
in: location,
description: String.t,
required: boolean,
deprecated: boolean,
allowEmptyValue: boolean,
style: style,
explode: boolean,
allowReserved: boolean,
schema: Schema.t | Reference.t | atom,
example: any,
examples: %{String.t => Example.t | Reference.t},
content: %{String.t => MediaType.t}
}
@doc """
Sets the schema for a parameter from a simple type, reference or Schema
"""
@spec put_schema(t, Reference.t | Schema.t | atom) :: t
def put_schema(parameter = %Parameter{}, type = %Reference{}) do
%{parameter | schema: type}
end
def put_schema(parameter = %Parameter{}, type = %Schema{}) do
%{parameter | schema: type}
end
def put_schema(parameter = %Parameter{}, type) when type in [:boolean, :integer, :number, :string, :array, :object] do
%{parameter | schema: %Schema{type: type}}
end
def put_schema(parameter = %Parameter{}, type) when is_atom(type) do
%{parameter | schema: type}
end
+ @doc """
+ Gets the schema for a parameter, from the `schema` key or `content` key, which ever is populated.
+ """
+ @spec schema(Parameter.t) :: Schema.t | Reference.t | atom