MappingReference

Stable

MappingReference represents a reference to an external document with full metadata.

id string Required

id allows this entry to be referenced by other elements

title string Required

title describes the purpose of this mapping reference at a glance

version string Required

version is the version identifier of the artifact being mapped to

description string

description is prose regarding the artifact’s purpose or content

url string

url is the path where the artifact may be retrieved; preferrably responds with Gemara-compatible YAML/JSON

ArtifactMapping

Stable

ArtifactMapping represents a mapping to an external artifact or artifact entry

reference-id string Required

reference-id identifies an element from a MappingReference in the artifact’s metadata

remarks string

remarks is prose regarding the mapped artifact or the mapping relationship

MultiEntryMapping

Stable

MultiEntryMapping represents a mapping to an external reference with one or more entries.

entries array[ArtifactMapping] Required

entries is a list of mapping entries

EntryMapping

Stable

EntryMapping represents how a specific entry maps to a MappingReference.

entry-id string Required

entry-id is the identifier being mapped to in the referenced artifact

reference-id string Required

reference-id is the id for a MappingReference entry in the artifact’s metadata

remarks string

remarks is prose describing the mapping relationship