[OpenAPI] Avoid caching request-specific spec URLs in HTML docs#354
Open
RedZapdos123 wants to merge 1 commit into
Open
[OpenAPI] Avoid caching request-specific spec URLs in HTML docs#354RedZapdos123 wants to merge 1 commit into
RedZapdos123 wants to merge 1 commit into
Conversation
The cached OpenAPI HTML page embedded the first request's absolute JSON URL. Derive the JSON path from the current browser pathname so the cached page stays request-independent across hosts and mount paths. Signed-off-by: Mridankan Mandal <xerontitan90@gmail.com>
This file contains hidden or 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
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.
Description:
Issue #353 reported that the cached OpenAPI HTML page embeds a request-specific spec URL from the first request.
This PR makes the cached HTML page request-independent by deriving the JSON spec URL from
window.location.pathnamein the browser instead of renderingrack.url_scheme,HTTP_HOST, andSCRIPT_NAMEinto the cached page.It also adds a regression spec that covers repeated HTML requests with different hosts and mount paths, and adds a changelog entry for the fix.
Before fix:
/docs-a:http://first.test:3000/docs-a/json/docs-b:http://first.test:3000/docs-a/jsonAfter fix:
window.location.pathname.Closes #353.
Checklist:
bundle exec rspec spec/openapi/openapi_spec.rb.bundle exec rspec spec/openapi.bundle exec rspec.