WardrikRest.Parameter (wardrik_rest v0.1.0-rc.1)

One argument of an operation: part of its path, its query, a field of its body, the whole body, or a header.

in: :body - one field of an object body, with the operation's other :body fields.
in: :payload - the whole body, for a body that isn't an object of fields.

:schema is a JSON Schema, which may refer to the spec's types. A path parameter with reserved: true keeps its /s, as properties/123.

Summary

Types

t()

Types

t()

@type t() :: %WardrikRest.Parameter{
  in: :path | :query | :body | :payload | :header,
  name: String.t(),
  required: boolean(),
  reserved: boolean(),
  schema: map()
}