View Source Swagdox.Parameter (swagdox v0.2.0)
Describes a parameter in an OpenAPI specification.
Summary
Types
Functions
Creates a new Parameter.
Examples:
iex> Swagdox.Parameter.build({"id", "query"}, "integer", "User ID")
%Swagdox.Parameter{
name: "id",
in: "query",
required: false,
description: "User ID",
schema: %{type: "integer"}
}
iex> Swagdox.Parameter.build({"id", "query"}, "integer", "User ID", required: true)
%Swagdox.Parameter{
name: "id",
in: "query",
required: true,
description: "User ID",
schema: %{type: "integer"}
}
Renders a Parameter as a map.
Examples:
iex> Swagdox.Parameter.render(%Swagdox.Parameter{
...> name: "id",
...> in: "query",
...> required: false,
...> description: "User ID",
...> schema: %{type: "integer"}
...> })
%{
"name" => "id",
"in" => "query",
"required" => false,
"description" => "User ID",
"schema" => %{"type" => "integer"}
}