API serializer foreign count fields do not have a default value #4353

New Issue

adam · 2025-12-29T18:35:06+01:00

adam commented

2025-12-29 18:35:06 +01:00

Originally created by @markkuleinio on GitHub (Dec 13, 2020).

Originally assigned to: @DanSheps on GitHub.

Environment

Python version: 3.7.3
NetBox version: 2.9.11

Steps to Reproduce

Create a new tag with any name, like "Testing"
Get the same tag via API and see tagged_items field

Expected Behavior

tagged_items is 0 (API docs say the field is integer)

Observed Behavior

tagged_items is null

$ curl -s -X GET "http://netbox-test.example.net/api/extras/tags/?name=Testing" -H "Authorization: token xxx" | jq .
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 4,
      "url": "http://netbox-test.example.net/api/extras/tags/4/",
      "name": "Testing",
      "slug": "testing",
      "color": "9e9e9e",
      "description": "",
      "tagged_items": null
    }
  ]
}

Originally created by @markkuleinio on GitHub (Dec 13, 2020). Originally assigned to: @DanSheps on GitHub. ### Environment * Python version: 3.7.3 * NetBox version: 2.9.11 ### Steps to Reproduce 1. Create a new tag with any name, like "Testing" 2. Get the same tag via API and see `tagged_items` field  ### Expected Behavior `tagged_items` is 0 (API docs say the field is `integer`)  ### Observed Behavior `tagged_items` is `null` ``` $ curl -s -X GET "http://netbox-test.example.net/api/extras/tags/?name=Testing" -H "Authorization: token xxx" | jq . { "count": 1, "next": null, "previous": null, "results": [ { "id": 4, "url": "http://netbox-test.example.net/api/extras/tags/4/", "name": "Testing", "slug": "testing", "color": "9e9e9e", "description": "", "tagged_items": null } ] } ```

adam added the type: bug status: accepted labels 2025-12-29 18:35:06 +01:00

adam closed this issue

2025-12-29 18:35:07 +01:00

adam commented

2025-12-29 18:35:07 +01:00

@jeremystretch commented on GitHub (Dec 14, 2020):

This happens in other areas, as well, when there are no related objects. Need to force null to zero somehow.

@jeremystretch commented on GitHub (Dec 14, 2020): This happens in other areas, as well, when there are no related objects. Need to force `null` to zero somehow.

adam commented

2025-12-29 18:35:07 +01:00

@DanSheps commented on GitHub (Dec 14, 2020):

Looks like we can do a default=0 in the serializer. This could be breaking though, perhaps we want to wait for 2.11?

@DanSheps commented on GitHub (Dec 14, 2020): Looks like we can do a default=0 in the serializer. This could be breaking though, perhaps we want to wait for 2.11?

adam commented

2025-12-29 18:35:08 +01:00

@jeremystretch commented on GitHub (Dec 14, 2020):

I'd argue that it's really fixing a bug rather than changing previously-desired behavior, so I think it's okay to change now.

@jeremystretch commented on GitHub (Dec 14, 2020): I'd argue that it's really fixing a bug rather than changing previously-desired behavior, so I think it's okay to change now.

adam commented

2025-12-29 18:35:08 +01:00

@DanSheps commented on GitHub (Dec 15, 2020):

I am going to change all instances of *_count = serializer.IntegerField and count_* = serializer.IntegerField to have default=0 in addition to this tagged_items field.

@DanSheps commented on GitHub (Dec 15, 2020): I am going to change all instances of `*_count = serializer.IntegerField` and `count_* = serializer.IntegerField` to have default=0 in addition to this tagged_items field.

adam referenced this issue

2025-12-29 22:23:49 +01:00

[PR #4353] [MERGED] Closes #3939: Nested tenant groups #12822

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#4353