Update to drf-spectacular==0.26.5

Latest version without too much breaking changes
Fix `AutoSchema` subclass
Regenerate schemas
Add regression test

requirements/base.txt

@@ -150,7 +150,7 @@ djangorestframework-gis==1.0
     # via -r requirements/base.in
 drf-nested-routers==0.93.3
     # via commonground-api-common
-drf-spectacular==0.16.0
+drf-spectacular==0.26.5
     # via -r requirements/base.in
 drf-yasg==1.21.7
     # via commonground-api-common

requirements/ci.txt

@@ -218,7 +218,7 @@ drf-nested-routers==0.93.3
     # via
     #   -r requirements/base.txt
     #   commonground-api-common
-drf-spectacular==0.16.0
+drf-spectacular==0.26.5
     # via -r requirements/base.txt
 drf-yasg==1.21.7
     # via

requirements/dev.txt

@@ -248,7 +248,7 @@ drf-nested-routers==0.93.3
     # via
     #   -r requirements/ci.txt
     #   commonground-api-common
-drf-spectacular==0.16.0
+drf-spectacular==0.26.5
     # via -r requirements/ci.txt
 drf-yasg==1.21.7
     # via

src/objects/api/v1/filters.py

@@ -1,3 +1,5 @@
+from datetime import date as date_
+
 from django import forms
 from django.utils.translation import gettext_lazy as _
 
@@ -108,8 +110,8 @@ def filter_data_attrs(self, queryset, name, value: str):
 
         return queryset
 
-    def filter_date(self, queryset, name, value: date):
+    def filter_date(self, queryset, name, value: date_):
         return queryset.filter_for_date(value)
 
-    def filter_registration_date(self, queryset, name, value: date):
+    def filter_registration_date(self, queryset, name, value: date_):
         return queryset.filter_for_registration_date(value)

src/objects/api/v1/openapi.yaml

@@ -639,8 +639,8 @@ components:
         typeVersion:
           type: integer
           maximum: 32767
-          description: Version of the OBJECTTYPE for data in the object record
           minimum: 0
+          description: Version of the OBJECTTYPE for data in the object record
         data:
           type: object
           additionalProperties: {}
@@ -661,20 +661,25 @@ components:
           type: string
           format: date
           readOnly: true
+          nullable: true
           description: Legal end date of the object record
         registrationAt:
           type: string
           format: date
           readOnly: true
           description: The date when the record was registered in the system
         correctionFor:
-          type: string
-          readOnly: true
+          type: integer
+          maximum: 2147483647
+          minimum: 0
           description: Index of the record corrected by the current record
-        correctedBy:
-          type: string
           readOnly: true
+        correctedBy:
+          type: integer
+          maximum: 2147483647
+          minimum: 0
           description: Index of the record, which corrects the current record
+          readOnly: true
       required:
       - startAt
       - typeVersion
@@ -786,8 +791,8 @@ components:
         typeVersion:
           type: integer
           maximum: 32767
-          description: Version of the OBJECTTYPE for data in the object record
           minimum: 0
+          description: Version of the OBJECTTYPE for data in the object record
         data:
           type: object
           additionalProperties: {}
@@ -808,19 +813,24 @@ components:
           type: string
           format: date
           readOnly: true
+          nullable: true
           description: Legal end date of the object record
         registrationAt:
           type: string
           format: date
           readOnly: true
           description: The date when the record was registered in the system
         correctionFor:
-          type: string
+          type: integer
+          maximum: 2147483647
+          minimum: 0
           description: Index of the record corrected by the current record
         correctedBy:
-          type: string
-          readOnly: true
+          type: integer
+          maximum: 2147483647
+          minimum: 0
           description: Index of the record, which corrects the current record
+          readOnly: true
       required:
       - startAt
       - typeVersion

src/objects/api/v2/openapi.yaml

@@ -727,8 +727,8 @@ components:
         typeVersion:
           type: integer
           maximum: 32767
-          description: Version of the OBJECTTYPE for data in the object record
           minimum: 0
+          description: Version of the OBJECTTYPE for data in the object record
         data:
           type: object
           additionalProperties: {}
@@ -749,20 +749,25 @@ components:
           type: string
           format: date
           readOnly: true
+          nullable: true
           description: Legal end date of the object record
         registrationAt:
           type: string
           format: date
           readOnly: true
           description: The date when the record was registered in the system
         correctionFor:
-          type: string
-          readOnly: true
+          type: integer
+          maximum: 2147483647
+          minimum: 0
           description: Index of the record corrected by the current record
-        correctedBy:
-          type: string
           readOnly: true
+        correctedBy:
+          type: integer
+          maximum: 2147483647
+          minimum: 0
           description: Index of the record, which corrects the current record
+          readOnly: true
       required:
       - startAt
       - typeVersion
@@ -787,6 +792,9 @@ components:
       - read_only
       - read_and_write
       type: string
+      description: |-
+        * `read_only` - Read-only
+        * `read_and_write` - Read and write
     MultiLineString:
       type: object
       description: GeoJSON multi-line-string geometry
@@ -879,8 +887,8 @@ components:
         typeVersion:
           type: integer
           maximum: 32767
-          description: Version of the OBJECTTYPE for data in the object record
           minimum: 0
+          description: Version of the OBJECTTYPE for data in the object record
         data:
           type: object
           additionalProperties: {}
@@ -901,19 +909,24 @@ components:
           type: string
           format: date
           readOnly: true
+          nullable: true
           description: Legal end date of the object record
         registrationAt:
           type: string
           format: date
           readOnly: true
           description: The date when the record was registered in the system
         correctionFor:
-          type: string
+          type: integer
+          maximum: 2147483647
+          minimum: 0
           description: Index of the record corrected by the current record
         correctedBy:
-          type: string
-          readOnly: true
+          type: integer
+          maximum: 2147483647
+          minimum: 0
           description: Index of the record, which corrects the current record
+          readOnly: true
       required:
       - startAt
       - typeVersion
@@ -1022,7 +1035,11 @@ components:
         mode:
           allOf:
           - $ref: '#/components/schemas/ModeEnum'
-          description: Permission mode
+          description: |-
+            Permission mode
+
+            * `read_only` - Read-only
+            * `read_and_write` - Read and write
         use_fields:
           type: boolean
           description: Use field-based authorization

src/objects/tests/v1/test_schema.py

@@ -0,0 +1,10 @@
+from rest_framework import status
+from rest_framework.test import APITestCase
+
+from .utils import reverse
+
+
+class APISchemaTest(APITestCase):
+    def test_schema_endoint(self):
+        response = self.client.get(reverse("schema-redoc"))
+        self.assertEqual(response.status_code, status.HTTP_200_OK)

src/objects/tests/v2/test_schema.py

@@ -0,0 +1,10 @@
+from rest_framework import status
+from rest_framework.test import APITestCase
+
+from .utils import reverse
+
+
+class APISchemaTest(APITestCase):
+    def test_schema_endoint(self):
+        response = self.client.get(reverse("schema-redoc"))
+        self.assertEqual(response.status_code, status.HTTP_200_OK)

src/objects/utils/autoschema.py

@@ -40,9 +40,13 @@ def _get_filter_parameters(self):
             return []
         return super()._get_filter_parameters()
 
-    def _get_response_for_code(self, serializer, status_code, media_types=None):
+    def _get_response_for_code(
+        self, serializer, status_code, media_types=None, direction="response"
+    ):
         """add default description to the response"""
-        response = super()._get_response_for_code(serializer, status_code, media_types)
+        response = super()._get_response_for_code(
+            serializer, status_code, media_types, direction
+        )
 
         if not response.get("description"):
             response["description"] = HTTP_STATUS_CODE_TITLES.get(int(status_code))
@@ -149,9 +153,9 @@ def get_fields_params(self) -> list[OpenApiParameter]:
 
         return []
 
-    def _get_request_body(self):
+    def _get_request_body(self, direction="request"):
         """update search request body with filter parameters"""
-        request_body = super()._get_request_body()
+        request_body = super()._get_request_body(direction)
 
         if self.view.action == "search":
             filter_params = self.get_filter_params_for_search()