Skip to content

Update Data Package support to version 2 or later in DP Guide #1053

Description

@tucotuco

The Darwin Core Data Package Guide currently explicitly states the target version for the underlying Data Package Specification is version 1:

All requirements and examples in this guide use version 1 of the Data Package specification, which is RECOMMENDED for DwC-DPs.

We would like to future-proof the DP Guide and update the version recommendation to use specification version 2 as the minimum. This requires the following updates in the guide:

  1. Update version recommendation:

    All requirements and examples in this guide use version 1 version 2 or higher of the Data Package specification, which is RECOMMENDED for DwC-DPs.

  2. Update package.profile requirement:

    The descriptor MUST have a profile $schema property, with a URL referencing the profile the dataset conforms to. The $schema property MUST follow the Data Package specification. This MUSTIts value MUST be a string representing the URL to a DwC-DP profile served from http://rs.tdwg.org. The URL MUST include the version of the profile (e.g., http://rs.tdwg.org/dwc-dp/1.0/dwc-dp-profile.json, where 1.0 is the version).

  3. Add new resource.$schema requirement:

    A DwC-DP table MUST have a $schema property, indicating what version of the Data Resource specification is used. The $schema property MUST follow the Data Resource specification. Its value MUST be https://datapackage.org/profiles/2.0/dataresource.json (where 2.0 is the version, which MAY be higher than 2.0).

  4. Update resource.profile requirement:

    A DwC-DP table MUST have a profile type property, indicating the type of resource. The type property MUST follow the Data Resource specification. The profile property MUST be the value Its value MUST be tabular-data-resource table, thereby indicating that it follows the Tabular Data Resource specification.

  5. Update all references from https://specs.frictionlessdata.io to the correct links in the Data Package v2 specification https://datapackage.org

  6. Update example (non-normative):

    "$schema": "http://rs.tdwg.org/dwc-dp/1.0/dwc-dp-profile.json", <-- ADDED
    "profile": "http://rs.tdwg.org/dwc-dp/1.0/dwc-dp-profile.json",

    For the resources:

     {
       "$schema": "https://datapackage.org/profiles/2.0/dataresource.json", <-- ADDED
       "name": "event",
       "path": "event.csv",
       "type": "table", <-- ADDED ("profile": "tabular-data-resource" REMOVED)
       ...
       "foreignKeys": [
           {
             "fields": ["eventID"], <-- UPDATED TO ARRAY
             "predicate": "happened during",
             "reference": {
               "resource": "event",
               "fields": ["eventID"] <-- UPDATED TO ARRAY
             }
           }
         ]

If approved, the following should be updated (no need for public review):

  • dwc-dp-profile.json
  • all table schemas
    • Add "$schema": "https://datapackage.org/profiles/2.0/tableschema.json"

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Docs - Data Package GuidePertaining to the Data Package Guide document.Format - DwC-DPIssues related to the Darwin Core Data Package implementation.normativeIssue contains changes that are normative (defines what is required to comply with the standard).

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions