starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Document 'exclude' filter for API calls #3907

New Issue
Closed
opened 2025-12-29 18:31:55 +01:00 by adam · 1 comment
adam commented 2025-12-29 18:31:55 +01:00
Owner
Copy Link

Originally created by @tyler-8 on GitHub (Jul 27, 2020).

Originally assigned to: @tyler-8 on GitHub.

Change Type

[X] Addition
[ ] Correction
[ ] Deprecation
[ ] Cleanup (formatting, typos, etc.)

Area

[ ] Installation instructions
[ ] Configuration parameters
[ ] Functionality/features
[X] REST API
[ ] Administration/development
[ ] Other

Proposed Changes

Similar to https://github.com/netbox-community/netbox/issues/2671 and https://github.com/netbox-community/netbox/issues/4729, the exclude=config_context filter was added in v2.6 but hasn't been documented outside of the release notes.

I propose adding the same snippet from the release notes under the Filtering header on the API documentation. Many questions and issues are generated from the performance of config contexts (to be addressed by https://github.com/netbox-community/netbox/issues/4559) and until that is improved, I think adding this workaround to the documentation will go a long way in reducing headaches.

Happy to take this one if approved.

Originally created by @tyler-8 on GitHub (Jul 27, 2020). Originally assigned to: @tyler-8 on GitHub. <!-- NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED. Please indicate the nature of the change by placing an X in one of the boxes below. --> ### Change Type [X] Addition [ ] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) ### Area [ ] Installation instructions [ ] Configuration parameters [ ] Functionality/features [X] REST API [ ] Administration/development [ ] Other <!-- Describe the proposed change(s). --> ### Proposed Changes Similar to https://github.com/netbox-community/netbox/issues/2671 and https://github.com/netbox-community/netbox/issues/4729, the `exclude=config_context` filter was added in [v2.6](https://github.com/netbox-community/netbox/blob/f2d1c7d82a659c1a06381e340dcedfd45edcbd80/docs/release-notes/version-2.6.md) but hasn't been documented outside of the release notes. I propose adding the same snippet from the release notes under the `Filtering` header on the [API documentation](https://github.com/netbox-community/netbox/blob/3baf983e8610ef62849bd2e5e4011eb3ef67071f/docs/api/overview.md). Many questions and issues are generated from the performance of config contexts (to be addressed by https://github.com/netbox-community/netbox/issues/4559) and until that is improved, I think adding this workaround to the documentation will go a long way in reducing headaches. Happy to take this one if approved.
adam added the status: acceptedtype: documentation labels 2025-12-29 18:31:55 +01:00
adam closed this issue 2025-12-29 18:31:56 +01:00
adam commented 2025-12-29 18:31:56 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 27, 2020):

Thanks @tyler-8!

@jeremystretch commented on GitHub (Jul 27, 2020): Thanks @tyler-8!
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#3907
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?