Skip to content

Commit 8714ee3

Browse files
authored
fix(AIP-122): drop uuid disallowance (#1491)
1 parent 3ed3fcd commit 8714ee3

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

aip/general/0122.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,6 @@ ID for the publisher, and `les-miserables` is the resource ID for the book.
137137
- Characters outside of ASCII **should not** be permitted; however, if
138138
Unicode characters are necessary, APIs **must** follow guidance in
139139
[AIP-210][].
140-
- User-specified IDs **should not** be permitted to be a UUID (or any value
141-
that syntactically appears to be a UUID).
142140
- If resource IDs are not user-settable, the API **should** document the
143141
basic format, and any upper boundaries (for example, "at most 63
144142
characters").
@@ -400,8 +398,24 @@ preventing resource data duplication, and forcing the owning service to be
400398
involved in the resolution of the reference (via Standard Methods), guaranteeing
401399
isolation of logical concerns per-resource.
402400

401+
## History
402+
403+
### Disallowing UUIDs in user-specified IDs
404+
405+
As part of an effort to make APIs more declarative-friendly, APIs were required
406+
to allow user-specified resource ID on creation. As part of this, a supporting
407+
field `string uid` containing a UUID was also encouraged. Guidance was then
408+
added to discourage the _user-specified resource ID_ from being a UUID or
409+
even resembling one.
410+
411+
Ostensibly, the fact that `uid` contained a service-generated UUID motivated
412+
this restriction on the user-specified resource ID, forcing the user-specified
413+
resource ID to be a more "meaningful" value. However, we no longer saw value in
414+
this requirement, hence its removal.
415+
403416
## Changelog
404417

418+
- **2025-03-10**: Drop guidance disallowing UUID in user-specified ID.
405419
- **2024-10-15**: Add some rationale we found for use of `name` as a field and
406420
instead of IDs as an identifier.
407421
- **2024-06-14**: Clarify resource annotation shortening rules for nested

0 commit comments

Comments
 (0)