Menu
Close

Collection metadata

This reference documentation details all available metadata fields that can be specified in a collection’s metadata file.

The examples given throughout this reference can be seen in context in the complete metadata file and rendered in the collection page of the Demo collection.

Fields

id string required
Unique identifier derived from name (acronyms, dash-separated).
Example: demo
name string required
Display name of the collection.
Example: Demo Collection
tagline string required
Concise description of collection topic.
Example: Services used by Open Terms Archive
languages array of strings required
List of ISO 639-1 (two-letter) language codes representing languages allowed in the collection.
Example: [en, fr, de]
jurisdictions array of strings required
List of ISO 3166-2 country codes representing jurisdictions covered by the collection.
Example: [EU]
description string
Detailed description of the collection
Example:
description: >
    The **Demo** collection tracks changes to the terms of use of services used by Open Terms Archive.

    This provides a reference collection for best practices and enables the Open Terms Archive Core Team to be a user of the software it produces.
dataset uri
URL to the dataset releases.
Example: https://github.com/OpenTermsArchive/demo-versions/releases
declarations uri
URL to the declarations repository.
Example: https://github.com/OpenTermsArchive/demo-declarations
versions uri
URL to the versions repository.
Example: https://github.com/OpenTermsArchive/demo-versions
snapshots uri
URL to the snapshots repository.
Example: https://github.com/OpenTermsArchive/demo-snapshots
donations uri
URL to the donations page.
Example: https://opencollective.com/opentermsarchive
trackingPeriods array of objects
List of time periods during which terms were tracked, with their tracking configuration. Gaps between periods indicate times when tracking was interrupted. See TrackingPeriods section.
governance object of objects
Map of organizations involved in the collection’s governance, with organization names as keys and governance objects as values. See Governance section.
i18n object of objects
Internationalization of any of the Metadata properties (except i18n itself) for different language codes
Example:
fr:
    name: Démo
    tagline: Services utilisés par Open Terms Archive
    governance:
    Ministry for Europe and Foreign Affairs:
        name: Ministère de l'Europe et des Affaires étrangères
        url: https://www.diplomatie.gouv.fr

TrackingPeriods

startDate date required
The date when tracking started for this period (ISO 8601 format YYYY-MM-DD).
Example: 2023-01-01
schedule cron-expression required
A cron expression that defines the tracking frequency.
Example: 0 0 * * *
serverLocation string required
The geographic location of the tracking server (city name and ISO 3166-2 country code).
Example: Paris, FR
endDate date
The date when tracking ended for this period (ISO 8601 format YYYY-MM-DD). If not specified, tracking is ongoing.
Example: 2023-12-01

Governance

url uri
URL to the entity’s website
Example: https://opentermsarchive.org/
roles array of strings required
Roles of the entity within the governance, see collection governance
Example: [host, administrator]
Allowed values: host administrator curator maintainer sponsor