Schema: Added enum values to field descriptions #509
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
added 2 commits
August 6, 2024 11:04
…PATCH-add-enums-to-field-descriptions
Added details of this change to the changelog for 3.1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 inlinedocumentation 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