Use a document relative url for specs #444
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
That means that what was previously /example.SomeSpec.yaml will now be /docs/specs/example.SomeSpec.yaml
Baccata
approved these changes
Sep 9, 2022
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.
That means that what was previously
"urls": ["/example.SomeSpec.yaml"]will now be
"urls": ["./docs/specs/example.SomeSpec.yaml"]docsis from the path the user provided when initializing the route,specsis added in this PR.This is to be able to write
./specs/example.SomeSpec.yamlin theurlsarray for swagger initialization. Rather than asking for/example.SomeSpec.yaml, we ask for./example.SomeSpec.yamland because this conflicts with other paths such as./swagger-ui.cssI've decided to serve specs under a specific path instead.In the browser, this ends up being:
In the screenshot above, we see requests from the browser after loading
/docs/index.htmlfrom behind a proxy at/admin/docs/index.html. Before, the request would behttp://localhost/examples.hello.HelloWorldService.jsonand it would fail to resolve (missing/admin), where as nowhttp://localhost/admin/docs/specs/examples.hello.HelloWorldService.jsonworks.Relates to #439 but its not sufficient to close it.