Fixes #21533: Fix missing family/mask_length in API when creating IP-related objects #259

New Issue

MrUnknownDE · 2026-04-05T16:23:50+02:00

MrUnknownDE commented

2026-04-05 16:23:50 +02:00

Originally created by @chbndrhnns on 3/2/2026

Fixes: #21533

This PR addresses an issue where read-only calculated fields (like family and mask_length) are silently omitted from API responses when creating IP-related objects (Prefix, IPAddress, Aggregate, IPRange).

Problem

During DRF's model instantiation and validation lifecycle, IP network fields are temporarily held as strings rather than netaddr objects. When the serializer attempts to build the response representation, evaluating properties like family raises an AttributeError (e.g., 'str' object has no attribute 'version'). DRF's Field.get_attribute() catches this exception for read-only fields and silently ignores it by raising a SkipField exception, dropping the key from the API response.

Solution

Modified the family and mask_length properties on IP-related models to detect if the underlying value is a string and cast it to a netaddr object before evaluating.
This ensures these properties can be safely evaluated at any point in the object's lifecycle, including during API validation and serialization.
Added unit tests in ipam.tests.test_models to explicitly verify that the models correctly parse the IP version and mask length when instantiated with raw string inputs.

*Originally created by @chbndrhnns on 3/2/2026* ### Fixes: #21533 This PR addresses an issue where read-only calculated fields (like `family` and `mask_length`) are silently omitted from API responses when creating IP-related objects (`Prefix`, `IPAddress`, `Aggregate`, `IPRange`). ### Problem During DRF's model instantiation and validation lifecycle, IP network fields are temporarily held as strings rather than `netaddr` objects. When the serializer attempts to build the response representation, evaluating properties like `family` raises an `AttributeError` (e.g., `'str' object has no attribute 'version'`). DRF's `Field.get_attribute()` catches this exception for read-only fields and silently ignores it by raising a `SkipField` exception, dropping the key from the API response. ### Solution - Modified the `family` and `mask_length` properties on IP-related models to detect if the underlying value is a string and cast it to a `netaddr` object before evaluating. - This ensures these properties can be safely evaluated at any point in the object's lifecycle, including during API validation and serialization. - Added unit tests in `ipam.tests.test_models` to explicitly verify that the models correctly parse the IP version and mask length when instantiated with raw string inputs.

MrUnknownDE closed this issue

2026-04-05 16:23:50 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

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

No Label

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#259

Fixes #21533: Fix missing family/mask_length in API when creating IP-related objects #259

Fixes: #21533

Problem

Solution

Fixes #21533: Fix missing `family`/`mask_length` in API when creating IP-related objects #259