Generating OpenAPI schema generates numerous warnings #428

New Issue

MrUnknownDE · 2026-04-05T16:32:01+02:00

MrUnknownDE commented

2026-04-05 16:32:01 +02:00

Originally created by @jeremystretch on 2/2/2026

Proposed Changes

Resolve the warnings raised when generating the OpenAPI schema (./manage.py spectacular --format openapi-json > ../contrib/openapi.json).

Schema generation summary:
Warnings: 1280 (1280 unique)
Errors:   0 (0 unique)

These all appear to follow the pattern below:

netbox/netbox/circuits/filtersets.py:378: Warning [CircuitGroupAssignmentViewSet > CircuitGroupAssignmentFilterSet]: Unable to guess choice types from values, filter method's type hint or find "tag" in model. Defaulting to string.

Justification

The warnings may indicate a problem with the resulting OpenAPI schema (and they're noisy).

*Originally created by @jeremystretch on 2/2/2026* ### Proposed Changes Resolve the warnings raised when generating the OpenAPI schema (`./manage.py spectacular --format openapi-json > ../contrib/openapi.json`). ``` Schema generation summary: Warnings: 1280 (1280 unique) Errors: 0 (0 unique) ``` These all appear to follow the pattern below: `netbox/netbox/circuits/filtersets.py:378: Warning [CircuitGroupAssignmentViewSet > CircuitGroupAssignmentFilterSet]: Unable to guess choice types from values, filter method's type hint or find "tag" in model. Defaulting to string.` ### Justification The warnings may indicate a problem with the resulting OpenAPI schema (and they're noisy).

MrUnknownDE closed this issue

2026-04-05 16:32:01 +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 netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping type: housekeeping

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#428