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

Choice field is not serialized as string #7852

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

Originally created by @amhn on GitHub (Apr 2, 2023).

Originally assigned to: @arthanson on GitHub.

NetBox version

v3.5-beta

Python version

3.10

Steps to Reproduce

Create Aggregate. Go to API and List Aggregates

Expected Behavior

The family field is a string as specified in openapi spec. Or openapi-spec is changed to specify this field as an object in the response.

Observed Behavior

The family field actually is an object:

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

This violates the definition.

Removing @extend_schema_field(OpenApiTypes.STR) from class ChoiceField produces in this case a more correct API definition:

                    "family": {
                        "type": "object",
                        "properties": {
                            "value": {
                                "type": "string"
                            },
                            "label": {
                                "type": "string"
                            }
                        },
                        "readOnly": true
                    },

instead of

                    "family": {
                        "type": "string",
                        "readOnly": true
                    },
Originally created by @amhn on GitHub (Apr 2, 2023). Originally assigned to: @arthanson on GitHub. ### NetBox version v3.5-beta ### Python version 3.10 ### Steps to Reproduce Create Aggregate. Go to API and List Aggregates ### Expected Behavior The family field is a string as specified in openapi spec. Or openapi-spec is changed to specify this field as an object in the response. ### Observed Behavior The family field actually is an object: ``` "family": { "value": 4, "label": "IPv4" }, ``` This violates the definition. Removing `@extend_schema_field(OpenApiTypes.STR)` from class ChoiceField produces in this case a more correct API definition: ``` "family": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "readOnly": true }, ``` instead of ``` "family": { "type": "string", "readOnly": true }, ```
adam added the type: bugstatus: acceptedbeta labels 2025-12-29 20:29:01 +01:00
adam closed this issue 2025-12-29 20:29:01 +01:00
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 beta 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#7852
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?