Skip to content

Commit c87ebb9

Browse files
Add UUID Version & Variant to GenerateGUID description (#1045)
## 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](https://www.uuidtools.com/decode). * 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](https://uuid7.com/), [ULID](https://github.com/ulid/spec)). * More info at [Wikipedia](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) 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: - [X] 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. - [X] 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. - [X] To the best of my knowledge, all proposed changes are accurate. --------- Co-authored-by: IgnisRBX <[email protected]>
1 parent c8008ba commit c87ebb9

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

content/en-us/reference/engine/classes/HttpService.yaml

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,25 @@ methods:
111111
summary: |
112112
Generates a UUID/GUID random string, optionally with curly braces.
113113
description: |
114-
This method randomly creates a [universally unique identifier
115-
[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)
114+
This method generates a **random universally unique identifier**
115+
([UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier))
116116
string. The sixteen octets of a UUID are represented as 32 hexadecimal
117-
(base 16) digits, displayed in 5 groups separated by hyphens in the form
118-
`8-4-4-4-12` for a total of 36 characters, for example
117+
(base&nbsp;16) digits, displayed in five groups separated by hyphens in
118+
the form `8-4-4-4-12` for a total of 36 characters, for example
119119
`123e4567-e89b-12d3-a456-426655440000`.
120+
121+
The UUID specification used is [Version 4
122+
(random)](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)),
123+
variant 1 (DCE 1.1, ISO/IEC 11578:1996). UUIDs of this version are the
124+
most commonly used due to their simplicity, as they are entirely randomly
125+
generated. Note that this version does not have certain features that
126+
other UUID versions have, such as encoded timestamps, MAC addresses, or
127+
time-based sorting like [UUIDv7](https://uuid7.com/) or
128+
[ULID](https://github.com/ulid/spec).
129+
130+
There are over 5.3&times;10<sup>36</sup> unique v4 UUIDs, in which the
131+
probability of finding a duplicate within 103 trillion UUIDs is one in a
132+
billion.
120133
121134
The `wrapInCurlyBraces` argument determines whether the returned string is
122135
wrapped in curly braces (`{}`). For instance:

0 commit comments

Comments
 (0)