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

Bad swagger documentation using Nested Serializers #3782

New Issue
Closed
opened 2025-12-29 18:31:12 +01:00 by adam · 1 comment
adam commented 2025-12-29 18:31:12 +01:00
Owner
Copy Link

Originally created by @Dimaqa on GitHub (Jun 15, 2020).

Environment

Python version: 3.6.9
NetBox version: 2.8.5

Bad swagger documentation for Nested Serializers with many=True parameter

Steps to Reproduce

With introductions of plugins we can now create our own models with netbox serializers.
So if you have field like
ips_list = NestedIPAddressSerializer(required=False, many=True)
Swagger post documentation would be wrong
And it includes every nested serializer.

Expected Behavior

 "ips_list": [ 0
  ],

Observed Behavior

 "ips_list": [
    {
      "address": "string"
    }
  ],

But post request himself works as expected with "ips_list": [ 1 ], it's just swagger issue

Originally created by @Dimaqa on GitHub (Jun 15, 2020). ### Environment Python version: 3.6.9 NetBox version: 2.8.5 Bad swagger documentation for Nested Serializers with many=True parameter ### Steps to Reproduce With introductions of plugins we can now create our own models with netbox serializers. So if you have field like `ips_list = NestedIPAddressSerializer(required=False, many=True)` Swagger post documentation would be wrong And it includes every nested serializer. ### Expected Behavior ``` "ips_list": [ 0 ], ``` ### Observed Behavior ``` "ips_list": [ { "address": "string" } ], ``` But post request himself works as expected with "ips_list": [ 1 ], it's just swagger issue
adam closed this issue 2025-12-29 18:31:12 +01:00
adam commented 2025-12-29 18:31:12 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 15, 2020):

Core serializers are not intended to be used by plugins. Plugin authors are responsible for their own endpoints and the documentation thereof.

@jeremystretch commented on GitHub (Jun 15, 2020): Core serializers are not intended to be used by plugins. Plugin authors are responsible for their own endpoints and the documentation thereof.
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
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#3782
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?