Skip to content

Metadata v5.0.0 - spec and JSON schema

Latest
Latest
Compare
Choose a tag to compare
@daniwelter daniwelter released this 22 Feb 13:41
· 3844 commits to master since this release
5.0.0
3af0fed
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

On behalf of the HCA DCP, we are happy to announce a major release of HCA metadata schema v5.0.0.

This major update breaks backwards compatibility.

  • A document of field-by-field mappings of schema fields between v4.6.1 and v5.0.0 can be found here.
  • A document of schema-by-schema mappings of schema fields between v4.6.1 and v5.0.0 can be found here.
  • A document of a high-level overview of v5.0.0 metadata entities and entity relationships can be found here.
  • A document with detailed information about the metadata schema update process can be found here.

What this release contains

The v5.0.0 schema includes:

  • New fields based on feedback from extensive user evaluation sessions
  • New modules which now capture domain-specific fields
  • New field attributes (e.g. example, user_friendly) to improve schema clarity
  • New example v5.0.0 JSON files and template Excel spreadsheet
  • New markdown-formatted table of current metadata fields for easy browsing
  • Structural changes to the hierarchy of schema entities
  • Improved field names and updated field descriptions based on user feedback
  • Expanded use of ontologies to validate relevant fields
  • Improved Travis CI testing (new passing and failing example JSON files)
  • Improved documentation for schema updates (contributing.md, changelog.md, Metadata_schema_lifecycle_doc.md)
  • Removal of fields deemed unnecessary based on user feedback
  • Improved bundle schemas that were developed with feedback from all DCP components.

What this release does not contain

The v5.0.0 schema does NOT include:

  • v5.0.0 example spreadsheets. Multiple groups are currently working on generating v5.0.0-compatible example Excel spreadsheets. As they become available, these spreadsheets will be deposited into the examples directory in the metadata-schema GitHub repo.

What happens now?

The HCA DCP metadata teams are very interested in community feedback on the metadata schema changes in order to continue improving the HCA metadata standards. Please look over the changes and feel free to provide any feedback either as GitHub issues/discussion or on the #hca-metadata Slack channel.

Assets 2
Loading