Merge pull request #509 from maykinmedia/fix/508-api-schema

🐛 [#508] Fix API schema

Author: SilviaAmAm

backend/src/openarchiefbeheer/selection/api/schemas.py

@@ -57,3 +57,28 @@
         ),
     ],
 )
+
+
+SCHEMA_SELECTION_REQUEST = OpenApiRequest(
+    request={
+        "type": "object",
+        "properties": {
+            "items": {
+                "type": "array",
+                "description": "Filter on specific items in the selection",
+                "items": {"type": "string"},
+            }
+        },
+    },
+    examples=[
+        OpenApiExample(
+            "Add to the selection",
+            value={
+                "items": [
+                    "http://zaken.nl/api/v1/zaken/111-111-111",
+                    "http://zaken.nl/api/v1/zaken/222-222-222",
+                ]
+            },
+        ),
+    ],
+)

backend/src/openarchiefbeheer/selection/api/views.py

@@ -10,7 +10,7 @@
 
 from ..models import AllSelectedToggle, SelectionItem
 from .filtersets import SelectionItemBackend, SelectionItemFilterset
-from .schemas import SCHEMA_REQUEST, SCHEMA_RESPONSE
+from .schemas import SCHEMA_REQUEST, SCHEMA_RESPONSE, SCHEMA_SELECTION_REQUEST
 from .serializers import (
     SelectAllToggleSerializer,
     SelectionItemDataReadSerializer,
@@ -50,6 +50,7 @@ def _get_selection_representation(self, queryset=None):
         # otherwise the filter backends are not picked up. The right response is added by using
         # DRF spectacular post processing hooks.
         responses={200: SelectionItemDataReadSerializer(many=True)},
+        request=SCHEMA_SELECTION_REQUEST,
     )
     def post(self, request, *args, **kwargs):
         queryset = self.filter_queryset(self.get_queryset())