Skip to content

Commit

Permalink
Add a note about the known limitations of the credential claim metadata
Browse files Browse the repository at this point in the history
As discussed on yesterday's working group call:

#266 (comment)

As it seems likely that #276
will not make it into implementer's draft 1, we instead add warnings
about the known limitations of the current data structure so that
implementer's are aware.

Note that I have not applied this to the mdoc profile section, as that
sections seems not to allow nested objects in the metadata.
  • Loading branch information
jogu committed Feb 28, 2024
1 parent d7194ef commit 73c531d
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions openid-4-verifiable-credential-issuance-1_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -1995,6 +1995,15 @@ The following additional Credential Issuer metadata parameters are defined for t
* `locale`: OPTIONAL. String value that identifies language of this object represented as language tag values defined in BCP47 [@!RFC5646]. There MUST be only one object for each language identifier.
* `order`: OPTIONAL. Array of the claim name values that lists them in the order they should be displayed by the Wallet.

> The above metadata structure has some known limitations:
>
> * It cannot be used to describe claims in credentials that have the name `mandatory`, `value_type` or `display`.
> * It is not possible to provide `mandatory`, `value_type` or `display` values for objects that contain claims
> * The `order` parameter cannot be used for claims within objects
> * Arrays of unknown size cannot be described
>
> These limitations are expected to be resolved in the second Implementer's Draft, a proposal can be viewed in [Issue 266](https://github.com/openid/OpenID4VCI/issues/266).
The following is a non-normative example of an object containing the `credential_configurations_supported` parameter for Credential format `jwt_vc_json`:

<{{examples/credential_metadata_jwt_vc_json.json}}
Expand Down Expand Up @@ -2060,6 +2069,14 @@ The following additional Credential Issuer metadata parameters are defined for t
* `locale`: OPTIONAL. String value that identifies language of this object represented as language tag values defined in BCP47 [@!RFC5646]. There MUST be only one object for each language identifier.
* `order`: OPTIONAL. Array of the claim name values that lists them in the order they should be displayed by the Wallet.

> The above metadata structure has some known limitations:
>
> * It cannot be used to describe claims in credentials that have the name `mandatory`, `value_type` or `display`.
> * It is not possible to provide `mandatory`, `value_type` or `display` values for objects that contain claims
> * The `order` parameter cannot be used for claims within objects
> * Arrays of unknown size cannot be described
>
> These limitations are expected to be resolved in the second Implementer's Draft, a proposal can be viewed in [Issue 266](https://github.com/openid/OpenID4VCI/issues/266).
The following is a non-normative example of an object containing the `credential_configurations_supported` parameter for Credential format `ldp_vc`:

Expand Down Expand Up @@ -2206,6 +2223,15 @@ The following additional Credential Issuer metadata parameters are defined for t
* `locale`: OPTIONAL. String value that identifies language of this object represented as language tag values defined in BCP47 [@!RFC5646]. There MUST be only one object for each language identifier.
* `order`: OPTIONAL. An array of the claim name values that lists them in the order they should be displayed by the Wallet.

> The above metadata structure has some known limitations:
>
> * It cannot be used to describe claims in credentials that have the name `mandatory`, `value_type` or `display`.
> * It is not possible to provide `mandatory`, `value_type` or `display` values for objects that contain claims
> * The `order` parameter cannot be used for claims within objects
> * Arrays of unknown size cannot be described
>
> These limitations are expected to be resolved in the second Implementer's Draft, a proposal can be viewed in [Issue 266](https://github.com/openid/OpenID4VCI/issues/266).
The following is a non-normative example of an object comprising the `credential_configurations_supported` parameter for Credential format `vc+sd-jwt`.

<{{examples/credential_metadata_sd_jwt_vc.json}}
Expand Down

0 comments on commit 73c531d

Please sign in to comment.