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

Extend OpenAPI/spec description #151

Merged
merged 1 commit into from Jan 30, 2020
Merged

Extend OpenAPI/spec description #151

merged 1 commit into from Jan 30, 2020

Conversation

CasperWA
Copy link
Member

@CasperWA CasperWA commented Jan 30, 2020

This adds a notion of the spec's source material to the description.
The extension comes from a suggestion to the PR Materials-Consortia/OPTIMADE#242

@CasperWA CasperWA added the OpenAPI OpenAPI / Swagger related issue label Jan 30, 2020
@CasperWA CasperWA requested a review from merkys January 30, 2020 12:00
@codecov
Copy link

codecov bot commented Jan 30, 2020

Codecov Report

Merging #151 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@          Coverage Diff           @@
##           master    #151   +/-   ##
======================================
  Coverage    85.8%   85.8%           
======================================
  Files          39      39           
  Lines        1831    1831           
======================================
  Hits         1571    1571           
  Misses        260     260
Flag Coverage Δ
#unittests 85.8% <100%> (ø) ⬆️
Impacted Files Coverage Δ
optimade/server/main.py 89.09% <100%> (ø) ⬆️
optimade/server/main_index.py 86.36% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 53e83a3...4a5c72f. Read the comment docs.

Copy link
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.

Very good - now we have the provenance record inside the generated schema!

@CasperWA
Copy link
Member Author

Is there anything else you have in mind that could/should be added to the spec description now that we're at it @merkys? :)

@merkys
Copy link
Member

merkys commented Jan 30, 2020

Is there anything else you have in mind that could/should be added to the spec description now that we're at it @merkys? :)

I guess it's fine as is now, as it mentions the version of OPTiMaDe specification, inputs and tools to build it.

@CasperWA CasperWA merged commit f96cbfe into master Jan 30, 2020
@CasperWA CasperWA deleted the update_openapi branch January 30, 2020 13:49
@CasperWA CasperWA mentioned this pull request Feb 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OpenAPI OpenAPI / Swagger related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants