uuid: relaxed UUID validation
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue(s): https://github.com/tarantool/tarantool/issues/5444
Related doc. issue: https://github.com/tarantool/doc/issues/4333
Product: Tarantool
Since: 3.2
Root document:
- https://www.tarantool.io/en/doc/latest/reference/reference_lua/uuid/
- https://www.tarantool.io/en/doc/latest/reference/configuration/configuration_reference/#confval-database.instance_uuid
- https://www.tarantool.io/en/doc/latest/platform/ddl_dml/value_store/#uuid
SME: @ Buristan
Details
The UUID module documentation mentions that Tarantool generates
UUIDs following the rules for RFC 4122,version 4, variant 1. It is
worth mentioning that the user can store an arbitrary 128-bit sequence
as an UUID for binary data. String representations still should match
the grammars in RFC 4122, Section 3, and RFC 9562, Section 4.
Requested by @ Buristan in https://github.com/tarantool/tarantool/commit/b0b32bff022caeffd64ca687baab908f25fa2fcb.
Contributor guide
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
Start with the UUID module documentation and the two other root documents linked in the issue. Compare their current UUID descriptions with RFC 4122 Section 3 and RFC 9562 Section 4, then update the documentation to distinguish arbitrary 128-bit binary values from valid string representations. Done means the relevant UUID guidance consistently reflects these rules.
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
- Clearly specified
- Newbie friendliness
- 52/100