Closes #19829: Move object types REST API endpoint to core app

netbox/core/api/serializers.py

@@ -1,4 +1,5 @@
 from .serializers_.change_logging import *
 from .serializers_.data import *
 from .serializers_.jobs import *
+from .serializers_.object_types import *
 from .serializers_.tasks import *

netbox/core/api/serializers_/object_types.py

@@ -0,0 +1,47 @@
+import inspect
+
+from django.urls import NoReverseMatch, reverse
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import extend_schema_field
+from rest_framework import serializers
+
+from core.models import ObjectType
+from netbox.api.serializers import BaseModelSerializer
+from utilities.views import get_viewname
+
+__all__ = (
+    'ObjectTypeSerializer',
+)
+
+
+class ObjectTypeSerializer(BaseModelSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='extras-api:objecttype-detail')
+    app_name = serializers.CharField(source='app_verbose_name', read_only=True)
+    model_name = serializers.CharField(source='model_verbose_name', read_only=True)
+    model_name_plural = serializers.CharField(source='model_verbose_name_plural', read_only=True)
+    is_plugin_model = serializers.BooleanField(read_only=True)
+    rest_api_endpoint = serializers.SerializerMethodField()
+    description = serializers.SerializerMethodField()
+
+    class Meta:
+        model = ObjectType
+        fields = [
+            'id', 'url', 'display', 'app_label', 'app_name', 'model', 'model_name', 'model_name_plural',
+            'is_plugin_model', 'rest_api_endpoint', 'description',
+        ]
+
+    @extend_schema_field(OpenApiTypes.STR)
+    def get_rest_api_endpoint(self, obj):
+        if not (model := obj.model_class()):
+            return
+        if viewname := get_viewname(model, action='list', rest_api=True):
+            try:
+                return reverse(viewname)
+            except NoReverseMatch:
+                return
+
+    @extend_schema_field(OpenApiTypes.STR)
+    def get_description(self, obj):
+        if not (model := obj.model_class()):
+            return
+        return inspect.getdoc(model)

netbox/core/api/urls.py

@@ -10,6 +10,7 @@ router.register('data-sources', views.DataSourceViewSet)
 router.register('data-files', views.DataFileViewSet)
 router.register('jobs', views.JobViewSet)
 router.register('object-changes', views.ObjectChangeViewSet)
+router.register('object-types', views.ObjectTypeViewSet)
 router.register('background-queues', views.BackgroundQueueViewSet, basename='rqqueue')
 router.register('background-workers', views.BackgroundWorkerViewSet, basename='rqworker')
 router.register('background-tasks', views.BackgroundTaskViewSet, basename='rqtask')

netbox/core/api/views.py

@@ -17,6 +17,7 @@ from core.utils import delete_rq_job, enqueue_rq_job, get_rq_jobs, requeue_rq_jo
 from django_rq.queues import get_redis_connection
 from django_rq.utils import get_statistics
 from django_rq.settings import QUEUES_LIST
+from netbox.api.authentication import IsAuthenticatedOrLoginNotRequired
 from netbox.api.metadata import ContentTypeMetadata
 from netbox.api.pagination import LimitOffsetListPagination
 from netbox.api.viewsets import NetBoxModelViewSet, NetBoxReadOnlyModelViewSet
@@ -85,6 +86,16 @@ class ObjectChangeViewSet(ReadOnlyModelViewSet):
     filterset_class = filtersets.ObjectChangeFilterSet
 
 
+class ObjectTypeViewSet(ReadOnlyModelViewSet):
+    """
+    Read-only list of ObjectTypes.
+    """
+    permission_classes = [IsAuthenticatedOrLoginNotRequired]
+    queryset = ObjectType.objects.order_by('app_label', 'model')
+    serializer_class = serializers.ObjectTypeSerializer
+    filterset_class = filtersets.ObjectTypeFilterSet
+
+
 class BaseRQViewSet(viewsets.ViewSet):
     """
     Base class for RQ view sets. Provides a list() method. Subclasses must implement get_data().