Chia-Network / Chia-Network/chips
Inconsistency between CHIP-0007 specification and JSON Schema
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 50
- Forks
- 28
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 2
Description
I noticed that the CHIP-0007 spec document, specifies the that a Collection's ID is a string.. The JSON Schema provided, specifies this as a string with a format of UUID. There is no mention of "UUID" at all, in the specification itself.
I'm fine with (and welcome) the JSON Schema providing this additional constraint, however, I'd suggest it be added to the human readable specification as well... or be removed from from the JSON Schema version.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the Collection ID wording in CHIPs/chip-0007.md with the corresponding definition in assets/chip-0007/schema.json. Determine whether the UUID constraint should be documented in the specification or removed from the schema, then update the relevant file so both representations agree.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100