ArchAstro.Types.ConfigKindSchema (archastro v0.2.0)

Copy Markdown

The JSON Schema definition and sample YAML for a specific config kind, used to validate and scaffold new configs of that kind.

Summary

Types

t()

Functions

from_map(data)
matches?(value)
to_map(value)

Types

t()

@type t() :: %ArchAstro.Types.ConfigKindSchema{
  json_schema:
    %{optional(String.t()) => ArchAstro.JSON.t()} | ArchAstro.Unset.t(),
  kind: String.t(),
  sample_yaml: String.t() | ArchAstro.Unset.t()
}

Functions

from_map(data)

@spec from_map(ArchAstro.JSON.object()) :: t()

matches?(value)

@spec matches?(ArchAstro.JSON.t()) :: boolean()

to_map(value)

@spec to_map(t()) :: ArchAstro.JSON.object()