Materials-Consortia / Materials-Consortia/optimade-python-tools
Implement version negotiation for validator
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
@ml-evs I think the error occurring here is not the fault of the index meta-database, but rather our validator (see here).
Basically it shouldn't rely on the unversioned base URL endpoints, but rather the mandatory vMAJOR-versioned base URL endpoints.
Originally posted by @CasperWA in https://github.com/Materials-Consortia/providers/issues/57#issuecomment-755273260
In essence, the validator shouldn't fail if an unversioned base URL is not present. This is not a MUST have for an implementation according to the specification, only the vMAJOR-versioned base URL is absolutely mandatory, and hence should be the initial source of truth for the validator.
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 the validator entry point and the validation check linked in the issue. Compare how it discovers unversioned and vMAJOR-versioned base URLs against the specification, using the mandatory versioned endpoint as the initial source of truth. Done means validation succeeds when an unversioned base URL is absent but the required versioned endpoint is present.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100