Fix Example JSON document for Array metadata. #302
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
JSON array metadata document in the **Array metadata** section is
ill-formed. the `codecs` field contains just the gzip codec configuration,
even though the spec requires the codec chain to always have one
`array->bytes` codec. That is in the example the gzip codec should be
replaced with something more sensible like
`{"name": "bytes", "configuration": "big"}` to be considered correct.
This commit fixes that.
|
thanks for the fix! I will use this opportunity to suggest that the kind of mistake you fixed here would be less likely if we used a more structured JSON representation for the codecs, c.f. #298 |
d-v-b
approved these changes
Jul 8, 2024
joshmoore
approved these changes
Jul 25, 2024
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.
JSON array metadata document in the Array metadata section is ill-formed. the
codecsfield contains just the gzip codec configuration, even though the spec requires the codec chain to always have onearray->bytescodec. That is in the example the gzip codec should be replaced with something more sensible like{"name": "bytes", "configuration": "big"}to be considered correct. This commit fixes that.