WIP: Add reference sources model

src/backend/InvenTree/InvenTree/api_version.py

@@ -1,13 +1,16 @@
 """InvenTree API version information."""
 
 # InvenTree API version
-INVENTREE_API_VERSION = 312
+INVENTREE_API_VERSION = 313
 
 """Increment this API version number whenever there is a significant change to the API that any clients need to know about."""
 
 
 INVENTREE_API_TEXT = """
 
+v313 - 2025-02-20 : https://github.com/inventree/InvenTree/pull/8596
+    - Adds ReferenceSource and Reference endpoints to the API
+
 v312 - 2025-02-15 : https://github.com/inventree/InvenTree/pull/9079
     - Remove old API endpoints associated with legacy BOM import functionality
 

src/backend/InvenTree/common/admin.py

@@ -118,3 +118,5 @@ class NewsFeedEntryAdmin(admin.ModelAdmin):
 
 
 admin.site.register(common.models.WebhookMessage, admin.ModelAdmin)
+admin.site.register(common.models.Reference, admin.ModelAdmin)
+admin.site.register(common.models.ReferenceSource, admin.ModelAdmin)

src/backend/InvenTree/common/api.py

@@ -882,6 +882,117 @@ class SelectionEntryDetail(EntryMixin, RetrieveUpdateDestroyAPI):
     path('', SelectionListList.as_view(), name='api-selectionlist-list'),
 ]
 
+
+class ReferenceSourceList(ListCreateAPI):
+    """List view for all reference sources."""
+
+    queryset = common.models.ReferenceSource.objects.all()
+    serializer_class = common.serializers.ReferenceSourceSerializer
+    permission_classes = [permissions.IsAuthenticated, IsStaffOrReadOnly]
+    filter_backends = SEARCH_ORDER_FILTER
+
+    ordering_fields = [
+        'name',
+        'description',
+        'slug',
+        'locked',
+        'active',
+        'source_plugin',
+        'created',
+        'last_updated',
+    ]
+    search_fields = ['name', 'description', 'slug']
+
+
+class ReferenceSourceDetail(RetrieveUpdateDestroyAPI):
+    """Detail view for a particular reference source."""
+
+    queryset = common.models.ReferenceSource.objects.all()
+    serializer_class = common.serializers.ReferenceSourceSerializer
+    permission_classes = [permissions.IsAuthenticated, IsStaffOrReadOnly]
+
+
+class ReferenceList(ListCreateAPI):
+    """List view for all references."""
+
+    queryset = common.models.Reference.objects.all()
+    serializer_class = common.serializers.ReferenceSerializer
+    permission_classes = [permissions.IsAuthenticated, IsStaffOrReadOnly]
+    filter_backends = SEARCH_ORDER_FILTER
+
+    ordering_fields = [
+        'source',
+        'target',
+        'value',
+        'locked',
+        'created',
+        'last_updated',
+        'checked',
+        'last_checked',
+    ]
+    search_fields = ['source', 'target', 'value']
+
+    def get_queryset(self):
+        """Return prefetched queryset."""
+        queryset = (
+            super()
+            .get_queryset()
+            .prefetch_related('target_content_type', 'target_object_id')
+        )
+
+        return queryset
+
+
+class ReferenceDetail(RetrieveUpdateDestroyAPI):
+    """Detail view for a particular reference."""
+
+    queryset = common.models.Reference.objects.all()
+    serializer_class = common.serializers.ReferenceSerializer
+    permission_classes = [permissions.IsAuthenticated, IsStaffOrReadOnly]
+
+    def get_queryset(self):
+        """Return prefetched queryset."""
+        queryset = (
+            super()
+            .get_queryset()
+            .prefetch_related('target_content_type', 'target_object_id')
+        )
+
+        return queryset
+
+
+reference_urls = [
+    path(
+        'source/',
+        include([
+            path(
+                '<int:pk>/',
+                include([
+                    path(
+                        '',
+                        ReferenceSourceDetail.as_view(),
+                        name='api-reference-source-detail',
+                    )
+                ]),
+            ),
+            path('', ReferenceSourceList.as_view(), name='api-reference-source-list'),
+        ]),
+    ),
+    # TODO add api endpoint to get all references for a target
+    path(
+        '',
+        include([
+            path(
+                '<int:pk>/',
+                include([
+                    path('', ReferenceDetail.as_view(), name='api-reference-detail')
+                ]),
+            ),
+            path('', ReferenceList.as_view(), name='api-reference-list'),
+        ]),
+    ),
+]
+
 # API URL patterns
 settings_api_urls = [
     # User settings
@@ -1093,6 +1204,8 @@ class SelectionEntryDetail(EntryMixin, RetrieveUpdateDestroyAPI):
     path('icons/', IconList.as_view(), name='api-icon-list'),
     # Selection lists
     path('selection/', include(selection_urls)),
+    # References
+    path('reference/', include(reference_urls)),
 ]
 
 admin_api_urls = [