Skip to content

Metadata Provider Scheme

A Metadata Provider Scheme is an organisation scheme whose items are the Metadata Providers that report reference metadata to an agency. The scheme always has the fixed id METADATA_PROVIDERS and version 1.0. Documents start ref: "MetadataProviderScheme=AGENCY:METADATA_PROVIDERS(1.0)".

The Metadata Provider Scheme is written by the same writer as the Agency Scheme, so the layout is identical, including contacts.

Note

There are no golden test files for this type yet. The examples below follow the shared organisation scheme writer and the golden files of the other organisation schemes.

Simple form

A metadata provider with an English name only, and no contacts, is written as ID: "name".

format: "fusion-yaml(1.0.0)"
ref: "MetadataProviderScheme=ACY:METADATA_PROVIDERS(1.0)"
name: "Metadata providers"
items:
- MDP1: "Metadata Provider One"
- MDP2: "Metadata Provider Two"

The document starts with the common header. The body is:

  • items: the metadata providers, in scheme order, written as described in Items.

Complex form

A metadata provider becomes an object when it has contacts, as well as for the usual reasons (a description, a non-English name, a uri, annotations or links).

format: "fusion-yaml(1.0.0)"
ref: "MetadataProviderScheme=ACY:METADATA_PROVIDERS(1.0)"
name: "Metadata providers"
items:
- MDP1:
    name: "Metadata Provider One"
    contacts:
    - name: "Alexie Plexie"
      email: "metadata@acy.org"
- MDP2:
    name: "Metadata Provider Two"
    description: "Reports quality metadata"

Field reference

Field Value Written when
partial true The scheme is partial.
items Array of metadata providers The scheme has at least one metadata provider.
items[].ID String (the English name), or an object Always, one entry per metadata provider.
items[].ID.name, name-xx Localised text The metadata provider has the name.
items[].ID.description, description-xx Localised text The metadata provider has the description.
items[].ID.uri String The metadata provider has a URI.
items[].ID.contacts Array of contacts The metadata provider has contacts.
items[].ID.annotations Annotations The metadata provider has annotations.
items[].ID.links Links The metadata provider has links.