JSON Data Resources
Authors | Michael Joseph Rosenthal |
---|
A simple format to describe a single structured JSON data resource. It includes support both for metadata such as author and title and a schema to describe the data.
Introduction
A JSON Data Resource is a type of [Data Resource][dr] specialized for describing structured JSON data.
JSON Data Resource extends [Data Resource][dr] in following key ways:
- The
schema
property MUST follow the JSON Schema specification, either as a JSON object directly under the property, or a string referencing another JSON document containing the JSON Schema
Examples
A minimal JSON Data Resource, referencing external JSON documents, looks as follows.
A minimal JSON Data Resource example using the data property to inline data looks as follows.
A comprehensive JSON Data Resource example with all required, recommended and optional properties looks as follows.
Specification
A JSON Data Resource MUST be a [Data Resource][dr], that is it MUST conform to the [Data Resource specification][dr].
In addition:
- The Data Resource
schema
property MUST follow the JSON Schema specification, either as a JSON object directly under the property, or a string referencing another JSON document containing the JSON Schema - There
MUST
be aprofile
property with the valuejson-data-resource
- The data the Data Resource describes MUST, if non-inline, be a JSON file
JSON file requirements
When "format": "json"
, files must strictly follow the JSON specification. Some implementations MAY
support "format": "jsonc"
, allowing for non-standard single line and block comments (//
and /* */
respectively).
Implementations
None known.