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

OpenAPI3 support #236

Merged
merged 11 commits into from
Jul 2, 2020
Merged

OpenAPI3 support #236

merged 11 commits into from
Jul 2, 2020

Conversation

rrudakov
Copy link
Contributor

@rrudakov rrudakov commented Jun 10, 2020

Known issues:

  • Project uses ring-swagger as dependency to validate generated swagger
    schema. Ring-swagger uses swagger2 specs so I can't write test to validate
    OpenAPI3 generated schema at the moment.
  • Any string can be used for content-type value
  • Callbacks in operations are not supported by current OpenAPI3 spec due to
    circular spec calls. I can declare callbacks as {string? any?} but I
    don't think it's a good idea.

@codecov-commenter
Copy link

codecov-commenter commented Jun 10, 2020

Codecov Report

Merging #236 into master will increase coverage by 1.80%.
The diff coverage is 97.53%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #236      +/-   ##
==========================================
+ Coverage   86.23%   88.04%   +1.80%     
==========================================
  Files          14       16       +2     
  Lines        1707     2032     +325     
  Branches      175      182       +7     
==========================================
+ Hits         1472     1789     +317     
- Misses         60       61       +1     
- Partials      175      182       +7     
Impacted Files Coverage Δ
src/spec_tools/swagger/core.cljc 97.56% <ø> (ø)
src/spec_tools/openapi/core.cljc 95.00% <95.00%> (ø)
src/spec_tools/openapi/spec.cljc 99.02% <99.02%> (ø)

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 fec40cc...62565ac. Read the comment docs.

@rrudakov rrudakov marked this pull request as ready for review June 12, 2020 21:30
@ikitommi
Copy link
Member

Looking good. I would like the openapi3 be renamed just to openapi, like the Swagger2 is just swagger. If openapi4 would be announced and it would be backwards compatible, users woudn't have to change the keys in the specs. e.g. :openapi3/type => :openapi4/type, would still be just :openapi/type.

@rrudakov
Copy link
Contributor Author

@ikitommi thank you for the feedback. I've renamed openapi3 to openapi.

@ikitommi
Copy link
Member

ikitommi commented Jul 2, 2020

Big thanks!!

@ikitommi ikitommi merged commit d70dfe3 into metosin:master Jul 2, 2020
@miikka
Copy link
Contributor

miikka commented Jul 24, 2020

Released in [metosin/spec-tools "0.10.4"]

This was referenced Jul 28, 2020
@rrudakov rrudakov deleted the openapi3 branch November 6, 2020 12:12
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.

4 participants