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

OpenAPI Spec not matching observed behaviour for Interface Model #8631

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

Originally created by @mytlogos on GitHub (Sep 17, 2023).

NetBox version

v.3.6.1

Python version

3.8

Steps to Reproduce

  1. Create wlan
  2. Create device with wlan interface
  3. "Connect" wlan interface to wlan (Select wlan from edit form)
  4. request the interfaces endpoint (all or just one) (curl -v -s -H "Authorization: Token $TOKEN" http://netbox/api/dcim/interfaces/)

Expected Behavior

According to the OpenAPI spec, the Interface Model returns an array of integers.
See https://demo.netbox.dev/api/schema/swagger-ui/#/dcim/dcim_interfaces_list

Observed Behavior

The InterfaceSerializer returns the full objects instead of the expected wlan ids.

This is more useful as an api itself, but openapi generators which consume this api spec (e.g. https://github.com/OpenAPITools/openapi-generator/), generate wrong client implementations leading to unexpected behaviour.

In my case i used openapi generator to generate a golang client for netbox 3.6.1 (the official go-netbox client is still stuck at 3.4: https://github.com/netbox-community/go-netbox/pull/157).
Assigning a wlan to an interface in netbox lead to golang unmarshalling an empty interface struct due to unexpected values in the response (a struct/object instead of integers), where it fails silently for some reason.

Unassigning the wlan from the interface "fixes" this bug.

Originally created by @mytlogos on GitHub (Sep 17, 2023). ### NetBox version v.3.6.1 ### Python version 3.8 ### Steps to Reproduce 1. Create wlan 2. Create device with wlan interface 3. "Connect" wlan interface to wlan (Select wlan from edit form) 4. request the interfaces endpoint (all or just one) (curl -v -s -H "Authorization: Token $TOKEN" http://netbox/api/dcim/interfaces/) ### Expected Behavior According to the OpenAPI spec, the Interface Model returns an array of integers. See https://demo.netbox.dev/api/schema/swagger-ui/#/dcim/dcim_interfaces_list ### Observed Behavior The [InterfaceSerializer](https://github.com/netbox-community/netbox/blob/2dfbd72f10f8bfddbee3c54a275d73c953d0af4b/netbox/dcim/api/serializers.py#L941) returns the full objects instead of the expected wlan ids. This is more useful as an api itself, but openapi generators which consume this api spec (e.g. https://github.com/OpenAPITools/openapi-generator/), generate wrong client implementations leading to unexpected behaviour. In my case i used openapi generator to generate a golang client for netbox 3.6.1 (the official go-netbox client is still stuck at 3.4: https://github.com/netbox-community/go-netbox/pull/157). Assigning a wlan to an interface in netbox lead to golang unmarshalling an empty interface struct due to unexpected values in the response (a struct/object instead of integers), where it fails silently for some reason. Unassigning the wlan from the interface "fixes" this bug.
adam closed this issue 2025-12-29 20:39:06 +01:00
adam commented 2025-12-29 20:39:07 +01:00
Author
Owner
Copy Link

@abhi1693 commented on GitHub (Sep 17, 2023):

I'd say the observed behaviour is the correct one if it returns the list of objects. We should rather fix the openapi specifications

@abhi1693 commented on GitHub (Sep 17, 2023): I'd say the observed behaviour is the correct one if it returns the list of objects. We should rather fix the openapi specifications
adam commented 2025-12-29 20:39:07 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Dec 18, 2023):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Dec 18, 2023): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 20:39:07 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Jan 17, 2024):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@github-actions[bot] commented on GitHub (Jan 17, 2024): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
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 pending closure severity: low status: needs owner topic: OpenAPI 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#8631
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?