Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a note about the known limitations of the credential claim metadata #280

Closed
wants to merge 1 commit into from
Closed

Add a note about the known limitations of the credential claim metadata #280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions openid-4-verifiable-credential-issuance-1_0.md
View file
Open in desktop
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
Copy link
Collaborator

@Sakurann Sakurann Feb 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the most important and should be the first one. and it should also be much more clearer, something like:

Suggested change
> * It is not possible to provide `mandatory`, `value_type` or `display` values for objects that contain claims
> * It is not possible to provide `mandatory`, `value_type` or `display` values for the intermediary claims in the nested objects

> * 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).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about the current framing... I think the following is sufficient.

Suggested change
> 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).
> Mechanisms that could address these limitations are being discussed in [Issue 266](https://github.com/openid/OpenID4VCI/issues/266).


Comment on lines +1998 to +2006
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have not used this > format in other places in the spec. I would like to avoid introducing it and drawing unnecessary attention to this

Suggested change
> 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).
Note that 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
Loading