Foundry.Project.Status (foundry v0.1.3)

Copy Markdown

Ash resource wrapping the output of mix foundry.project.status.

Represents the health summary of a target project: lint state, migration status, open proposals, compliance gaps, and stack versions.

Delegates to Foundry.Status.build/1 for the actual data.

Summary

Types

t()

Functions

default_short_name()
input(opts)

Validates that the keys in the provided input are valid for at least one action on the resource.

input(opts, action)

Same as input/1, except restricts the keys to values accepted by the action provided.

primary_key_matches?(left, right)

Types

t()

@type t() :: %Foundry.Project.Status{
  __lateral_join_source__: term(),
  __meta__: term(),
  __metadata__: term(),
  __order__: term(),
  aggregates: term(),
  calculations: term(),
  compiled_at: term(),
  compliance_covered: term(),
  compliance_total: term(),
  domain_type: term(),
  domains: term(),
  generated_at: term(),
  id: term(),
  lint_errors: term(),
  lint_warnings: term(),
  open_proposals: term(),
  pending_migrations: term(),
  project: term(),
  project_type: term(),
  sensitive_modules: term(),
  stack_versions: term()
}

Functions

default_short_name()

input(opts)

@spec input(values :: map() | Keyword.t()) :: map() | no_return()

Validates that the keys in the provided input are valid for at least one action on the resource.

Raises a KeyError error at compile time if not. This exists because generally a struct should only ever be created by Ash as a result of a successful action. You should not be creating records manually in code, e.g %MyResource{value: 1, value: 2}. Generally that is fine, but often with embedded resources it is nice to be able to validate the keys that are being provided, e.g

Resource
|> Ash.Changeset.for_create(:create, %{embedded: EmbeddedResource.input(foo: 1, bar: 2)})
|> Ash.create()

input(opts, action)

@spec input(values :: map() | Keyword.t(), action :: atom()) :: map() | no_return()

Same as input/1, except restricts the keys to values accepted by the action provided.

primary_key_matches?(left, right)