Skip to content

Add UUID Version & Variant to GenerateGUID description #1045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Apr 2, 2025
Merged

Add UUID Version & Variant to GenerateGUID description #1045

merged 7 commits into from
Apr 2, 2025

Conversation

@TheWandererLee
Copy link
Contributor

@TheWandererLee TheWandererLee commented Mar 5, 2025

Changes

  • Added a sentence detailing the Version (4) and Variant (1) of the UUID algorithm used.
    • This was determined by generating a GUID (for example 564c5179-c21c-48e1-b5bb-8bd09f00d3f6) and entering it into a public UUID decoder.
    • I don't believe adding this sentence is of any compromise to security since anyone could publicly do this.
    • This added sentence of information is helpful to note, as this version does not have certain features that other UUID versions have such as encoded timestamps, MAC addresses, or being sortable by time (UUIDv7, ULID).
    • More info at Wikipedia or https://www.uuidtools.com/uuid-versions-explained
  • Fixed a typo: Extraneous "[" was removed

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

@TheWandererLee TheWandererLee requested a review from a team as a code owner March 5, 2025 00:27
@github-actions github-actions bot added the engine reference Changes the Engine API Reference documentation label Mar 5, 2025
IgnisRBX
IgnisRBX reviewed Mar 17, 2025
View reviewed changes
@github-actions github-actions bot added the changes requested This pull request has changes requested prior to merging label Mar 17, 2025
@IgnisRBX
Copy link
Contributor

IgnisRBX commented Mar 17, 2025

Hi @TheWandererLee ,
Thanks for the contribution! Instead of linking to a direct version on Wikipedia with a lot of details, how about just listing what features the version/variant used for this API lacks? That way, developers who know the version differences in-depth can quickly identify what's going on, and readers who aren't quite as knowledgable on those in-depth details still get a sense of what this API does without going to Wikipedia to uncover it all.

@github-actions
Copy link

github-actions bot commented Mar 31, 2025

This pull request has been inactive for 14 days. If it remains inactive for another 7 days, it will close. Please update or comment on this pull request to keep it open. 🙏

@github-actions github-actions bot added the stale label Mar 31, 2025
@TheWandererLee
Improve UUID definition details
99e5f55 
Extracted the most relevant information from Wikipedia and UUIDTools to be placed directly in this documentation.
@TheWandererLee
Typo fix
d2c80e6
TheWandererLee
TheWandererLee commented Apr 1, 2025
View reviewed changes
Copy link
Contributor Author

@TheWandererLee TheWandererLee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've brought in more relevant info directly into this documentation. My apologies if it is not formatted correctly. Let me know if anything else is needed.

@github-actions github-actions bot removed the stale label Apr 1, 2025
@IgnisRBX
Copy link
Contributor

IgnisRBX commented Apr 1, 2025

@TheWandererLee ,
Thanks for the update. I made a few edits and merged them... want to do a final check for accuracy before I approve and merge?

@TheWandererLee
Copy link
Contributor Author

TheWandererLee commented Apr 2, 2025

It looks great to me, I believe the most important information is captured and conveyed well here 👍
Thanks for your help!

@IgnisRBX IgnisRBX merged commit c87ebb9 into Roblox:main Apr 2, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@IgnisRBX IgnisRBX IgnisRBX approved these changes

Assignees

No one assigned

Labels

changes requested This pull request has changes requested prior to merging engine reference Changes the Engine API Reference documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@TheWandererLee @IgnisRBX