Replace view reverse URLs with header value #14934
Closed
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
Enables replacing part of the URLs that
appear on the API page with a request header.
If a special header is present in the HTTP request,
the substring will be replaced with the header value
provided.
for example,
in settings.py
URL_REPLACE_FROM_HEADER = {
'header': 'Aap-Prefix',
'to_replace': 'api/v2',
}
will replace occurrences of
api/v2/instances/3
with
api/controller/v2/instances/3
if 'Aap-Prefix' is defined in the request header.
This feature is added to allow consistent URLs when
controller is deployed alongside aap-gateway.
Signed-off-by: Seth Foster <[email protected]>
fosterseth
changed the title
|
note: hyperlinking only works after disabling the |
AlanCoding
reviewed
Feb 28, 2024
| @@ -165,6 +165,11 @@ | |||
| # reverse proxy. | |||
| REMOTE_HOST_HEADERS = ['REMOTE_ADDR', 'REMOTE_HOST'] | |||
|
|
|||
| URL_REPLACE_FROM_HEADER = { | |||
| 'header': 'Aap-Prefix', # e.g. api/controller/v2 | |||
| 'to_replace': 'api/v2', # the header string will replace this substring in the URL | |||
There was a problem hiding this comment.
this would be a great thing to test using override_settings
There was a problem hiding this comment.
No wait, we don't care about different setting values. We want to test different headers. Not sure if this is doable in unit tests now.
|
I believe this was solved in another pr |
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.
SUMMARY
Enables replacing part of the URLs that appear on the API page with a request header.
If a special header is present in the HTTP request, the substring will be replaced with the header value provided.
for example,
in settings.py
This will replace
with
if 'Aap-Prefix' is defined in the request header.
This feature is added to allow consistent URLs when controller is deployed alongside aap-gateway.
reversefrom restframework and django.urls instead of our custom definedreverse. So we may need to tweak those importsISSUE TYPE
COMPONENT NAME