josdejong/jsoneditor

Reckon with readOnly attribute of JSON Schema

Open

#922 opened on Mar 1, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (10,781 stars) (2,034 forks)batch import
featurehelp wanted

Description

It would be nice if fields marked as "readOnly" in the JSONSchema would be read only.

It has a tricky side effect of course: it would not be possible to start from an empty document and fill in all fields to make it valid JSON schema.

Ref: https://github.com/josdejong/jsoneditor/issues/920#issuecomment-592979760

Contributor guide

Tech stack
javascriptnodejs
Domain
frontendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JSON Schema basicsJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine how the JSON editor currently handles JSON Schema validation and modify the 'readOnly' attribute support. Look at the referenced issue #920 for context. The challenge is to prevent editing read only fields while allowing new fields to be added from an empty document. Consider using a state flag to track whether the document is 'pristine' to decide if readOnly restrictions apply. Files to look at include src/Node.js and src/JSONEditor.js.