Packages

nldoc_spec

1.2.3
3.1.11 3.1.10 3.1.9 3.1.8 3.1.7 3.1.6 3.1.5 3.1.4 3.1.3 3.1.2 3.1.1 3.1.0 3.0.10 3.0.9 3.0.8 3.0.7 3.0.6 3.0.5 3.0.4 3.0.3 3.0.2 3.0.1 3.0.0 2.0.1 2.0.0 1.3.12 1.3.11 1.3.10 1.3.9 1.3.8 1.3.7 1.3.6 1.3.5 1.3.4 1.3.3 1.3.2 1.3.1 1.3.0 1.2.5 1.2.4 1.2.3 1.2.2 1.2.1 1.2.0 1.1.2 1.1.1 1.1.0 1.0.2 1.0.0

Elixir implementation of the NLdoc Spec for documents.

HexDocs

Current section

Files

Jump to
Readme
49 Versions
6 Dependencies
Dependants
Files
Activity
nldoc_spec lib nldoc spec _template.ex
Raw

lib/nldoc/spec/_template.ex 

defmodule NLdoc.Spec.Template do

  @moduledoc """

  This module is a template for creating new NLdoc spec resource schemas.



  To create a new resource schema:



  1. Copy this file to a new file in the same directory, renaming it to the name of the new resource in snake_case.

  2. Replace all occurrences of `Template` in that file with the name of the new resource.

  3. Add the fields for this resource to the `typed_embedded_schema`.

  4. Update the `changeset` function to cast and validate the new fields.

  5. Add the new resource type to the `NLdoc.Spec.Type` enum.

  6. Add the `t` type to the `NLdoc.Spec.object` type.

  7. Remove this section of the moduledoc up to and including `---`.

  8. Now you can use the new resource in other schemas, e.g. add it to the possible children of `NLdoc.Spec.Document`.



  ---



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

  """

  use NLdoc.Spec.Schema, type: "https://spec.nldoc.nl/Resource/Template"



  typed_embedded_schema null: false do

    field :type, :string, default: @resource_type



    field(:descriptors, {:array, PolymorphicEmbed},

      types: map(NLdoc.Spec.descriptors()),

      type_field_name: :type,

      on_replace: :delete,

      default: [],

      array?: true

    ) :: [NLdoc.Spec.descriptor()]

  end



  def changeset(object, attrs) do

    object

    |> cast(attrs, [:type], @cast_opts)

    |> cast_polymorphic_embed(:descriptors, @cast_opts)

    |> validate_required([:type])

    |> validate_inclusion(:type, [@resource_type])

  end

end