Diffo.Provider.Instance.Extension.Info (Diffo v0.2.2)

Copy Markdown View Source

Summary

Functions

instance?(module)

Returns true if the module is a BaseInstance-derived resource

structure_characteristics(dsl_or_extended)

structure.characteristics DSL entities

structure_features(dsl_or_extended)

structure.features DSL entities

structure_parties(dsl_or_extended)

structure.parties DSL entities

structure_places(dsl_or_extended)

structure.places DSL entities

structure_specification_category(dsl_or_extended)

The category the specified service or resource belongs to.

structure_specification_category!(dsl_or_extended)

The category the specified service or resource belongs to.

structure_specification_description(dsl_or_extended)

A generic description of the specified service or resource.

structure_specification_description!(dsl_or_extended)

A generic description of the specified service or resource.

structure_specification_id(dsl_or_extended)

The id of the specification, a uuid4 the same in all environments, unique for name and major_version.

structure_specification_id!(dsl_or_extended)

The id of the specification, a uuid4 the same in all environments, unique for name and major_version.

structure_specification_major_version(dsl_or_extended)

The major_version of the specification.

structure_specification_major_version!(dsl_or_extended)

The major_version of the specification.

structure_specification_minor_version(dsl_or_extended)

The minor_version of the specification.

structure_specification_minor_version!(dsl_or_extended)

The minor_version of the specification.

structure_specification_name(dsl_or_extended)

The name of the specification, unique to a service but common for all versions.

structure_specification_name!(dsl_or_extended)

The name of the specification, unique to a service but common for all versions.

structure_specification_options(dsl_or_extended)

structure.specification DSL options

structure_specification_patch_version(dsl_or_extended)

The patch_version of the specification.

structure_specification_patch_version!(dsl_or_extended)

The patch_version of the specification.

structure_specification_tmf_version(dsl_or_extended)

The TMF API version of the specification, e.g. 4.

structure_specification_tmf_version!(dsl_or_extended)

The TMF API version of the specification, e.g. 4.

structure_specification_type(dsl_or_extended)

The type of the specification.

structure_specification_type!(dsl_or_extended)

The type of the specification.

Functions

instance?(module)

@spec instance?(module()) :: boolean()

Returns true if the module is a BaseInstance-derived resource

structure_characteristics(dsl_or_extended)

@spec structure_characteristics(dsl_or_extended :: module() | map()) :: [struct()]

structure.characteristics DSL entities

structure_features(dsl_or_extended)

@spec structure_features(dsl_or_extended :: module() | map()) :: [struct()]

structure.features DSL entities

structure_parties(dsl_or_extended)

@spec structure_parties(dsl_or_extended :: module() | map()) :: [struct()]

structure.parties DSL entities

structure_places(dsl_or_extended)

@spec structure_places(dsl_or_extended :: module() | map()) :: [struct()]

structure.places DSL entities

structure_specification_category(dsl_or_extended)

@spec structure_specification_category(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

The category the specified service or resource belongs to.

structure_specification_category!(dsl_or_extended)

@spec structure_specification_category!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

The category the specified service or resource belongs to.

structure_specification_description(dsl_or_extended)

@spec structure_specification_description(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

A generic description of the specified service or resource.

structure_specification_description!(dsl_or_extended)

@spec structure_specification_description!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

A generic description of the specified service or resource.

structure_specification_id(dsl_or_extended)

@spec structure_specification_id(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

The id of the specification, a uuid4 the same in all environments, unique for name and major_version.

structure_specification_id!(dsl_or_extended)

@spec structure_specification_id!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

The id of the specification, a uuid4 the same in all environments, unique for name and major_version.

structure_specification_major_version(dsl_or_extended)

@spec structure_specification_major_version(dsl_or_extended :: module() | map()) ::
  {:ok, integer()} | :error

The major_version of the specification.

structure_specification_major_version!(dsl_or_extended)

@spec structure_specification_major_version!(dsl_or_extended :: module() | map()) ::
  integer() | no_return()

The major_version of the specification.

structure_specification_minor_version(dsl_or_extended)

@spec structure_specification_minor_version(dsl_or_extended :: module() | map()) ::
  {:ok, integer()} | :error

The minor_version of the specification.

structure_specification_minor_version!(dsl_or_extended)

@spec structure_specification_minor_version!(dsl_or_extended :: module() | map()) ::
  integer() | no_return()

The minor_version of the specification.

structure_specification_name(dsl_or_extended)

@spec structure_specification_name(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

The name of the specification, unique to a service but common for all versions.

structure_specification_name!(dsl_or_extended)

@spec structure_specification_name!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

The name of the specification, unique to a service but common for all versions.

structure_specification_options(dsl_or_extended)

@spec structure_specification_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

structure.specification DSL options

Returns a map containing the and any configured or default values.

structure_specification_patch_version(dsl_or_extended)

@spec structure_specification_patch_version(dsl_or_extended :: module() | map()) ::
  {:ok, integer()} | :error

The patch_version of the specification.

structure_specification_patch_version!(dsl_or_extended)

@spec structure_specification_patch_version!(dsl_or_extended :: module() | map()) ::
  integer() | no_return()

The patch_version of the specification.

structure_specification_tmf_version(dsl_or_extended)

@spec structure_specification_tmf_version(dsl_or_extended :: module() | map()) ::
  {:ok, integer()} | :error

The TMF API version of the specification, e.g. 4.

structure_specification_tmf_version!(dsl_or_extended)

@spec structure_specification_tmf_version!(dsl_or_extended :: module() | map()) ::
  integer() | no_return()

The TMF API version of the specification, e.g. 4.

structure_specification_type(dsl_or_extended)

@spec structure_specification_type(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The type of the specification.

structure_specification_type!(dsl_or_extended)

@spec structure_specification_type!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The type of the specification.