Skip to content

docs: move JSON-LD background page to the wiki #4675

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

Open
reinkrul wants to merge 3 commits into from
Open

docs: move JSON-LD background page to the wiki #4675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34af585
docs: move JSON-LD background page to the wiki
reinkrul Nov 5, 2026
c80a067
docs: use permanent wiki link for the JSON-LD page
reinkrul Nov 5, 2026
47513a6
docs: explain how the node uses JSON-LD contexts and list the built-i…
reinkrul Nov 6, 2026
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
16 changes: 16 additions & 0 deletions docs/pages/deployment/verifiable-credentials.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,22 @@ Or it can fetch the context definition from disk, using a mapping from url to pa

The default contexts can be accessed using the embedded file system `assets/contexts`. The contents of this directory can be found on Github: The default loaded contexts can be downloaded from the `Github repo <https://github.com/nuts-foundation/nuts-node/tree/master/vcr/assets/assets/contexts>`_.

The node uses JSON-LD contexts to normalize a credential when it creates or verifies a JSON-LD proof (``ldp_vc``, ``ldp_vp``), and to search credentials (``POST /internal/vcr/v2/search``).
So the node must know every context a credential uses; otherwise it can't verify or search it.
Credentials in JWT format (``jwt_vc``) are verified without the contexts.
Context URLs are identifiers: they don't have to resolve, as long as the node has a local mapping for them.

Built-in contexts (mapped to local files by default, see ``jsonld.contexts.localmapping``):

- ``https://www.w3.org/2018/credentials/v1``: W3C Verifiable Credentials
- ``https://w3c-ccg.github.io/lds-jws2020/contexts/lds-jws2020-v1.json``: ``JsonWebSignature2020`` proofs
- ``https://w3id.org/vc/status-list/2021/v1``: StatusList2021 revocation
- ``https://schema.org``
- ``https://nuts.nl/credentials/v1``: Nuts credentials such as ``NutsOrganizationCredential`` and ``NutsAuthorizationCredential``
- ``https://nuts.nl/credentials/2024``: ``NutsUraCredential``

Background on JSON-LD in Nuts is on the `wiki <https://wiki.nuts.nl/link/196>`_.

Example configuration
^^^^^^^^^^^^^^^^^^^^^

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/integrating/vc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The node will add sensible defaults for:
You are required to provide the ``credentialSubject``, the ``issuer``, the ``type`` and an optional ``@context`` and ``expirationDate``.
If you do not pass a `@context`, it'll be set: ``["https://www.w3.org/2018/credentials/v1", "https://nuts.nl/credentials/v1"]``.
Note that this default does not include the latest version of the Nuts JSON-LD context.
The latest Nuts JSON-LD context can be found :ref:`here <jsonld>`.
The Nuts JSON-LD contexts are listed on the `wiki <https://wiki.nuts.nl/link/196>`_.

Calling `/internal/vcr/v2/issuer/vc` with

Expand Down
15 changes: 0 additions & 15 deletions docs/pages/technology/jsonld.rst
View file
Open in desktop

This file was deleted.

Loading