fix: update openapi schema for rule audits to include filter params

src/aap_eda/api/views/rulebook.py

@@ -16,7 +16,6 @@
 from django.http import JsonResponse
 from django.shortcuts import get_object_or_404
 from django_filters import rest_framework as defaultfilters
-from drf_spectacular.types import OpenApiTypes
 from drf_spectacular.utils import (
     OpenApiParameter,
     OpenApiResponse,
@@ -32,6 +31,7 @@
 from aap_eda.core.enums import Action
 from aap_eda.core.exceptions import ParseError
 from aap_eda.core.utils.rulebook import build_source_list
+from aap_eda.utils.openapi import generate_query_params
 
 
 @extend_schema_view(
@@ -146,16 +146,7 @@ def sources(self, request, id):
                 description="Return a list of fired rules.",
             ),
         },
-        parameters=[
-            OpenApiParameter(
-                name="search",
-                type=OpenApiTypes.OBJECT,
-                location=OpenApiParameter.QUERY,
-                style="form",
-                explode=True,
-                description="A free formatted query string with Django semantics for filtering and ordering",  # noqa: E501
-            ),
-        ],
+        parameters=generate_query_params(serializers.AuditRuleSerializer()),
     ),
 )
 class AuditRuleViewSet(
@@ -196,15 +187,10 @@ def get_serializer_class(self):
                 location=OpenApiParameter.PATH,
                 description="A unique integer value identifying this rule audit.",  # noqa: E501
             ),
-            OpenApiParameter(
-                name="search",
-                type=OpenApiTypes.OBJECT,
-                location=OpenApiParameter.QUERY,
-                style="form",
-                explode=True,
-                description="A free formatted query string with Django semantics for filtering and ordering",  # noqa: E501
-            ),
-        ],
+        ]
+        + generate_query_params(
+            serializers.AuditActionSerializer(),
+        ),
     )
     @action(
         detail=False,
@@ -240,15 +226,8 @@ def actions(self, _request, id):
                 location=OpenApiParameter.PATH,
                 description="A unique integer value identifying this Audit Rule.",  # noqa: E501
             ),
-            OpenApiParameter(
-                name="search",
-                type=OpenApiTypes.OBJECT,
-                location=OpenApiParameter.QUERY,
-                style="form",
-                explode=True,
-                description="A free formatted query string with Django semantics for filtering and ordering",  # noqa: E501
-            ),
-        ],
+        ]
+        + generate_query_params(serializers.AuditEventSerializer()),
     )
     @action(
         detail=False,

src/aap_eda/utils/openapi.py

@@ -0,0 +1,57 @@
+#  Copyright 2024 Red Hat, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from django.db import models
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import OpenApiParameter
+from rest_framework.serializers import Serializer
+
+
+def generate_query_params(serializer: Serializer) -> list[OpenApiParameter]:
+    """Generate OpenAPI query parameters dynamically based on the view's serializer fields and model."""  # noqa: E501
+    query_params = []
+    model = serializer.Meta.model
+    fields = serializer.get_fields()
+    field_names = fields.keys()
+    for field in model._meta.get_fields():
+        # check if model field name is defined in the serializer
+        if (
+            field.name in field_names
+            or "_".join([field.name, "id"]) in field_names
+        ):
+            param_name = (
+                field.name
+                if field.name in field_names
+                else "_".join([field.name, "id"])
+            )
+            query_params.append(
+                OpenApiParameter(
+                    name=param_name,
+                    description=f"Filter by {param_name}",
+                    required=False,
+                    type=(
+                        OpenApiTypes.STR
+                        if isinstance(field, models.CharField)
+                        else OpenApiTypes.NUMBER
+                        if isinstance(field, models.IntegerField)
+                        else OpenApiTypes.DATETIME
+                        if isinstance(field, models.DateField)
+                        else OpenApiTypes.BOOL
+                        if isinstance(field, models.BooleanField)
+                        else OpenApiTypes.STR
+                    ),
+                )
+            )
+
+    return query_params

tests/unit/test_utils.py

@@ -16,9 +16,14 @@
 from unittest.mock import patch
 
 import pytest
+from django.db import models
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import OpenApiParameter
+from rest_framework import serializers
 
 from aap_eda.core.utils.strings import extract_variables
 from aap_eda.utils import get_eda_version, str_to_bool
+from aap_eda.utils.openapi import generate_query_params
 
 
 @pytest.mark.parametrize(
@@ -69,3 +74,96 @@ def test_get_eda_version():
 )
 def test_extract_variables(value, expected):
     assert extract_variables(value) == expected
+
+
+#################################################################
+# Tests for src/aap_eda/utils/openapi.py
+#################################################################
+class AnotherSampleModel(models.Model):
+    name = models.CharField(max_length=100)
+
+    class Meta:
+        app_label = "tests"
+
+
+class SampleModel(models.Model):
+    name = models.CharField(max_length=100)
+    age = models.IntegerField()
+    created_at = models.DateField()
+    is_active = models.BooleanField()
+    another_model = models.ForeignKey(
+        AnotherSampleModel, on_delete=models.CASCADE, null=True
+    )
+    secret = models.CharField(max_length=100)
+
+    class Meta:
+        app_label = "tests"
+
+
+class SampleModelSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = SampleModel
+        fields = [
+            "id",
+            "name",
+            "age",
+            "created_at",
+            "is_active",
+            "another_model_id",
+        ]
+
+
+@pytest.mark.parametrize(
+    "serializer, expected_params",
+    [
+        (
+            SampleModelSerializer(),
+            [
+                OpenApiParameter(
+                    name="id",
+                    description="Filter by id",
+                    required=False,
+                    type=OpenApiTypes.NUMBER,
+                ),
+                OpenApiParameter(
+                    name="name",
+                    description="Filter by name",
+                    required=False,
+                    type=OpenApiTypes.STR,
+                ),
+                OpenApiParameter(
+                    name="age",
+                    description="Filter by age",
+                    required=False,
+                    type=OpenApiTypes.NUMBER,
+                ),
+                OpenApiParameter(
+                    name="created_at",
+                    description="Filter by created_at",
+                    required=False,
+                    type=OpenApiTypes.DATETIME,
+                ),
+                OpenApiParameter(
+                    name="is_active",
+                    description="Filter by is_active",
+                    required=False,
+                    type=OpenApiTypes.BOOL,
+                ),
+                OpenApiParameter(
+                    name="another_model_id",
+                    description="Filter by another_model_id",
+                    required=False,
+                    type=OpenApiTypes.STR,
+                ),
+            ],
+        ),
+    ],
+)
+def test_generate_query_params(serializer, expected_params):
+    query_params = generate_query_params(serializer)
+
+    assert isinstance(query_params, list)
+    assert len(query_params) == len(expected_params)
+
+    for param, expected in zip(query_params, expected_params):
+        assert param.__dict__ == expected.__dict__