IpamIPAddressFamilyChoice differs from the spec #8083

New Issue

adam · 2025-12-29T20:32:09+01:00

adam commented

2025-12-29 20:32:09 +01:00

Originally created by @hikhvar on GitHub (May 17, 2023).

Originally assigned to: @abhi1693 on GitHub.

NetBox version

v3.5.1

Python version

3.10.6

Steps to Reproduce

Try to fetch an IP address from netbox:

curl -s -X 'GET' -H 'Authorization: Token testtesttesttesttesttesttesttesttesttest' 'http://0.0.0.0:8080/api/ipam/ip-addresses/' | jq '.results[0].family'
{
  "value": 4,
  "label": "IPv4"
}

Download the OpenAPI spec
(e.g. using a local netbox-docker installation)

curl -L http://0.0.0.0:8080/api/schema/ -o openapi.yaml

Compare the OpenAPI spec with the given result:

 bin/yq '.components.schemas.IPAddress.properties.family' openapi.yaml
type: object
properties:
  value:
    type: string
  label:
    type: string
readOnly: true

Expected Behavior

The value of the IPAddressFamily type should be either string or a number in both the Spec and the API response.

Observed Behavior

The API returns a number for the IP family, while the Spec says it is a string. The spec should be consistent with the actual response. Generated client in e.g. Golang don't do an automatic type conversion, but will complain about mismatching types.

Current Workaround

Run the following before generating your code:

bin/yq -i '.components.schemas.IPAddress.properties.family.properties.value.type = "integer" ' openapi.yaml

Originally created by @hikhvar on GitHub (May 17, 2023). Originally assigned to: @abhi1693 on GitHub. ### NetBox version v3.5.1 ### Python version 3.10.6 ### Steps to Reproduce 1. Try to fetch an IP address from netbox: ``` curl -s -X 'GET' -H 'Authorization: Token testtesttesttesttesttesttesttesttesttest' 'http://0.0.0.0:8080/api/ipam/ip-addresses/' | jq '.results[0].family' { "value": 4, "label": "IPv4" } ``` 1. Download the OpenAPI spec (e.g. using a local netbox-docker installation) ``` curl -L http://0.0.0.0:8080/api/schema/ -o openapi.yaml ``` 1. Compare the OpenAPI spec with the given result: ``` bin/yq '.components.schemas.IPAddress.properties.family' openapi.yaml type: object properties: value: type: string label: type: string readOnly: true ``` ### Expected Behavior The value of the IPAddressFamily type should be either string or a number in both the Spec and the API response. ### Observed Behavior The API returns a number for the IP family, while the Spec says it is a string. The spec should be consistent with the actual response. Generated client in e.g. Golang don't do an automatic type conversion, but will complain about mismatching types. #### Current Workaround Run the following before generating your code: ``` bin/yq -i '.components.schemas.IPAddress.properties.family.properties.value.type = "integer" ' openapi.yaml ```

adam added the type: bug status: accepted severity: low topic: OpenAPI labels 2025-12-29 20:32:09 +01:00

adam closed this issue

2025-12-29 20:32:09 +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#8083