Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme jsonl definition #57

Merged
merged 3 commits into from
Apr 23, 2024
Merged

update readme jsonl definition #57

merged 3 commits into from
Apr 23, 2024

Conversation

eimrek
Copy link
Member

@eimrek eimrek commented Apr 23, 2024

hi @ml-evs

I updated the jsonl definition in the readme to match with what we use currently:

{"x-optimade": {"meta": {"api_version": "1.1.0"}}}
{"properties": {...}}
{"properties": {...}}
{"type": "structures", "id": "1234", "attributes": {...}}
{"type": "structures", "id": "1235", "attributes": {...}}
{"type": "references", "id": "sfdas", "attributes": {...}}

When v.1.2.0 comes out, I guess we can just update to

{"x-optimade": {"meta": {"api_version": "1.2.0"}}}
{"type": "info", "id": "structures", "properties": {...}}
{"type": "info", "id": "references", "properties": {...}}
{"type": "structures", "id": "1234", "attributes": {...}}
{"type": "structures", "id": "1235", "attributes": {...}}
{"type": "references", "id": "sfdas", "attributes": {...}}

@eimrek eimrek requested a review from ml-evs April 23, 2024 17:56
Copy link
Collaborator

@ml-evs ml-evs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, feel free to ignore my suggestion and merge

README.md Outdated Show resolved Hide resolved
Co-authored-by: Matthew Evans <7916000+ml-evs@users.noreply.github.com>
@eimrek eimrek merged commit 7af9407 into main Apr 23, 2024
1 check passed
@eimrek eimrek deleted the eimrek/update-readme-jsonl branch April 23, 2024 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants