example of failing test on related_field

.github/workflows/testing.yml

@@ -64,7 +64,7 @@ jobs:
           python -m venv .venv
           source .venv/bin/activate
           pip install wheel setuptools pip -U
-          poetry install --no-interaction --no-root --extras drf-spectacular --extras drf-yasg
+          poetry install --no-interaction --no-root --extras drf-spectacular --extras drf-yasg --extras djangorestframework-jsonapi
         if: steps.cache-venv.outputs.cache-hit != 'true'
       - run: |
           source .venv/bin/activate

.pre-commit-config.yaml

@@ -52,7 +52,7 @@ repos:
           - types-PyYAML
           - drf-yasg
           - drf-spectacular
-
+          - djangorestframework-jsonapi
   - repo: local
     hooks:
       - id: pylint

pyproject.toml

@@ -57,10 +57,12 @@ prance = "*"
 pyYAML = "*"
 drf-spectacular = { version = "*", optional = true }
 drf-yasg = { version = "*", optional = true }
+djangorestframework-jsonapi = { version = "*", optional = true }
 
 [tool.poetry.extras]
 drf-yasg = ["drf-yasg"]
 drf-spectacular = ["drf-spectacular"]
+djangorestframework-jsonapi = ["djangorestframework-jsonapi"]
 
 [tool.poetry.dev-dependencies]
 coverage = { extras = ["toml"], version = "^6" }

test_project/api/views/pets.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from rest_framework.response import Response
+from rest_framework.status import HTTP_200_OK
+from rest_framework_json_api.views import RelationshipView
+
+if TYPE_CHECKING:
+    from rest_framework.request import Request
+
+
+
+class PetOwnerRelationshipView(RelationshipView):
+    def post(self, request: Request, petId: int, relatedField: str) -> Response:
+        return Response({}, HTTP_200_OK)

test_project/urls.py

@@ -1,5 +1,5 @@
 from django.conf.urls.i18n import i18n_patterns
-from django.urls import include, path
+from django.urls import include, path, re_path
 from drf_yasg import openapi
 from drf_yasg.views import get_schema_view
 from rest_framework import permissions, routers
@@ -11,6 +11,7 @@
 from test_project.api.views.i18n import Languages
 from test_project.api.views.items import Items
 from test_project.api.views.names import EmptyNameViewSet, NamesRetrieveView, NameViewSet
+from test_project.api.views.pets import PetOwnerRelationshipView
 from test_project.api.views.products import Products
 from test_project.api.views.snake_cased_response import SnakeCasedResponse
 from test_project.api.views.trucks import BadTrucks, GoodTrucks
@@ -34,6 +35,11 @@
     path("api/<str:version>/snake-case/", SnakeCasedResponse.as_view()),
     # ^trailing slash is here on purpose
     path("api/<str:version>/router_generated/", include(router.urls)),
+    re_path(
+        r"api/pet/(?P<petId>\d+)/relationships/(?P<relatedField>[-\w]+)",
+        PetOwnerRelationshipView.as_view(),
+        name="pet-owner-relation",
+    ),
 ]
 
 internationalised_urlpatterns = i18n_patterns(