Skip to content

Request - Add displayName to field and schema #253

@joneubank

Description

@joneubank

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationHelp docs are needed for this/writing docs neededenhancementNew feature or requestgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions