Publishing and accessing versions of datasets

From Data on the Web Best Practices
Jump to: navigation, search

Intro

This section of the DWBP Document appoint best practices for datasets versions.

Every document and dataset on the web must have an area to describe the version and/or date of publication.

Best Practices

  • URI must have metadata to show informations about versions and date of the dataset
  • Should have a way to show detailed descriptions, for instance, information about versions

Example:

http://domain.com/datasetname/?about
dataset: {
   name: 'dataset name',
    created: '2012-03-04',
    modified: '2013-04-05',
    version: '1.0.0',
}
  • The Item 2 must be Human-readable and Machine-readable
  • Dataset must provide the dataset version history

Example:

http://domain.com/datasetname/?history
dataset: {
    name: 'dataset name',
    created: '2012-03-04',
    modified: '2013-04-05',
    version: '2.4.0',
    history: [
        { version:  2.3.0
          modified: '2012-12-08' }, 
          ...,
         {  version: "1.2.0",
            modified: "2012-05-07" }
    ]
}
  • To access a previous version of the dataset, a queryString can be used
http://domain.com/dataset?version=1.2.0

URI Variants

As presented on Compact Uniform Resource Identifier (COMURI) document, versions are variants:

 http://example.com/foo?version=2                          # variant version 2
 http://example.com/foo?lang=de;format=xml;version=5       # variant German,XML,version5

Editors and Contributors

  • Flavio Yanai
  • Newton Calegari
  • M.T. Carrasco Benitez