Materials-Consortia / Materials-Consortia/optimade-python-tools
Implementation Metadata fields
@JPBergsma is already working on this.
Since Jul 5, 2023.
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
Recently, PR#463 has been merged with the OPTIMADE Specification.
I have therefore created this issue to keep track of the adoption of this PR in the optimade python tools.
One question I still have is whether we should return the meta field in case the optimade version is less than 1.2. A client that would specifically request version 1.2 would not understand the fields under meta. So I am wondering if we could break older clients. On the other hand, the JSON API specification does mention that there could be fields under meta so in that sense an older client could expect that there are values there.
ToDo
- : Get a basic metadata field shared.
- : Add tests for metadata field.
- : Make sure validator can handle metadata fields.
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.
Assessment
This issue has not been assessed yet.