Open Data Catalog v2.0.0
data-dictionary.json
Go to the documentation of this file.
1 {
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "Data Dictionary",
4  "type": "object",
5  "required": [
6  "identifier",
7  "title"
8  ],
9  "properties": {
10  "identifier": {
11  "title": "Identifier",
12  "type": "string"
13  },
14  "title": {
15  "title": "Title",
16  "type": "string"
17  },
18  "data": {
19  "title": "Project Open Data Data-Dictionary",
20  "description": "A data dictionary for this resource, compliant with the [Table Schema](https://specs.frictionlessdata.io/table-schema/) specification.",
21  "type": "object",
22  "required": [
23  "fields"
24  ],
25  "properties": {
26  "fields": {
27  "title": "Dictionary Fields",
28  "type": "array",
29  "items": {
30  "title": "Dictionary Field",
31  "type": "object",
32  "required": [
33  "name",
34  "type"
35  ],
36  "properties": {
37  "name": {
38  "title": "Name",
39  "description": "A name for this field.",
40  "type": "string"
41  },
42  "title": {
43  "title": "Title",
44  "description": "A human-readable title.",
45  "type": "string",
46  "examples": [
47  "{\n \"title\": \"My Package Title\"\n}\n"
48  ]
49  },
50  "type": {
51  "title": "Type",
52  "description": "The type keyword, which `MUST` be a value of `string`.",
53  "type": "string",
54  "enum": [
55  "string",
56  "number",
57  "integer",
58  "date",
59  "time",
60  "datetime",
61  "year",
62  "yearmonth",
63  "boolean",
64  "object",
65  "geopoint",
66  "geojson",
67  "array",
68  "duration"
69  ]
70  },
71  "format": {
72  "title": "Format",
73  "description": "Supported formats depend on the specified field type:\n* For `string` the supported formats are `default`, `email`, `uri`, `binary`, and `uuid`:\n - **default**: any valid string.\n - **email**: A valid email address.\n - **uri**: A valid URI.\n - **binary**: A base64 encoded string representing binary data.\n - **uuid**: A string that is a uuid.\n* For `number` only `default` is allowed.\n* For `integer` only `default` is allowed.\n* For `date` the supported formats are `default`, `any`, and `{PATTERN}`:\n - **default**: An ISO8601 format string of YYYY-MM-DD.\n - **any**: Any parsable representation of a date. The implementing library can attempt to parse the datetime via a range of strategies.\n - **{PATTERN}**: The value can be parsed according to `{PATTERN}`, which `MUST` follow the date formatting syntax of C / Python [strftime](http://strftime.org/).\n* For `time` the supported formats are `default`, `any`, and `{PATTERN}`:\n - **default**: An ISO8601 format string for time.\n - **any**: Any parsable representation of a date. The implementing library can attempt to parse the datetime via a range of strategies.\n - **{PATTERN}**: The value can be parsed according to `{PATTERN}`, which `MUST` follow the date formatting syntax of C / Python [strftime](http://strftime.org/).\n* For `datetime` the supported formats are `default`, `any`, and `{PATTERN}`:\n - **default**: An ISO8601 format string for datetime.\n - **any**: Any parsable representation of a date. The implementing library can attempt to parse the datetime via a range of strategies.\n - **{PATTERN}**: The value can be parsed according to `{PATTERN}`, which `MUST` follow the date formatting syntax of C / Python [strftime](http://strftime.org/).\n* For `year` only `default` is allowed.\n* For `yearmonth` only `default` is allowed.\n* For `boolean` only `default` is allowed.\n* For `object` only `default` is allowed.\n* For `geopoint` the supported formats are `default`, `array`, and `object`:\n - **default**: A string of the pattern 'lon, lat', where `lon` is the longitude and `lat` is the latitude.\n - **array**: An array of exactly two items, where each item is either a number, or a string parsable as a number, and the first item is `lon` and the second item is `lat`.\n - **object**: A JSON object with exactly two keys, `lat` and `lon`\n* For `geojson` the supported formats are `default` and `topojson`:\n - **default**: A geojson object as per the [GeoJSON spec](http://geojson.org/).\n - **topojson**: A topojson object as per the [TopoJSON spec](https://github.com/topojson/topojson-specification/blob/master/README.md).\n* For `array` only `default` is allowed.\n* For `duration` only `default` is allowed.",
74  "type": "string",
75  "default": "default"
76  }
77  }
78  }
79  }
80  }
81  }
82  }
83 }