View Source Swagdox.Schema (swagdox v0.1.0)

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

Summary

Types

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

Functions

@spec description(module()) :: String.t()
@spec infer(module()) :: t()
@spec name(t()) :: String.t()
@spec properties(module()) :: [property()]
@spec reference(t() | String.t()) :: String.t()
@spec render(t()) :: map()