Open
Description
Summary of request
A common request is to have natural language display names for fields and schemas, these can be used in UIs that present data described by the dictionary and do not have the same naming restrictions as the name
property.
Details
Add to the metaSchema for Schema
and SchemaField
the property displayName
that is an optional string.
Display names would allow all characters (including .
which is not allowed in schema and field names). Display names would be optional, any interface that wants to display information can fall back to the required name.
Checks
- Property added to metaSchema
- Dictionary reference docs updated
- Generated JSONSchema is updated
Additional context
PCGL has requested that submission use either the name or a display name. They are currently providing displayName
as a property in field.meta
.