You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The name and description sections linked above say:
It is RECOMMENDED that all JSON Schemas include a name property which provides a human-readable name that describes the schema.
JSON Schemas MAY choose to include an optional description property which provides a human-readable sentence describing the schema.
While the name and description fields are defined by JSONSchema, the schemas being defined by users of vc-json-schema are defined by VC. The schemas are used to describe various credential documents. The schema documents thus might need to be localized or need to include language and direction metadata so that users can understand what the credential is supposed to represent.
As a result, there should be notes about including natural language metadata in each of these sections or guidance about how to localize a schema description in the Internationalization Considerations section (or both).
The text was updated successfully, but these errors were encountered:
thanks @aphillips I will add language to this effect, noting that human readable metadata such as name and description are candidates for localization in json schemas
@aphillips thanks for the feedback! I've attempted to fix in #225, by requiring a new field which I named locale. It's optional, so when absent it defaults to en-US. Is this something that looks good to you?
3.1.3 name, 3.1.4 description
https://www.w3.org/TR/vc-json-schema/#name
https://www.w3.org/TR/vc-json-schema/#description
The
name
anddescription
sections linked above say:While the
name
anddescription
fields are defined by JSONSchema, the schemas being defined by users of vc-json-schema are defined by VC. The schemas are used to describe various credential documents. The schema documents thus might need to be localized or need to include language and direction metadata so that users can understand what the credential is supposed to represent.As a result, there should be notes about including natural language metadata in each of these sections or guidance about how to localize a schema description in the Internationalization Considerations section (or both).
The text was updated successfully, but these errors were encountered: