claims description mixes display and schema information
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 125
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
Claims description in the metadata is introduced as
A claims description object as used in the Credential Issuer metadata is an
object used to describe how a certain claim in the Credential should be
displayed to the End-User. It is used in theclaims
parameter in the Credential Issuer metadata defined in (#format-profiles).
It however seems to contain information that goes more into the realm of schema definitions with
value_typewhich denotes the type of a value (removed in the last PR)- claim description that does not contain
display- which basically seems to be a signal that this claim exists in the specific credential (especially for claims that are optional in their credential schema)
example for the second part:
...
{
"path": ["address"],
"display": [
{
"name": "Place of residence",
"locale": "en-US"
},
{
"name": "Wohnsitz",
"locale": "de-DE"
}
]
},
{"path": ["address", "street_address"]},
{"path": ["address", "locality"]},
{"path": ["address", "region"]},
...
I am not convinced we need both currently as all major credential formats seem to have their own mechanism to convey schema:
- namespace for mdoc
- vct for sd-jwt
- context for w3c vcdm
To me, it feels like both mechanisms are either under-specified or not entirely necessary & seem to duplicate the schema information of the credential formats.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the claims description definition in the Credential Issuer metadata and the referenced #format-profiles section. Compare the stated display purpose with value_type and entries lacking display, then determine whether the metadata should retain, separate, or remove the schema-related information. Done requires an agreed specification direction and corresponding definition and example updates.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100