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

REST API docs: vid_ranges POST example for VLANGroup is triple‑nested ([[[lo, hi]]]) instead of [[lo, hi]] #11683

New Issue
Closed
opened 2025-12-29 21:48:36 +01:00 by adam · 2 comments
adam commented 2025-12-29 21:48:36 +01:00
Owner
Copy Link

Originally created by @pheus on GitHub (Oct 3, 2025).

Originally assigned to: @pheus on GitHub.

NetBox Edition

NetBox Community

NetBox Version

v4.4.2

Python Version

3.12

Steps to Reproduce

  1. Open /api/schema/swagger-ui/.
  2. Go to IPAM → VLAN groups → POST /api/ipam/vlan-groups/.
  3. Inspect the request body “Example Value”.

Expected Behavior

vid_ranges should be a list of two‑integer ranges:

"vid_ranges": [[10, 20]]

Observed Behavior

vid_ranges is shown with an extra nesting level:

"vid_ranges": [[[0, 0]]]

Additional Information

The OpenAPI serializer extension for IntegerRangeSerializer returns an array of arrays for a single range; with many=True on vid_ranges, drf‑spectacular wraps it again, causing triple nesting.

Proposed Fix (schema extension)

# netbox/core/api/schema.py
class FixIntegerRangeSerializerSchema(OpenApiSerializerExtension):
    target_class = 'netbox.api.fields.IntegerRangeSerializer'

    def map_serializer(self, auto_schema, direction):
        # One range = two integers; many=True will wrap this in an outer array
        return {
            "type": "array",
            "items": {"type": "integer"},
            "minItems": 2,
            "maxItems": 2,
        }
Originally created by @pheus on GitHub (Oct 3, 2025). Originally assigned to: @pheus on GitHub. ### NetBox Edition NetBox Community ### NetBox Version v4.4.2 ### Python Version 3.12 ### Steps to Reproduce 1. Open `/api/schema/swagger-ui/`. 2. Go to **IPAM → VLAN groups → POST /api/ipam/vlan-groups/**. 3. Inspect the request body “Example Value”. ### Expected Behavior `vid_ranges` should be a list of two‑integer ranges: ```json "vid_ranges": [[10, 20]] ``` ### Observed Behavior `vid_ranges` is shown with an extra nesting level: ```json "vid_ranges": [[[0, 0]]] ``` ### Additional Information The OpenAPI serializer extension for `IntegerRangeSerializer` returns an **array of arrays** for a single range; with `many=True` on `vid_ranges`, drf‑spectacular wraps it again, causing triple nesting. ### Proposed Fix (schema extension) ```python # netbox/core/api/schema.py class FixIntegerRangeSerializerSchema(OpenApiSerializerExtension): target_class = 'netbox.api.fields.IntegerRangeSerializer' def map_serializer(self, auto_schema, direction): # One range = two integers; many=True will wrap this in an outer array return { "type": "array", "items": {"type": "integer"}, "minItems": 2, "maxItems": 2, } ```
adam added the type: bugstatus: acceptedseverity: low labels 2025-12-29 21:48:36 +01:00
adam closed this issue 2025-12-29 21:48:36 +01:00
adam commented 2025-12-29 21:48:37 +01:00
Author
Owner
Copy Link

@pheus commented on GitHub (Oct 3, 2025):

I’ve identified a root cause and I’m happy to open a PR if this report is accepted.

@pheus commented on GitHub (Oct 3, 2025): I’ve identified a root cause and I’m happy to open a PR if this report is accepted.
adam commented 2025-12-29 21:48:37 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Oct 3, 2025):

I'll assign to you @pheus thanks!

@arthanson commented on GitHub (Oct 3, 2025): I'll assign to you @pheus thanks!
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 severity: low 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#11683
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?