Open Data Services Codelist Schema¶

A schema for documenting codelists in CSV format.

This page presents the schema as a table. You can also download it as JSON Schema.

Tip

To reference the codelist schema, use its canonical URI:

Title	Description	Type	Required
`Code`		string	Required
Code	The value to use in data. Codes should match the letter case of external codes (e.g. ISO 4217, JSON Schema, GeoJSON, IANA Media Types) and should be camel case, otherwise.
`Title`		string	Required
Title	A short title for the code.
`Description`		string	Required
Description	A longer description of the code.
`Deprecated`		[string, null]
Deprecated	The minor version (or patch version under 0.x) in which the code was deprecated.
`Deprecation note`		[string, null]
Deprecation note	The reason for the deprecation, and any guidance.
`Business Logic`		[string, null]
Business Logic	A description of how this field’s value relates to the values of other fields.
`Category`		[string, null]
Category	A single category by which to filter codes. The standard’s documentation should explain the categorization system.
`Notes`		string
Notes	Notes on the application of the code.
`Source`		object
Source	The third-party source for the code.
`Valid Until`		[string, null]
Valid Until	The date past which the code is no longer valid for use.

Appreciation¶

The codelist schema is based on the codelist schema developed by the Open Contracting Partnership for the Open Contracting Data Standard.