HSDS contains several fields where the values must be taken from
enumerated values. These are represented in the schemas with enum
properties.
There is currently no documentation for these values, so I have added
them to the description property of each field. This gives some inline
documentation where appropriate without changing the semantics of the
relevant fields.
Merge checklist
This PR is designed to be merged into the 3.1-dev staging branch so compiling the schemas should be performed at a later date to take into account all other schema changes.
[x] Update the changelog
If you have edited any schema files:
[ ] Run hsds_schema.py to update datapackage.json and example files
Related issues
Description
HSDS contains several fields where the values must be taken from enumerated values. These are represented in the schemas with
enumproperties.There is currently no documentation for these values, so I have added them to the
descriptionproperty of each field. This gives some inline documentation where appropriate without changing the semantics of the relevant fields.Merge checklist
This PR is designed to be merged into the
3.1-devstaging branch so compiling the schemas should be performed at a later date to take into account all other schema changes.If you have edited any schema files:
hsds_schema.pyto updatedatapackage.jsonand example files