Materials-Consortia / Materials-Consortia/optimade-python-tools
Stricten requirements on base info fields
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
The cited fields in OPTIMADE have quite strictly defined values, IMO:
https://github.com/Materials-Consortia/optimade-python-tools/blob/5160a2c47f02d070144a62bd391edc2ca63367af/optimade/models/baseinfo.py#L71-L80
- Items of
formatsmust match regex^(json|_.*)$ - Items of
available_endpointsare as well limited to the supported endpoints plus^_ entry_types_by_formatare essentially limited by the same requirements
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 with optimade/models/baseinfo.py at lines 71-80 and inspect how formats, available_endpoints, and entry_types_by_format are currently validated. Tighten validation to match the restrictions listed in the issue, then verify that supported values and values beginning with '_' remain accepted while other values are rejected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100