Metadata Schema for Open Standards

The metadata schema for Open Standard.

Data files are hosted on GitHub.

Version 1.0

Mandatory fields are marked with "mandatory".

We've created an example file with only mandatory fields you can use to get started.

• schemaVersion Mandatory [string]

  ORE metadata schema version

  The version of the ORE metadata schema for open source code. This is currently version 1.0.

• standardAcronym Mandatory [string]

  Standard Acronym

  Enter the short name or acronym for the new standard.

• name Mandatory [array]

  Project Name

  Add the name of the standard.

  • English name Mandatory [string]
  • French name Mandatory [string]
• description Mandatory [array]

  Description

  • whatItDoes Mandatory [array]

    What it does

    Description on what it does

    • English Mandatory [string]
    • French Mandatory [string]
  • howItWorks [array]

    How it works

    Description on how it works

    • English [string]
    • French [string]
• tags Mandatory [array]

  Tags

  Add keywords to help distinguish between various instances.

  • English tags Mandatory [string]
  • French tags Mandatory [string]
• standardOrg Mandatory [array]

  Organization name

  Add the name of the organization developing, coordinating, promulgating, revising, amending, reissuing, interpreting or producing the standard.

  • English name Mandatory [string]
  • French name Mandatory [string]
• specURL Mandatory [array]

  Specification URL

  Add the URL of the standard's specification, released usually by the Standard Setting Organization.

  • English URL Mandatory [string]
  • French URL Mandatory [string]
• administrations Mandatory [array]

  Software administrations descriptions

  • adminCode Mandatory [string]

    Canadian public administration

    Select a public administration from the drop-down field or add a new one in case the administration does not exist.

  • team [array]

    Team

    Add the name of the team, branch or sector within the public administration to which this belongs. For example, the Canadian Digital Services is a sector within the federal administration Treasury Board of Canada Secretariat.

    • English name [string]
    • French name [string]
  • contact Mandatory [array]

    Contact Information

    • email Mandatory [string]

      Email address

      Email address to contact the project. It should be an email address of where a contact can be directly reached.

    • name [string]

      Name

      The name of a contact for the project.

  • date Mandatory [string]

    Started using

    Select the date when the public administration started using the standard.

  • reference Mandatory [array]

    Reference for the standard

    • name Mandatory [array]

      Name

      • English Name Mandatory [string]
      • French Name Mandatory [string]
    • URL Mandatory [array]

      URL

      • English URL Mandatory [string]
      • French URL Mandatory [string]
  • status Mandatory [string]

    Status

    Select the status of the standard from the drop-down list. In most cases, the status is set in the reference of the standard.