w3c / w3c/vc-render-method

Folding `nfc` into a `static` render suite needs a dispatch mechanism

Open
#77 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discuss
Dominant language
HTML
Stars
9
Forks
8
Avg merge
14d 42m
Merged PRs (30d)
2

Description

The TF discussion on #54 converged on three broad suites: static (pre-baked artifacts), data (card object), and html. The spec currently keeps nfc as its own renderSuite value instead of folding it into static, because of a gap:

The nfc suite value tells the wallet what to do with the payload -- transmit it over an NFC radio, not display it. If NFC payloads, images, and PDFs all share renderSuite: "static", nothing else in the render method carries that distinction:

  1. template.mediaType does not work: the NFC example uses application/octet-stream, and there is no well-known registered media type that means "NDEF/NFC payload".
  2. outputPreference.accessMode (visual, auditory, tactile, textual) describes how a human perceives the rendering, not a machine transmission channel.

Some options include:

  • Keep nfc (and similar channel-specific methods) as their own suite values, reserving static for artifacts the wallet displays directly (current state of the spec).
  • Fold them into static and add a discriminator property (e.g. a channel or delivery hint).
  • Fold them into static and mint/register a dedicated media type for NFC payloads.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the specification's renderSuite definition and trace how template.mediaType and outputPreference.accessMode are used for dispatch. Compare the three options described here and determine which mechanism the specification should adopt; done means the suite model and its NFC distinction are resolved and reflected consistently in the spec.

Written by the indexing model from the issue text.

Assessment

Domain
design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.