Fixes #21354: Fix Swagger-UI generating wrong URLs when BASE_PATH is set #389

New Issue

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

MrUnknownDE commented

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

Originally created by @adionit7 on 2/10/2026

Fixes

Closes #21354

Summary

When BASE_PATH is configured (e.g., v4.4.7), Swagger-UI generates incorrect request URLs with the base path duplicated multiple times:

https://netbox.server.com/v4.4.7/api/schema/v4.4.7/v4.4.7/api/circuits/...

Root cause: The SPECTACULAR_SETTINGS['SERVERS'] url was set to BASE_PATH (e.g., v4.4.7/). However, drf-spectacular already includes the BASE_PATH prefix in the schema paths since all URL patterns are wrapped under path(settings.BASE_PATH, include(_patterns)). Swagger-UI resolves the relative server URL against the document URL and then appends the path, causing the prefix to appear multiple times.

Fix: Replace 'url': BASE_PATH with 'url': '' in the SERVERS configuration. An empty string causes Swagger-UI to resolve paths relative to the current document, and since the schema paths are already absolute (e.g., /v4.4.7/api/circuits/...), they resolve correctly to the server root.

This is a no-op for the default case (no BASE_PATH), since BASE_PATH already evaluates to '' when unset.

*Originally created by @adionit7 on 2/10/2026* ## Fixes Closes #21354 ## Summary When `BASE_PATH` is configured (e.g., `v4.4.7`), Swagger-UI generates incorrect request URLs with the base path duplicated multiple times: ``` https://netbox.server.com/v4.4.7/api/schema/v4.4.7/v4.4.7/api/circuits/... ``` **Root cause:** The `SPECTACULAR_SETTINGS['SERVERS']` url was set to `BASE_PATH` (e.g., `v4.4.7/`). However, drf-spectacular already includes the `BASE_PATH` prefix in the schema paths since all URL patterns are wrapped under `path(settings.BASE_PATH, include(_patterns))`. Swagger-UI resolves the relative server URL against the document URL and then appends the path, causing the prefix to appear multiple times. **Fix:** Replace `'url': BASE_PATH` with `'url': ''` in the `SERVERS` configuration. An empty string causes Swagger-UI to resolve paths relative to the current document, and since the schema paths are already absolute (e.g., `/v4.4.7/api/circuits/...`), they resolve correctly to the server root. This is a no-op for the default case (no `BASE_PATH`), since `BASE_PATH` already evaluates to `''` when unset.

MrUnknownDE closed this issue

2026-04-05 16:29: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

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#389