Requirement for alphanumeric IDs
javagl opened this issue · 2 comments
The Identifiers section currently defines the requirement that "IDs" have to match a certain regex. The specification contains documentations for these IDs in the following form:
- https://github.com/CesiumGS/3d-tiles/tree/draft-1.1/specification/Metadata#id
- https://github.com/CesiumGS/3d-tiles/tree/draft-1.1/specification/Metadata#id-1
The second one refers to the actual name of the enum in the schema, as in
"enums : {
"thisIsTheId": { ... }
}
The first one exists as an actual property that is called schema.id.
The reason for applying this constraint to dictionary keys is that these dictionaries might be converted into structures (like a GLSL struct) at the consuming side. A property name like
"exampleClass" : {
"---NOT-VALID--": { ... }
}
should therefore not be valid.
But this requirement also found its way into the schema.id property. This ID is never used as a key in a dictionary. The requirement may be omitted there.
It would be good to have a clearer distinction for when the term "ID" refers to a key in a dictionary, and when it refers to an actual property called id.
Somewhat related: The ID property has been removed from 'group' via #678 , so the only place where we still have an ID in the schema is for the 'schema' schema. There, the requirement for being alphanumeric might be relaxed in the future.
It might be relaxed in the future. But right now it is the way it is. Closing for now.