Skip to content
This repository has been archived by the owner on May 20, 2019. It is now read-only.

frictionlessdata/schemas

Repository files navigation

JSON Schemas for Frictionless Data Specifications

Build Status

JSON Schemas, and a registry, for the Data Package family of specifications. Read more about Data Packages at Frictionless Data.

The schemas are implemented using JSON Schema, a specification which provides a simple declarative format for describing the structure of JSON documents.

The registry is implemented as simple CSV file, and there are libraries in JavaScript and Python that work with the registry directly.

The schemas

Here you'll find schemas for Data Package, various Data Package Profiles, JSON Table Schemas, CSV Dialect Description Format and more.

Note that some of the schemas also feature information for json-editor - useful for building web forms and other UI components dynamically from a schema. We use this extensively in DataPackagist to build UIs for creating Data Packages.

The registry

The registry enables consumers to get access to schemas and documentation for the family of Data Package specifications, and related specifications like JSON Table Schema and CSV Dialect Description Format. See Frictionless Data for more information.

Contributing

Yes we welcome and encourage additions to the registry! Any spec that is added must meet the following criteria:

  • Be related to the Data Packages family of specifications.
  • Have a publicly-accessible web page describing the specification.
  • Have a JSON Schema file that describes the specification.

See the existing entries in the registry, and then take the following steps to add a new entry:

  1. Make a new pull request called registry/{NAME_OF_SPECIFICATION}
  2. The pull request features a JSON Schema file for the new specification, and adds the spec to registry.csv
  3. Write a brief description of the spec as part of the pull request.