The inventory schema

The inventory schema (inventory.xsd) defines the format of an inventory of local open datasets. A local authority can have one or more such inventories. The data.gov.uk site will automatically harvest details of all your datasets if you register the with it the location of your inventory.

The DataShare product (version currently in beta testing) automatically outputs an inventory at the address myDataShareAddress/api/esdInventory. So DataShare users simply need to register this address once with data.gov.uk.

Validating and browsing inventories

The ESD inventory pages allow you to browse through and download inventories input by other councils. You can also upload your own, edit it online and download it. Upload and download support both the XML format defined by the schema and a CSV format. So you can use the page to convert between the two formats.

If you try to upload an inventory XML inventory, the inentories tool will tell you if there are errors in your inventory and warn of any omissions. So the page provides a good way of learning the inventory structure and testing how compliant your inventory is with the schema.

Schemas for individual datasets

The inventory’s conformsTo property for a dataset such be used to reference the full URL of the schema to which the dataset conforms. Ideally that should be a schema hosted here or at another well recognised permanent location.

DataShare will only access local definitions and ones held at the DGU sub-domain. When DataShare is used to create a dataset from a shared definition file, it will not allow any of the columns defined by the shared schema to change, but will allow extra columns to be added and edited.

The Sharing and standardising local government open data PDF document provides an introduction to the schema defining the inventory structure and the schemas it references for open data sets..

Index to schemas

Description Schema files Documentation
Inventory Current Version
Version 0.3
Version 0.2
Version 0.1
Inventory schema guidance
Schema on GitHub