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

ConnectedDeviceViewSet API view using incorrect naming convention for query params #2087

New Issue
Closed
opened 2025-12-29 17:22:09 +01:00 by adam · 0 comments
adam commented 2025-12-29 17:22:09 +01:00
Owner
Copy Link

Originally created by @lampwins on GitHub (Nov 6, 2018).

Environment

  • Python version: 3.7
  • NetBox version: 2.4.6

Steps to Reproduce

The API view ConnectedDeviceViewSet was introduced some time ago and requires two query params to function. peer-device and peer-interface. These do not conform to the NetBox naming convention in that they use hyphens instead of underscoresin their names. Not only is this an annoying inconsistency, it is causing an issue in an auto-generated swagger client.

Expected Behavior

All API query params and properties should use underscores in place of hyphens.

Observed Behavior

peer-device and peer-interface currently use hyphens.

Originally created by @lampwins on GitHub (Nov 6, 2018). <!-- NOTE: This form is only for reproducible bugs. If you need assistance with NetBox installation, or if you have a general question, DO NOT open an issue. Instead, post to our mailing list: https://groups.google.com/forum/#!forum/netbox-discuss Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release before submitting a bug report. --> ### Environment * Python version: 3.7 * NetBox version: 2.4.6 <!-- Describe in detail the steps that someone else can take to reproduce this bug using the current stable release of NetBox (or the current beta release where applicable). --> ### Steps to Reproduce The API view `ConnectedDeviceViewSet` was introduced some time ago and requires two query params to function. `peer-device` and `peer-interface`. These do not conform to the NetBox naming convention in that they use hyphens instead of underscoresin their names. Not only is this an annoying inconsistency, it is causing an issue in an auto-generated swagger client. <!-- What did you expect to happen? --> ### Expected Behavior All API query params and properties should use underscores in place of hyphens. <!-- What happened instead? --> ### Observed Behavior `peer-device` and `peer-interface` currently use hyphens.
adam added the type: bugstatus: accepted labels 2025-12-29 17:22:09 +01:00
adam closed this issue 2025-12-29 17:22:09 +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 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#2087
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?