From 134cde007991e0780575d14a3c6c502457f0fbc9 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 May 2023 10:45:19 -0400 Subject: [PATCH] Fix OpanAPI schema base path --- netbox/core/api/schema.py | 15 ++------------- netbox/netbox/settings.py | 8 +++++--- 2 files changed, 7 insertions(+), 16 deletions(-) diff --git a/netbox/core/api/schema.py b/netbox/core/api/schema.py index d06d1d3bfaf..9550df3ea84 100644 --- a/netbox/core/api/schema.py +++ b/netbox/core/api/schema.py @@ -1,23 +1,12 @@ import re import typing -from drf_spectacular.extensions import ( - OpenApiSerializerFieldExtension, - OpenApiViewExtension, -) +from drf_spectacular.extensions import OpenApiSerializerFieldExtension from drf_spectacular.openapi import AutoSchema from drf_spectacular.plumbing import ( - ComponentRegistry, - ResolvedComponent, - build_basic_type, - build_choice_field, - build_media_type_object, - build_object_type, - get_doc, - is_serializer, + build_basic_type, build_choice_field, build_media_type_object, build_object_type, get_doc, ) from drf_spectacular.types import OpenApiTypes -from drf_spectacular.utils import extend_schema from rest_framework.relations import ManyRelatedField from netbox.api.fields import ChoiceField, SerializedPKRelatedField diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 01a1e209025..6608fcb8f1e 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -616,13 +616,15 @@ def _setting(name, default=None): # SPECTACULAR_SETTINGS = { - 'TITLE': 'NetBox API', - 'DESCRIPTION': 'API to access NetBox', + 'TITLE': 'NetBox REST API', 'LICENSE': {'name': 'Apache v2 License'}, 'VERSION': VERSION, 'COMPONENT_SPLIT_REQUEST': True, 'REDOC_DIST': 'SIDECAR', - 'SERVERS': [{'url': f'/{BASE_PATH}api'}], + 'SERVERS': [{ + 'url': BASE_PATH, + 'description': 'NetBox', + }], 'SWAGGER_UI_DIST': 'SIDECAR', 'SWAGGER_UI_FAVICON_HREF': 'SIDECAR', 'POSTPROCESSING_HOOKS': [],