Skip to content
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

Custom Header Support #1327

Merged
merged 4 commits into from
Oct 9, 2024
Merged

Conversation

clinta
Copy link
Contributor

@clinta clinta commented Sep 26, 2024

Related Issue

#896

New Behavior

This PR adds the ability to add custom headers to the API requests for both the inventory and lookup module. It supports headers in the module arguments, or as an environment variable in JSON format.

Contrast to Current Behavior

Currently there is no ability to add custom headers to API requests.

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.

Changes to the Documentation

Docstrings are updated

Proposed Release Note Entry

Add support for custom headers

Double Check

  • I have read the comments and followed the CONTRIBUTING.md.
  • I have explained my PR according to the information in the comments or in a linked issue.
  • My PR targets the devel branch.

@clinta clinta force-pushed the custom_headers branch 3 times, most recently from 7959ab9 to a3ca9d9 Compare September 26, 2024 04:37
clinta added a commit to clinta/netbox_ansible_modules that referenced this pull request Sep 26, 2024
clinta added a commit to clinta/netbox_ansible_modules that referenced this pull request Sep 26, 2024
sc68cal
sc68cal previously approved these changes Sep 26, 2024
Copy link
Contributor

@sc68cal sc68cal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@sc68cal
Copy link
Contributor

sc68cal commented Sep 26, 2024

Waiting for other maintainers to approve & merge since I prefer not to merge things without consensus

@sc68cal
Copy link
Contributor

sc68cal commented Oct 9, 2024

Haven't seen any other maintainers 👎 this so I'll merge

@sc68cal sc68cal merged commit 432b8fe into netbox-community:devel Oct 9, 2024
50 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants