-
Notifications
You must be signed in to change notification settings - Fork 416
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 base path configuration for OpenAPI 3 #547
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
romanblanco
force-pushed
the
open-api-3-base-path
branch
from
September 5, 2022 13:41
a5619d5
to
75f5430
Compare
14 tasks
romanblanco
force-pushed
the
open-api-3-base-path
branch
from
September 12, 2022 14:49
75f5430
to
a55cf2f
Compare
romanblanco
force-pushed
the
open-api-3-base-path
branch
from
September 13, 2022 12:33
a55cf2f
to
5dbab7a
Compare
Hi @jtannas, could you look at the changes to see if it makes sense to you? |
jtannas
reviewed
Sep 18, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution! 🙂
I really appreciate the help while I'm getting this all figured out.
Just a few notes on places I found difficult to follow and it should be good to go!
romanblanco
force-pushed
the
open-api-3-base-path
branch
from
September 19, 2022 09:28
5dbab7a
to
2264b03
Compare
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
API Host and base URL definition has changed from OAS2 to OAS3.
schemes
,host
andbasePath
definitions are being replaced by Server ObjectThis is causing issue #318.
Closes #397
Closes #318
Solution
I'm building on top of @developingchris's approach from #397.
The solution is to parse the URL from the Server Object.
This concerns this parts of the Open API Specification:
The changes I made are compatible with:
Related Issues
basePath
, butbasePath
generates invalid Swagger #318Checklist
Addeddocumentation to README.mdSteps to Test or Reproduce
see #318