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

Detailed purpose of this repository #1

Open
CasperWA opened this issue Jul 1, 2020 · 1 comment
Open

Detailed purpose of this repository #1

CasperWA opened this issue Jul 1, 2020 · 1 comment

Comments

@CasperWA
Copy link
Member

CasperWA commented Jul 1, 2020

Other than hosting the (OpenAPI) schemas, is this repository also meant to host the source of those schemas, i.e., the Python models made in optimade-python-tools?

@rartino
Copy link
Contributor

rartino commented Jul 1, 2020

No. At least that was not my idea.

IMO the schema "source" belongs in the main OPTIMADE repo alongside the specification, so that we in the future can find a workflow that keeps the schemas and the specification text in sync. Our present workflow of delaying the schema updates to just before releases is not a good idea. It requires duplicate work, is error-prone, and makes it difficult to test-implement features from the develop version.

What I hope to move over to at some point post-v1.0 is that we simply tag up the specification so that we instead can generate the OpenAPI schemas straight out of the specification rst file, rather then go via optimade-python-tools. Having spent some time with the OpenAPI schemas preparing Materials-Consortia/OPTIMADE#303, this seems fairly straightforward to set up.

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

No branches or pull requests

2 participants