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

IP Prefix Family returned doesn't match swagger definition #3403

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

Originally created by @z4ce on GitHub (Feb 25, 2020).

Environment

  • Python version: 3.7.6
  • NetBox version: v2.7.7

Swagger definition for Prefix.Family does not match the swagger definition.

Steps to Reproduce

  1. Get a prefix object wget http://netbox/api/ipam/prefixes/210/
  2. Notice object is like
  "family": {
    "value": 4,
    "label": "IPv4"
  },
  1. Notice definition is
  "family": {
    "label": "string",
    "value": "string"
  },

Expected Behavior

Object returned matches definition. I'm not sure if the definition needs to be fixed or the returned value type needs to be changed.

Observed Behavior

Object doesn't match definition

Originally created by @z4ce on GitHub (Feb 25, 2020). ### Environment * Python version: 3.7.6 * NetBox version: v2.7.7 Swagger definition for Prefix.Family does not match the swagger definition. ### Steps to Reproduce 1. Get a prefix object `wget http://netbox/api/ipam/prefixes/210/` 2. Notice object is like ``` "family": { "value": 4, "label": "IPv4" }, ``` 3. Notice definition is ``` "family": { "label": "string", "value": "string" }, ``` <!-- What did you expect to happen? --> ### Expected Behavior Object returned matches definition. I'm not sure if the definition needs to be fixed or the returned value type needs to be changed. <!-- What happened instead? --> ### Observed Behavior Object doesn't match definition
adam added the status: acceptedtype: documentation labels 2025-12-29 18:28:47 +01:00
adam closed this issue 2025-12-29 18:28:47 +01:00
adam commented 2025-12-29 18:28:47 +01:00
Author
Owner
Copy Link

@z4ce commented on GitHub (Feb 25, 2020):

cc @wbean1

@z4ce commented on GitHub (Feb 25, 2020): cc @wbean1
adam commented 2025-12-29 18:28:48 +01:00
Author
Owner
Copy Link

@tyler-8 commented on GitHub (Feb 25, 2020):

What specifically are you calling out here? The ordering of the fields or the data type returned for the value key?

@tyler-8 commented on GitHub (Feb 25, 2020): What specifically are you calling out here? The ordering of the fields or the data type returned for the `value` key?
adam commented 2025-12-29 18:28:48 +01:00
Author
Owner
Copy Link

@z4ce commented on GitHub (Feb 25, 2020):

value is returned as an integer and not a string as the swagger definition calls out. According the swagger the prefix family should be:

"family": {
    "value": "4",
    "label": "IPv4"
  },

Or if the returned type is correct then the swagger should be:

  "family": {
    "label": "string",
    "value": "integer"
  },
@z4ce commented on GitHub (Feb 25, 2020): `value` is returned as an integer and not a string as the swagger definition calls out. According the swagger the prefix family should be: ``` "family": { "value": "4", "label": "IPv4" }, ``` Or if the returned type is correct then the swagger should be: ``` "family": { "label": "string", "value": "integer" }, ```
adam commented 2025-12-29 18:28:48 +01:00
Author
Owner
Copy Link

@kobayashi commented on GitHub (Mar 2, 2020):

ChoiceField which contains int values like IPAddressFamilyChoices and RackWidthChoices has the same issue.

@kobayashi commented on GitHub (Mar 2, 2020): ChoiceField which contains `int` values like `IPAddressFamilyChoices` and `RackWidthChoices` has the same issue.
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: documentation
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#3403
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?