Swagger/OpenAPI mismatch with returned data for cable terminations. #3818

Closed
opened 2025-12-29 18:31:21 +01:00 by adam · 2 comments
Owner

Originally created by @clienthax on GitHub (Jun 30, 2020).

Environment

  • Python version: netbox-docker
  • NetBox version: 2.8.6

Steps to Reproduce

  1. Generate go-netbox with latest swagger https://github.com/netbox-community/go-netbox
  2. Create 2x device with cable connection between them
  3. Query for data with Dcim.DcimCablesList

Expected Behavior

Swagger to match returned data.

Observed Behavior

json: cannot unmarshal number into Go struct field Cable.results.termination_a of type string

WritableCable/cable refers to them as an object of type string, instead of the correct type

        "termination_a": {
          "title": "Termination a",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "readOnly": true
        },

Returned data (sanitized)

      "termination_a": {
        "id": 3505,
        "url": "http://XXXXXXXXXXXXXXXXXX/api/dcim/interfaces/3505/",
        "device": {
          "id": 60,
          "url": "http://XXXXXXXXXXXXXXXXXX/api/dcim/devices/60/",
          "name": "XXXXXXXXXXXXXXXXXX",
          "display_name": "XXXXXXXXXXXXXXXXXX"
        },
        "name": "XXXXXXXXXXXXXXXXXX",
        "cable": 98,
        "connection_status": {
          "value": true,
          "label": "Connected"
        }
      },
Originally created by @clienthax on GitHub (Jun 30, 2020). <!-- NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED. 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, and that any plugins have been disabled. --> ### Environment * Python version: netbox-docker * NetBox version: 2.8.6 <!-- Describe in detail the exact steps that someone else can take to reproduce this bug using the current stable release of NetBox. Begin with the creation of any necessary database objects and call out every operation being performed explicitly. If reporting a bug in the REST API, be sure to reconstruct the raw HTTP request(s) being made: Don't rely on a client library such as pynetbox. --> ### Steps to Reproduce 1. Generate go-netbox with latest swagger https://github.com/netbox-community/go-netbox 2. Create 2x device with cable connection between them 3. Query for data with Dcim.DcimCablesList <!-- What did you expect to happen? --> ### Expected Behavior Swagger to match returned data. <!-- What happened instead? --> ### Observed Behavior json: cannot unmarshal number into Go struct field Cable.results.termination_a of type string WritableCable/cable refers to them as an object of type string, instead of the correct type ``` "termination_a": { "title": "Termination a", "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, ``` Returned data (sanitized) ``` "termination_a": { "id": 3505, "url": "http://XXXXXXXXXXXXXXXXXX/api/dcim/interfaces/3505/", "device": { "id": 60, "url": "http://XXXXXXXXXXXXXXXXXX/api/dcim/devices/60/", "name": "XXXXXXXXXXXXXXXXXX", "display_name": "XXXXXXXXXXXXXXXXXX" }, "name": "XXXXXXXXXXXXXXXXXX", "cable": 98, "connection_status": { "value": true, "label": "Connected" } }, ```
adam added the type: bugstatus: needs ownerpending closure labels 2025-12-29 18:31:21 +01:00
adam closed this issue 2025-12-29 18:31:21 +01:00
Author
Owner

@stale[bot] commented on GitHub (Jul 15, 2020):

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. Please see our contributing guide.

@stale[bot] commented on GitHub (Jul 15, 2020): 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. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
Author
Owner

@stale[bot] commented on GitHub (Jul 22, 2020):

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.

@stale[bot] commented on GitHub (Jul 22, 2020): 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.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#3818