From 03f097379be4c84047b70932976e521c5105400e Mon Sep 17 00:00:00 2001 From: Nicholas Long <1907354+nllong@users.noreply.github.com> Date: Thu, 21 Mar 2024 10:40:52 -0600 Subject: [PATCH] Fix property search endpoint in Swagger (#4579) add org_id to the query param --- seed/views/v3/properties.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/seed/views/v3/properties.py b/seed/views/v3/properties.py index a2cc391923..5e1f53bb07 100644 --- a/seed/views/v3/properties.py +++ b/seed/views/v3/properties.py @@ -184,6 +184,11 @@ class PropertyViewSet(generics.GenericAPIView, viewsets.ViewSet, OrgMixin, Profi # For the Swagger page, GenericAPIView asserts a value exists for `queryset` queryset = PropertyView.objects.none() + @swagger_auto_schema( + manual_parameters=[ + AutoSchemaHelper.query_org_id_field(required=True), + ] + ) @has_perm_class('requires_viewer') @action(detail=False, filter_backends=[PropertyViewFilterBackend]) def search(self, request): @@ -200,9 +205,11 @@ def search(self, request): property__access_level_instance__lft__gte=ali.lft, property__access_level_instance__rgt__lte=ali.rgt ).order_by('-state__id') + # this is the entrypoint to the filtering backend # https://www.django-rest-framework.org/api-guide/filtering/#custom-generic-filtering qs = self.filter_queryset(qs) + # converting QuerySet to list b/c serializer will only use column list profile this way return JsonResponse( PropertyViewAsStateSerializer(list(qs), context={'request': request}, many=True).data,