Metadata Schema for Partnership projects

The metadata schema for Partnership.

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.

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

• projects Mandatory [array]

  Informations about each project

  • name Mandatory [array]

    Project Name

    Add the name of the project

    • 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]
  • 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]
  • category Mandatory [string]

    Category

    Select the best fit category for the project. Categories in the drop-down list correspond to the Software Family of the UNSPSC Taxonomy codes.

  • tags Mandatory [array]

    Tags

    Add keywords to help distinguish between various instances.

    • English tags Mandatory [string]
    • French tags Mandatory [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.

    • phone [string]

      Phone

      The phone of the contact for the project

  • date Mandatory [array]

    Search period dates

    • started Mandatory [string]

      Beginning of the search period

    • closed Mandatory [string]

      End of the search period

  • partners[array]

    Key Partners

    • adminCode [string]

      Admin code

      The administration code for the partner.

    • email [string]

      Contact email

      The email address to contact the partner.

    • name [array]

      Administration name

      The name of the contact in the administration partnering on the project.

      • English name [string]
      • French name [string]