View Source Swagdox.Schema (swagdox v0.3.0)

This module provides a way to extract the fields and types of an Ecto.Schema.

Summary

Types

property()

t()

Functions

description(schema)

example(schema)

infer(module)

name(schema)

properties(schema)

reference(schema)

render(schema, version \\ "3.0.0")

Types

property()

@type property() :: {atom(), atom(), keyword()}

t()

@type t() :: %Swagdox.Schema{
  description: String.t(),
  example: term(),
  module: module(),
  properties: [property()],
  required: [atom()],
  type: String.t()
}

Functions

description(schema)

@spec description(module()) :: String.t()

example(schema)

@spec example(module()) :: any()

infer(module)

@spec infer(module()) :: t()

name(schema)

@spec name(t()) :: String.t()

properties(schema)

@spec properties(module()) :: [property()]

reference(schema)

@spec reference(t() | String.t()) :: String.t()

render(schema, version \\ "3.0.0")

@spec render(t(), String.t()) :: map()