NLdoc.Spec.Validation.Finding (NLdoc.Spec.Validation v1.0.15)

View Source

This module defines the Ecto schema for the NLdoc Validation spec Validation object.

Summary

Types

t()

Functions

changeset(object, attrs)
new(template)

This function creates a new NLdoc.Spec.Validation.Finding struct from a map of keys and values, where the keys are snake_case. Returns a tuple with either {:ok, finding} or {:error, changeset}.

resource_type()

Types

t()

@type t() :: %NLdoc.Spec.Validation.Finding{
  resource_id: Ecto.UUID.t(),
  rule: String.t(),
  ruleset: String.t(),
  ruleset_version: String.t(),
  severity: :error | :warning | :notice,
  type: String.t()
}

Functions

changeset(object, attrs)

@spec changeset(
  struct(),
  map()
) :: Ecto.Changeset.t()

new(template)

@spec new(map()) :: {:ok, t()} | {:error, Ecto.Changeset.t()}

This function creates a new NLdoc.Spec.Validation.Finding struct from a map of keys and values, where the keys are snake_case. Returns a tuple with either {:ok, finding} or {:error, changeset}.

Note: If you want to use a map with camelCase keys, use NLdoc.Util.Recase.to_snake/1 to convert them to snake_case before passing them to the constructor.

resource_type()