Add support for custom headers in all Netbox modules #1433
Merged
Conversation
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
Add custom header parameter based on @clinta work in netbox-community#1327
Reflect signature change in the doc file: `modified: docs/getting_started/contributing/modules/architecture.rst`
benoit-ferre
changed the title
|
I saw somme ansible-lint errors on files I don't touch.
|
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Related Issue
Extends the scope of #896
New Behavior
This PR adds the ability to add custom headers to the API requests for all modules. It supports headers in the module arguments.
This PR is inspired by @clinta work in #1327
Contrast to Current Behavior
Currently there is no ability to add custom headers to API requests beyond inventory and lookup module.
Discussion: Benefits and Drawbacks
Custom headers are required for many deployments behind reverse proxies for additional authentication tokens or cookies. This only adds new compatibility and is fully backwards compatible.
It makes also all modules compatible with netbox branching plugin.
Drawback:
This PR modify the signature of the NetboxModule._connect_netbox_api function.
Changes to the Documentation
Documentation has been updated to reflect the new header support and NetboxModule._connect_netbox_api signature change in
docs/getting_started/contributing/modules/architecture.rstfile.Proposed Release Note Entry
Add support for custom headers on all modules.
Double Check
develbranch.