diff --git a/images/oa-embedded-certificate.png b/images/embedded-renderer-certificate.png similarity index 100% rename from images/oa-embedded-certificate.png rename to images/embedded-renderer-certificate.png diff --git a/images/embedded-renderer-sequence-diagram.png b/images/embedded-renderer-sequence-diagram.png new file mode 100644 index 0000000..903f6a3 Binary files /dev/null and b/images/embedded-renderer-sequence-diagram.png differ diff --git a/images/oa-embedded-transcript.png b/images/embedded-renderer-transcript.png similarity index 100% rename from images/oa-embedded-transcript.png rename to images/embedded-renderer-transcript.png diff --git a/images/oa-embedded-sequence-diagram.png b/images/oa-embedded-sequence-diagram.png deleted file mode 100644 index 4a8dc9d..0000000 Binary files a/images/oa-embedded-sequence-diagram.png and /dev/null differ diff --git a/index.html b/index.html index 2699c1e..1061ff0 100644 --- a/index.html +++ b/index.html @@ -628,10 +628,10 @@

The `nfc` Render Suite

-

OpenAttestationEmbeddedRenderer

+

EmbeddedRenderer

- OpenAttestationEmbeddedRenderer is used by an issuer to render a verifiable + EmbeddedRenderer is used by an issuer to render a verifiable credential. The verifiable credential is rendered in HTML within an embedded `<iframe>` through a Template Renderer website referenced in the document. This arrangement allows for interactive selective disclosure @@ -644,8 +644,8 @@

OpenAttestationEmbeddedRenderer

process.

- There currently exists a number of OpenAttestationEmbeddedRenderer issuers - and decentralized renderer implementations. + There currently exists a number of EmbeddedRenderer issuers + and embedded renderer implementations.

When an [=issuer=] desires to specify an embedded rendering instructions @@ -665,18 +665,18 @@

OpenAttestationEmbeddedRenderer

id A URL that locates a website that implements the - OpenAttestationEmbeddedRenderer Action API. + EmbeddedRenderer Action API. type - The `type` property MUST be `OpenAttestationEmbeddedRenderer`. + The `type` property MUST be `EmbeddedRenderer`. renderName Name of the template used by the website specified by `id` to render - the document. A different template can be used for the decentralized + the document. A different template can be used for the embedded renderer to present a different HTML view of the verifiable credential. @@ -693,69 +693,53 @@

OpenAttestationEmbeddedRenderer

class="example nohighlight" title="Usage of the renderMethod property by an issuer" > - { - "@context": [ - "https://www.w3.org/ns/credentials/v2", - "https://schemata.openattestation.com/com/openattestation/4.0/alpha-context.json" - ], - "type": ["VerifiableCredential", "OpenAttestationCredential"], - "validFrom": "2021-03-08T12:00:00+08:00", - "name": "Republic of Singapore Driving Licence", - "issuer": { - "id": "did:ethr:0xB26B4941941C51a4885E5B7D3A1B861E54405f90", - "type": "OpenAttestationIssuer", - "name": "Government Technology Agency of Singapore (GovTech)", - "identityProof": { "identityProofType": "DNS-DID", "identifier": "example.openattestation.com" } + { + "@context": [ + "https://www.w3.org/ns/credentials/v2", + "https://w3id.org/security/data-integrity/v2", + "https://trustvc.io/context/render-method-context-v2.json", + ], + "credentialSubject": { + ... + }, + "type": ["VerifiableCredential"], + "issuer": "did:web:trustvc.github.io:did:1", + "validFrom": "2024-04-01T12:19:52Z", + "id": "urn:uuid:01992e54-cc5e-700e-a80b-60ddf0fffca9", }, - "credentialSubject": { - "id": "urn:uuid:a013fb9d-bb03-4056-b696-05575eceaf42", - "type": ["DriversLicense"], - "name": "John Doe", - "address": "123 Choa Chu Kang Road, Singapore 123456", - "licenses": [ - { - "class": "3", - "description": "Motor cars with unladen weight <= 3000kg", - "effectiveDate": "2013-05-16T00:00:00+08:00" - }, + "renderMethod": [ { - "class": "3A", - "description": "Motor cars with unladen weight <= 3000kg", - "effectiveDate": "2013-05-16T00:00:00+08:00" + "type": "EMBEDDED_RENDERER", + "templateName": "DEMO_CERTIFICATE", + "id": "https://generic-templates.tradetrust.io" } - ] - }, - "renderMethod": [{ - "id": "https://demo-renderer.opencerts.io", - "type": "OpenAttestationEmbeddedRenderer", - "rendererName": "GOVTECH_DEMO" - }] + ] }

- The [=verifiable credential=] specifies a decentralized renderer at - `https://demo-renderer.opencerts.io`, using the template named - `GOVTECH_DEMO`. + The [=verifiable credential=] specifies a embedded renderer at + `https://generic-templates.tradetrust.io`, using the template named + `DEMO_CERTIFICATE`.

- The decentralized renderer can support different templates that can provide + The embedded renderer can support different templates that can provide different views of the verifiable credentials. Below are two renderings of the same [=verifiable credential=] using different templates.

-
+
Certificate Template
Certificate Template
-
+
Transcript Template
Transcript Template
@@ -789,7 +773,7 @@
Action API

An open source reference implementation is available on GitHub.

@@ -797,10 +781,10 @@
Action API
The interaction between the Host and the Template Renderer is illustrated in the following diagram.

-
+
Sequence Diagram
Sequence Diagram