Materials-Consortia / Materials-Consortia/optimade-python-tools
Default response fields are not validated
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
According to my reading of the specification, if a REQUIRED field has been left out, it should still be present as null by default (i.e. when no response fields have been requested).
We do not validate this currently. If we started validating this, many implementations would fail with an error per field, per structure(!!).
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
The issue names no file, test, or entry point. Start by reading the relevant OPTIMADE specification requirements and tracing the existing response-field validation path. Done means default responses represent omitted REQUIRED fields as null and validation behavior is covered without producing the described per-field, per-structure failure storm.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api, backend-api-design
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100