APIDoc

v0.0.1-pro1

APIDoc v0.0.1-pro1 APIDoc.Doc.Schema View Source

A schema definition for use as in and output type.

Link to this section Summary

Types

format()

The format for types that have different formats

t()

A schema definition for use as in and output type

type()

The schema type

Link to this section Types

Link to this type format() View Source 
format() :: :int32 | :int64

The format for types that have different formats.

Example: :int32 for :integers.

Link to this type t() View Source 
t() :: %APIDoc.Doc.Schema{
  example: any(),
  format: format() | nil,
  items: map(),
  maximum: integer() | nil,
  minimum: integer() | nil,
  name: atom(),
  properties: map() | nil,
  required: [atom()] | nil,
  type: type()
}

A schema definition for use as in and output type.

Link to this type type() View Source 
type() :: :integer | :string | :object | :array

The schema type.