Skip to content

v1.2.0 draft OpenAPI schemas#435

Closed
ml-evs wants to merge 3 commits intodevelopfrom
ml-evs/update_openapi_schemas
Closed

v1.2.0 draft OpenAPI schemas#435
ml-evs wants to merge 3 commits intodevelopfrom
ml-evs/update_openapi_schemas

Conversation

@ml-evs
Copy link
Copy Markdown
Member

@ml-evs ml-evs commented Dec 6, 2022

This PR contains the draft OpenAPI schema for v1.2.0-rc.1 based on work in Materials-Consortia/optimade-python-tools#1427.

Here, we can comment on the effect of our latest changes to the schema before releasing or see #434 for an alternative, where we remove the OpenAPI schemas from this repo, do not consider them blocking for OPTIMADE releases, and instead use the Materials-Consortia/schemas repo (I will make a PR there too).

Comment thread tests/scripts/validate_swagger.sh
@ml-evs ml-evs force-pushed the ml-evs/update_openapi_schemas branch from e39ef42 to 0f065e4 Compare December 7, 2022 10:47
@ml-evs ml-evs added the blocking-release This is a PR or issue that presently blocks the release of next version of the spec. label Dec 22, 2022
@ml-evs ml-evs added this to the v1.2 milestone Dec 22, 2022
rartino
rartino previously approved these changes Jun 11, 2023
Copy link
Copy Markdown
Contributor

@rartino rartino left a comment

Choose a reason for hiding this comment

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

No real reason not to approve this; except maybe the openapi schemas anyway should be removed or updated by the new schema system in #445

merkys
merkys previously approved these changes Jun 12, 2023
Copy link
Copy Markdown
Member

@merkys merkys left a comment

Choose a reason for hiding this comment

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

Approving, but, as @rartino noted, there still be changes in the schemas prior to v1.2.0 release.

@merkys
Copy link
Copy Markdown
Member

merkys commented Dec 20, 2023

@ml-evs could you please refresh this PR as #464 is in now? I base my preview implementation on OpenAPI schemas.

@ml-evs
Copy link
Copy Markdown
Member Author

ml-evs commented Dec 20, 2023

@ml-evs could you please refresh this PR as #464 is in now? I base my preview implementation on OpenAPI schemas.

I can try, but this is a non-trivial amount of work to do properly. I will try to update the corresponding work in optimade-python-tools shortly Materials-Consortia/optimade-python-tools#1427 (probably just in an ad hoc way for now since things have changed quite a lot in the underlying package recently so I can't make any correctness guarantees).

@merkys
Copy link
Copy Markdown
Member

merkys commented Dec 20, 2023

@ml-evs could you please refresh this PR as #464 is in now? I base my preview implementation on OpenAPI schemas.

I can try, but this is a non-trivial amount of work to do properly. I will try to update the corresponding work in optimade-python-tools shortly Materials-Consortia/optimade-python-tools#1427 (probably just in an ad hoc way for now since things have changed quite a lot in the underlying package recently so I can't make any correctness guarantees).

Sure, no hurry!

@ml-evs
Copy link
Copy Markdown
Member Author

ml-evs commented Dec 23, 2023

@merkys Just pushed a draft refresh of this that relies on the ECMA regexp for symm ops at #488.

Comment thread schemas/openapi_schema.json Outdated
Comment thread schemas/openapi_schema.json Outdated
Comment thread schemas/openapi_schema.json
@ml-evs ml-evs force-pushed the ml-evs/update_openapi_schemas branch from b1c9229 to 5abb5ea Compare January 4, 2024 12:43
@ml-evs ml-evs added the status/blocked Blocked by other PRs that must be handled first label Mar 21, 2024
@ml-evs
Copy link
Copy Markdown
Member Author

ml-evs commented Mar 22, 2024

Following online discussions and #502, this PR is now closed and OpenAPI schemas will be removed from this repo altogether. They will remain in the schemas repo: https://github.com/Materials-Consortia/schemas

@ml-evs ml-evs closed this Mar 22, 2024
@ml-evs ml-evs deleted the ml-evs/update_openapi_schemas branch November 4, 2025 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocking-release This is a PR or issue that presently blocks the release of next version of the spec. status/blocked Blocked by other PRs that must be handled first

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants