openwisp / openwisp/netjsonconfig
Overriding json-schema from backend does not override definitions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 388
- Forks
- 87
- Avg merge
- 1h 26m
- Merged PRs (30d)
- 4
Description
Let's say that we have a custom schema like in airos and that we print the schema, like it happens on a validation error report.
The interesting part is that redefined definitions do not override the default one as it can be read from the log
Against schema {'$ref': '#/definitions/ap_wireless_settings'}
{'proto': 'wpa2_personal', 'key': 'and-pizza-too'} is valid under each of
{'$ref': '#/definitions/encryption_wpa_personal'},
{'$ref': '#/definitions/encryption_wps'},
{'$ref': '#/definitions/encryption_wep'},
OrderedDict([('$ref', '#/definitions/encryption_none')]),
OrderedDict([('$ref', '#/definitions/encryption_wpa_personal')]),
OrderedDict([('$ref', '#/definitions/encryption_wpa_enterprise_sta')]),
{'$ref': '#/definitions/encryption_none'}
It seems that merge_config can merge a json-schema and OrderedDict but it treat the same definition as different elements.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting merge_config and reproduce the behavior with the custom schema from the airos branch and the validation error example linked in the issue. Trace how the JSON schema and OrderedDict are combined, focusing on repeated definitions keys. Done means a backend definition replaces the default definition during merging and validation no longer reports the default alternatives.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, python
- Domain
- backend, networking
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100