w3c / w3c/json-ld-api

Describe "safe mode" for JSON-LD processing.

Open
#629 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

spec:substantive substantive:class 4
Dominant language
HTML
Stars
106
Forks
40
PR merge metrics
No merged PRs in 30d

Description

JSON-LD Safe Mode has been part of the jsonld.js implementation since 2022:
https://github.com/digitalbazaar/jsonld.js?tab=readme-ov-file#safe-mode

There is an interest from other communities for this to be a core part of the JSON-LD API as the current default of ignoring unmapped terms (for example) is seen as a risk when attempting to enforce explicit JSON shapes.

@dlongley and @davidlehn can provide more details.

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

Read the linked jsonld.js README section on Safe Mode and compare it with the JSON-LD API issue's request for Safe Mode to become part of the core API. Clarify the intended API behavior and what specification documentation would need to describe before defining completion.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.