Swagger-UI generates wrong URL's when BASE_PATH is used #421

New Issue

MrUnknownDE · 2026-04-05T16:31:34+02:00

MrUnknownDE commented

2026-04-05 16:31:34 +02:00

Originally created by @dxks on 2/4/2026

NetBox Edition

NetBox Community

NetBox Version

v4.5.1

Python Version

3.12

Steps to Reproduce

When running multiple NetBox-Versions (for testing) under the same host the BASE_PATH (actually the version) is used to distinguish.

In the environment the BASE_PATH is set to "/v4.4.7" and within the Docker-Container it is inserted into the config via the extra.py as the netbox-docker container no longer supports BASE_PATH

The Swagger-UI uses a schema with absolute paths:

{
    "openapi": "3.0.3",
    "info": {
        "title": "NetBox REST API",
        "version": "4.4.7-Docker-3.4.2 (4.4)",
        "license": {
            "name": "Apache v2 License"
        }
    },
    "paths": {
        "/v4.4.7/api/circuits/circuit-group-assignments/": {
            "get": {
                "operationId": "circuits_circuit_group_assignments_list",
...

The Swagger UI will be configured in settings.py with the relative BASE_PATH as the / is stripped of earlier:

SPECTACULAR_SETTINGS = {
    'TITLE': 'NetBox REST API',
    'LICENSE': {'name': 'Apache v2 License'},
    'VERSION': RELEASE.full_version,
    'COMPONENT_SPLIT_REQUEST': True,
    'REDOC_DIST': 'SIDECAR',
    'SERVERS': [{
        'url': BASE_PATH, <<<< this is now "v4.4.7/"
        'description': 'NetBox',
    }],
    'SWAGGER_UI_DIST': 'SIDECAR',
    'SWAGGER_UI_FAVICON_HREF': 'SIDECAR',
    'POSTPROCESSING_HOOKS': [],
}

Expected Behavior

The Swagger UI should render the URL correctly

curl -X 'GET' \
  'https://netbox.server.com/v4.4.7/api/circuits/circuit-group-assignments/' \
  -H 'accept: application/json'

This requires either:

remove the BASE_PATH in the Schema and use f"/{BASE_PATH}" as Server-Value in the Swagger-Config (like it's done at other locations, or
leave the Server Config empty

Observed Behavior

As the BASE_PATH is at this time v4.4.7/ the generated URL in the Try Out will end up in

current URL of Swagger + relative BASE_PATH + absolute API-Endpoint

curl -X 'GET' \
  'https://netbox.server.com/v4.4.7/api/schema/v4.4.7/v4.4.7/api/circuits/circuit-group-assignments/' \
  -H 'accept: application/json'

*Originally created by @dxks on 2/4/2026* ### NetBox Edition NetBox Community ### NetBox Version v4.5.1 ### Python Version 3.12 ### Steps to Reproduce When running multiple NetBox-Versions (for testing) under the same host the BASE_PATH (actually the version) is used to distinguish. In the environment the BASE_PATH is set to "/v4.4.7" and within the Docker-Container it is inserted into the config via the extra.py as the netbox-docker container no longer supports BASE_PATH The Swagger-UI uses a schema with absolute paths: ```json { "openapi": "3.0.3", "info": { "title": "NetBox REST API", "version": "4.4.7-Docker-3.4.2 (4.4)", "license": { "name": "Apache v2 License" } }, "paths": { "/v4.4.7/api/circuits/circuit-group-assignments/": { "get": { "operationId": "circuits_circuit_group_assignments_list", ... ``` The Swagger UI will be configured in settings.py with the relative BASE_PATH as the / is stripped of earlier: ```python SPECTACULAR_SETTINGS = { 'TITLE': 'NetBox REST API', 'LICENSE': {'name': 'Apache v2 License'}, 'VERSION': RELEASE.full_version, 'COMPONENT_SPLIT_REQUEST': True, 'REDOC_DIST': 'SIDECAR', 'SERVERS': [{ 'url': BASE_PATH, <<<< this is now "v4.4.7/" 'description': 'NetBox', }], 'SWAGGER_UI_DIST': 'SIDECAR', 'SWAGGER_UI_FAVICON_HREF': 'SIDECAR', 'POSTPROCESSING_HOOKS': [], } ``` ### Expected Behavior The Swagger UI should render the URL correctly ```shell curl -X 'GET' \ 'https://netbox.server.com/v4.4.7/api/circuits/circuit-group-assignments/' \ -H 'accept: application/json' ``` This requires either: - remove the BASE_PATH in the Schema and use f"/{BASE_PATH}" as Server-Value in the Swagger-Config (like it's done at other locations, or - leave the Server Config empty ### Observed Behavior As the BASE_PATH is at this time v4.4.7/ the generated URL in the Try Out will end up in current URL of Swagger + relative BASE_PATH + absolute API-Endpoint ```shell curl -X 'GET' \ 'https://netbox.server.com/v4.4.7/api/schema/v4.4.7/v4.4.7/api/circuits/circuit-group-assignments/' \ -H 'accept: application/json' ```

MrUnknownDE closed this issue

2026-04-05 16:31:34 +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 severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low severity: low status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#421