[PR #16627] [MERGED] Fixes #16624: Set allow_null=True on method fields that can return None #14868

New Issue

adam · 2025-12-29T23:27:11+01:00

adam commented

2025-12-29 23:27:11 +01:00

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/16627
Author: @fabi125
Created: 6/17/2024
Status: ✅ Merged
Merged: 7/12/2024
Merged by: @jeremystretch

Base: develop ← Head: nb16624

📝 Commits (1)

4e297ac Fixes #16624: Set allow_null=True on method fields that can return None

📊 Changes

4 files changed (+5 additions, -5 deletions)

View changed files

📝 netbox/dcim/api/serializers_/base.py (+2 -2)
📝 netbox/dcim/api/serializers_/cables.py (+1 -1)
📝 netbox/dcim/api/serializers_/devices.py (+1 -1)
📝 netbox/extras/api/serializers_/scripts.py (+1 -1)

📄 Description

Fixes: #16624

Noticed that Device.parent_device was not marked as nullable in the swagger api docs. Went through all uses of SerializerMethodField and added allow_null=True if the method could return None.

I opted to add it to the @extend_schema_field decorator where possible because that's how allow_null was set on other methods that could return None.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/16627 **Author:** [@fabi125](https://github.com/fabi125) **Created:** 6/17/2024 **Status:** ✅ Merged **Merged:** 7/12/2024 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `develop` ← **Head:** `nb16624` --- ### 📝 Commits (1) - [`4e297ac`](https://github.com/netbox-community/netbox/commit/4e297ac8dcbd518e9c40520bb8ac1beed5e11bbb) Fixes #16624: Set allow_null=True on method fields that can return None ### 📊 Changes **4 files changed** (+5 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `netbox/dcim/api/serializers_/base.py` (+2 -2) 📝 `netbox/dcim/api/serializers_/cables.py` (+1 -1) 📝 `netbox/dcim/api/serializers_/devices.py` (+1 -1) 📝 `netbox/extras/api/serializers_/scripts.py` (+1 -1) </details> ### 📄 Description ### Fixes: #16624 Noticed that Device.parent_device was not marked as nullable in the swagger api docs. Went through all uses of `SerializerMethodField` and added `allow_null=True` if the method could return `None`. I opted to add it to the `@extend_schema_field` decorator where possible because that's how `allow_null` was set on other methods that could return `None`. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

adam added the pull-request label 2025-12-29 23:27:11 +01:00

adam closed this issue

2025-12-29 23:27:11 +01:00

Sign in to join this conversation.

Branches Tags

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

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#14868