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

Remove filter form from the browsable API #1466

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

Originally created by @jeremystretch on GitHub (Dec 19, 2017).

Issue type

[ ] Feature request
[x] Bug report
[ ] Documentation

Environment

  • Python version: 3.5.2
  • NetBox version: 2.2.7

Description

When viewing an API endpoint in a web browser, NetBox returns a convenient browsable interface. Currently, this interface includes a button which brings up a modal containing all the filter options for the endpoint. Each field in this form is prepopulated with all potential values. This introduces a huge performance hit when viewing, for example, the IP addresses endpoint, as the interface_id field is pre-populated with all interfaces defined in NetBox.

Given that the available filters for each endpoint are documented separately, there is not much value in including the filter form in the browsable API. We can simply omit it from the API renderer and avoid what is in many cases a large amount of overhead and delay.

Originally created by @jeremystretch on GitHub (Dec 19, 2017). ### Issue type [ ] Feature request <!-- An enhancement of existing functionality --> [x] Bug report <!-- Unexpected or erroneous behavior --> [ ] Documentation <!-- A modification to the documentation --> ### Environment * Python version: 3.5.2 * NetBox version: 2.2.7 ### Description When viewing an API endpoint in a web browser, NetBox returns a convenient browsable interface. Currently, this interface includes a button which brings up a modal containing all the filter options for the endpoint. Each field in this form is prepopulated with _all_ potential values. This introduces a huge performance hit when viewing, for example, the IP addresses endpoint, as the `interface_id` field is pre-populated with all interfaces defined in NetBox. Given that the available filters for each endpoint are documented separately, there is not much value in including the filter form in the browsable API. We can simply omit it from the API renderer and avoid what is in many cases a large amount of overhead and delay.
adam added the type: bug label 2025-12-29 16:32:19 +01:00
adam closed this issue 2025-12-29 16:32:19 +01:00
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 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#1466
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?