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

Improve documentation for API filtering #2489

New Issue
Closed
opened 2025-12-29 18:19:18 +01:00 by adam · 3 comments
adam commented 2025-12-29 18:19:18 +01:00
Owner
Copy Link

Originally created by @ajknv on GitHub (Apr 3, 2019).

Environment

  • Python version: 3.6.8
  • NetBox version: 2.5.7

Steps to Reproduce

  1. Try to query interfaces using multiple filter values for "mac_address", or "device_id".

Expected Behavior

The API should return all of the records matching any of the filter values as documented.

Observed Behavior

Only results matching the final filter value are returned, contrary to the documentation indicating that a logical OR should have been performed.

The patch applied for https://github.com/digitalocean/netbox/issues/2577 still results in quite deficient documentation. "Certain filters can be included multiple times" -- how can we know or determine which ones? Any why only those ones? At the very least if the filter cannot be properly honored with multiple values the API should respond with an error, so consumers of the API aren't potentially just chugging along with missing data that was silently dropped.

Originally created by @ajknv on GitHub (Apr 3, 2019). ### Environment * Python version: 3.6.8 * NetBox version: 2.5.7 ### Steps to Reproduce 1. Try to query interfaces using multiple filter values for "mac_address", or "device_id". <!-- What did you expect to happen? --> ### Expected Behavior The API should return all of the records matching any of the filter values as documented. <!-- What happened instead? --> ### Observed Behavior Only results matching the final filter value are returned, contrary to the documentation indicating that a logical OR should have been performed. The patch applied for https://github.com/digitalocean/netbox/issues/2577 still results in quite deficient documentation. "Certain filters can be included multiple times" -- how can we know or determine *which* ones? Any why only those ones? At the very least if the filter cannot be properly honored with multiple values the API should respond with an error, so consumers of the API aren't potentially just chugging along with missing data that was silently dropped.
adam added the type: bugstatus: accepted labels 2025-12-29 18:19:18 +01:00
adam closed this issue 2025-12-29 18:19:18 +01:00
adam commented 2025-12-29 18:19:18 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Dec 13, 2019):

IMO this is not a documentation problem, but a bug with the filters.

@jeremystretch commented on GitHub (Dec 13, 2019): IMO this is not a documentation problem, but a bug with the filters.
adam commented 2025-12-29 18:19:19 +01:00
Author
Owner
Copy Link

@hSaria commented on GitHub (Jan 15, 2020):

Referring to the bug, this is fixed in v2.6.12 (possibly earlier, but didn't check); you can specify multiple values and they'll be OR-ed.

@hSaria commented on GitHub (Jan 15, 2020): Referring to the bug, this is fixed in v2.6.12 (possibly earlier, but didn't check); you can specify multiple values and they'll be OR-ed.
adam commented 2025-12-29 18:19:19 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jan 15, 2020):

Agreed. Going to consider this resolved.

@jeremystretch commented on GitHub (Jan 15, 2020): Agreed. Going to consider this resolved.
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: bug
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#2489
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?