Metadata Schema for Open Design

The metadata schema for Open Design.

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.

• 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.

  • name Mandatory [array]

    Project Name

    Add the name of the open design

    • English project name Mandatory [string]
    • French project 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]
  • designType[array]

    Select types to categorize this design.

    • type Mandatory [array]

      • English type Mandatory [string]
      • French type Mandatory [string]
  • homepageURL Mandatory [array]

    Homepage URL

    Add the URL of the project homepage.

    • English homepage URL Mandatory [string]
    • French homepage URL Mandatory [string]
  • licences Mandatory [array]

    Project Licenses

    • URL Mandatory [array]

      URL

      • English licence URL Mandatory [string]
      • French licence URL Mandatory [string]
    • spdxID Mandatory [string]

      The SPDX License identifier - Search the List of licenses List of licences.

      Search the list of licenses to find the SPDX license identifier according to the project license's name. Add the URLs of the license's repository.

    • level Mandatory [string]

      License level

      License level within the project, if it covers the whole project or only a section

    • scope Mandatory [array]

      Scope of the sub license within the project, only applicable when 'sub license' level is selected

      • English license scope Mandatory [string]
      • French license scope Mandatory [string]
  • 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]
  • uses Mandatory [array]

    Informations about design users.

    • 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 design.

    • designStatus [string]

      Status

      Select the design status from the drop-down field according to its use.