mirror of
https://github.com/netbox-community/netbox.git
synced 2026-01-11 21:10:29 +01:00
API error using a custom field with an object value #9324
Closed
opened 2025-12-29 20:48:26 +01:00 by adam
·
11 comments
No Branch/Tag Specified
main
update-changelog-comments-docs
feature-removal-issue-type
20911-dropdown
20239-plugin-menu-classes-mutable-state
21097-graphql-id-lookups
feature
fix_module_substitution
20923-dcim-templates
20044-elevation-stuck-lightmode
feature-ip-prefix-link
v4.5-beta1-release
20068-import-moduletype-attrs
20766-fix-german-translation-code-literals
20378-del-script
7604-filter-modifiers-v3
circuit-swap
12318-case-insensitive-uniqueness
20637-improve-device-q-filter
20660-script-load
19724-graphql
20614-update-ruff
14884-script
02496-max-page
19720-macaddress-interface-generic-relation
19408-circuit-terminations-export-templates
20203-openapi-check
fix-19669-api-image-download
7604-filter-modifiers
19275-fixes-interface-bulk-edit
fix-17794-get_field_value_return_list
11507-show-aggregate-and-rir-on-api
9583-add_column_specific_search_field_to_tables
v4.5.0
v4.4.10
v4.4.9
v4.5.0-beta1
v4.4.8
v4.4.7
v4.4.6
v4.4.5
v4.4.4
v4.4.3
v4.4.2
v4.4.1
v4.4.0
v4.3.7
v4.4.0-beta1
v4.3.6
v4.3.5
v4.3.4
v4.3.3
v4.3.2
v4.3.1
v4.3.0
v4.2.9
v4.3.0-beta2
v4.2.8
v4.3.0-beta1
v4.2.7
v4.2.6
v4.2.5
v4.2.4
v4.2.3
v4.2.2
v4.2.1
v4.2.0
v4.1.11
v4.1.10
v4.1.9
v4.1.8
v4.2-beta1
v4.1.7
v4.1.6
v4.1.5
v4.1.4
v4.1.3
v4.1.2
v4.1.1
v4.1.0
v4.0.11
v4.0.10
v4.0.9
v4.1-beta1
v4.0.8
v4.0.7
v4.0.6
v4.0.5
v4.0.3
v4.0.2
v4.0.1
v4.0.0
v3.7.8
v3.7.7
v4.0-beta2
v3.7.6
v3.7.5
v4.0-beta1
v3.7.4
v3.7.3
v3.7.2
v3.7.1
v3.7.0
v3.6.9
v3.6.8
v3.6.7
v3.7-beta1
v3.6.6
v3.6.5
v3.6.4
v3.6.3
v3.6.2
v3.6.1
v3.6.0
v3.5.9
v3.6-beta2
v3.5.8
v3.6-beta1
v3.5.7
v3.5.6
v3.5.5
v3.5.4
v3.5.3
v3.5.2
v3.5.1
v3.5.0
v3.4.10
v3.4.9
v3.5-beta2
v3.4.8
v3.5-beta1
v3.4.7
v3.4.6
v3.4.5
v3.4.4
v3.4.3
v3.4.2
v3.4.1
v3.4.0
v3.3.10
v3.3.9
v3.4-beta1
v3.3.8
v3.3.7
v3.3.6
v3.3.5
v3.3.4
v3.3.3
v3.3.2
v3.3.1
v3.3.0
v3.2.9
v3.2.8
v3.3-beta2
v3.2.7
v3.3-beta1
v3.2.6
v3.2.5
v3.2.4
v3.2.3
v3.2.2
v3.2.1
v3.2.0
v3.1.11
v3.1.10
v3.2-beta2
v3.1.9
v3.2-beta1
v3.1.8
v3.1.7
v3.1.6
v3.1.5
v3.1.4
v3.1.3
v3.1.2
v3.1.1
v3.1.0
v3.0.12
v3.0.11
v3.0.10
v3.1-beta1
v3.0.9
v3.0.8
v3.0.7
v3.0.6
v3.0.5
v3.0.4
v3.0.3
v3.0.2
v3.0.1
v3.0.0
v2.11.12
v3.0-beta2
v2.11.11
v2.11.10
v3.0-beta1
v2.11.9
v2.11.8
v2.11.7
v2.11.6
v2.11.5
v2.11.4
v2.11.3
v2.11.2
v2.11.1
v2.11.0
v2.10.10
v2.10.9
v2.11-beta1
v2.10.8
v2.10.7
v2.10.6
v2.10.5
v2.10.4
v2.10.3
v2.10.2
v2.10.1
v2.10.0
v2.9.11
v2.10-beta2
v2.9.10
v2.10-beta1
v2.9.9
v2.9.8
v2.9.7
v2.9.6
v2.9.5
v2.9.4
v2.9.3
v2.9.2
v2.9.1
v2.9.0
v2.9-beta2
v2.8.9
v2.9-beta1
v2.8.8
v2.8.7
v2.8.6
v2.8.5
v2.8.4
v2.8.3
v2.8.2
v2.8.1
v2.8.0
v2.7.12
v2.7.11
v2.7.10
v2.7.9
v2.7.8
v2.7.7
v2.7.6
v2.7.5
v2.7.4
v2.7.3
v2.7.2
v2.7.1
v2.7.0
v2.6.12
v2.6.11
v2.6.10
v2.6.9
v2.7-beta1
Solcon-2020-01-06
v2.6.8
v2.6.7
v2.6.6
v2.6.5
v2.6.4
v2.6.3
v2.6.2
v2.6.1
v2.6.0
v2.5.13
v2.5.12
v2.6-beta1
v2.5.11
v2.5.10
v2.5.9
v2.5.8
v2.5.7
v2.5.6
v2.5.5
v2.5.4
v2.5.3
v2.5.2
v2.5.1
v2.5.0
v2.4.9
v2.5-beta2
v2.4.8
v2.5-beta1
v2.4.7
v2.4.6
v2.4.5
v2.4.4
v2.4.3
v2.4.2
v2.4.1
v2.4.0
v2.3.7
v2.4-beta1
v2.3.6
v2.3.5
v2.3.4
v2.3.3
v2.3.2
v2.3.1
v2.3.0
v2.2.10
v2.3-beta2
v2.2.9
v2.3-beta1
v2.2.8
v2.2.7
v2.2.6
v2.2.5
v2.2.4
v2.2.3
v2.2.2
v2.2.1
v2.2.0
v2.1.6
v2.2-beta2
v2.1.5
v2.2-beta1
v2.1.4
v2.1.3
v2.1.2
v2.1.1
v2.1.0
v2.0.10
v2.1-beta1
v2.0.9
v2.0.8
v2.0.7
v2.0.6
v2.0.5
v2.0.4
v2.0.3
v2.0.2
v2.0.1
v2.0.0
v2.0-beta3
v1.9.6
v1.9.5
v2.0-beta2
v1.9.4-r1
v1.9.3
v2.0-beta1
v1.9.2
v1.9.1
v1.9.0-r1
v1.8.4
v1.8.3
v1.8.2
v1.8.1
v1.8.0
v1.7.3
v1.7.2-r1
v1.7.1
v1.7.0
v1.6.3
v1.6.2-r1
v1.6.1-r1
1.6.1
v1.6.0
v1.5.2
v1.5.1
v1.5.0
v1.4.2
v1.4.1
v1.4.0
v1.3.2
v1.3.1
v1.3.0
v1.2.2
v1.2.1
v1.2.0
v1.1.0
v1.0.7-r1
v1.0.7
v1.0.6
v1.0.5
v1.0.4
v1.0.3-r1
v1.0.3
1.0.0
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
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
Mirrored from GitHub Pull Request
No Label
type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: starred/netbox#9324
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
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?
Originally created by @peteeckel on GitHub (Mar 5, 2024).
Deployment Type
Self-hosted
NetBox Version
v4.0.0-dev
Python Version
3.11
Steps to Reproduce
Unfortunately I didn't have the time to minimise the problem yet, but I can reliably reproduce it with NetBox DNS.
To reproduce it, create a custom field named
ipaddress_dns_zone_idof typenetbox_dns.Zoneforipam.IPAddress.Until
ca56c8b9efcreating or updating objects containing that custom field worked perfectly. Starting from78e284c14fI get an error with a custom field onipam.IPAddressobjects using the API. The following request (with existing IP Address and Zone object IDs) causes an exception:Expected Behavior
The API call succeeds and an IP address is created which is linked to a DNS record.
Observed Behavior
The stack trace is:
The exact same API request on the same database instance succeeds with the previous commit. Currently I don't really have an idea where to start with this. So far I tried the following:
featurebranch: The error persists.nested=True(except two of them that are required to avoid circular references): The error persists. Update: The issue occurs when the non-nested serializer withnested=Trueis usedZoneSerializer: The error persists. Update: It is sufficient to have one field addressing a serializer and referred to in a validator in the modelI'm particularly curious why any piece of code should try to iterate over a model instance, which makes me suspect that there might be an error somewhere causing the wrong object to be passed.
@peteeckel commented on GitHub (Mar 5, 2024):
Sorry, closing this until I can figure out what exactly happens.
@peteeckel commented on GitHub (Mar 5, 2024):
The second closing of this ticket was unintentional, it's late ...
I can narrow it down to
netbox/extras/api/customfields.py. If I checkout that file fromca56c8b9ef, the error goes away.The culprit is in this diff:
So it seems the custom field serialization is working with the old nested serializer, but not with the standard serializer with
nested=True.Sorry again for the close/reopen spam.
@peteeckel commented on GitHub (Mar 6, 2024):
The same action executed in the GUI finishes without any problems, so seems to be purely a REST API issue.
@peteeckel commented on GitHub (Mar 6, 2024):
Another piece of information: The serializer works, both with the old and the new paradigm:
The results are identical in both cases:
@peteeckel commented on GitHub (Mar 6, 2024):
Digging deeper, the difference between the
NestedZoneSerializerand theZoneSerializeris that the latter has a validator attached (inherited from theZonemodel), while the former has none. It is the validator that fails with the exception.I tentatively removed the
unique_togethervalidator from the model, and now the request no longer fails. This is of course not the solution, but it confirms that the difference between the two serializers is in fact the cause of the problem.@peteeckel commented on GitHub (Mar 6, 2024):
The validator itself is not the problem - creating objects works perfectly and the validator returns without raising an exception:
@peteeckel commented on GitHub (Mar 6, 2024):
The exception is raised by the validator because the arguments passed to
__call__are wrong. Normally, the Validator instance is called with two arguments:attrsandserializer.attrsis an OrderedDict containing the data for the object to be validated:But when the validator is called by NetBox in the error situation, an object, in this case a
Zoneobject, is passed forattrs. That causes the exception to be raised as it is not iterable.@peteeckel commented on GitHub (Mar 6, 2024):
I found a workaround for the problem, applied to the
ZoneSerializerclass:This could also be the solution for
NetBoxModelSerializerin general, as it emulates the situation withWritableNestedSerializer, which does not have any validators.@jeffgdotorg commented on GitHub (Apr 1, 2024):
Working with your original steps to reproduce on NetBox 4.0.0-dev
9fd23b4and netbox_dns v1.0.0-dev1214c1d, I bumped into a separate problem: NetBox raises aValueErrorwhen I try to create the custom field in the UI.Marking as revisions needed for the time being. I trust you'll get back to it and find steps to reproduce that don't require the installation of a plugin nightly in a NetBox nightly.
Edit: Can't markdown late in the day on <6h sleep.
@peteeckel commented on GitHub (Apr 2, 2024):
Hi @jeffgdotorg, thanks for trying to reproduce it.
I guess your problem is a result of database migration having been run before you switched back to the older NetBox commit SHA, which is often a problem and very definitely so after
c8d9d9358. Never mind, though, tonight, if everything works well, the first beta is due to be released for NetBox 4 and NetBox DNS, and then we'll have a fixed point.The steps to reproduce will be different: NetBox DNS contains a workaround for the problem, and the obvious way to reproduce it is to remove the workarond:
@peteeckel commented on GitHub (Apr 3, 2024):
Hi @jeffgdotorg, good news: At some point in the last month's worth of commits the issue has been resolved :-)
To be precise - @jeremystretch fixed it here:
... which is pretty exactly what I added for a workaround. Everything is OK now!