Materials-Consortia / Materials-Consortia/optimade-python-tools

Add validator to check that response fields are taken into account for next link

Open
#1,012 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

validator
Dominant language
Python
Stars
91
Forks
54
PR merge metrics
No merged PRs in 30d

Description

In Materials-Consorta/OPTIMADE#391 it is discussed that the next field should take into account the response_field field as given in the query.
I was therefore wondering whether we should add a validator to check whether databases do this correctly.
(may take a while before I have time to do this)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked OPTIMADE issue #391 to understand how response_field should affect the next link. Then locate the repository's existing validators and tests, and define the validator's done condition as detecting databases whose next link does not account for the requested response fields.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.