Feature/256 filter klantcontact on betrokkenen

[bart-maykin]

Fixes #256

Changes

Add two filter fields to the klantcontact api endpoint:

• had_betrokkene__was_partij__url
• had_betrokkene__was_partij__uuid

[SonnyBA]

Functionality wise I think the changes are good! I do think we can add these changes and remove some repeated code and give the test suite some love.

[SonnyBA]

I think using reverse here in combination with http://testserver would be nice.

[stevenbal]

There's still a lot of hardcoded URLs in the test, please replace them with reverse

[stevenbal]

@SonnyBA I discussed this with @bart-maykin, because the underlying field that is referred to is a uuid, drf-spectacular adds format: uuid for all these fields in the OAS. It's not possible to set the format via the filter class, so that leaves us with this workaround or to add extend_schema_field for all fields and override the format (and add the help text). What do you think?

[SonnyBA]

I think this is a workable solution but I would make a separate FilterExtension for it to make things a bit more explicit. These changes currently are hidden away in the CamelizeFilterExtension which should only camelize the parameters in my opinion (like the name suggests).

Maybe we could also do a bit more filtering, like checking for the parameters type (string) and the in value (query) to prevent changing parameters that should not be affected.

Some inspiration:

class UUIDURLFilterExtension(DjangoFilterExtension):
    priority = 2

    def get_schema_operation_parameters(self, auto_schema, *args, **kwargs) -> list[dict]:
        parameters: list[dict] = super().get_schema_operation_parameters(
            auto_schema, *args, **kwargs
        )

        for parameter in parameters:
            parameter_name = parameter["name"]

            is_query = parameter["in"] == OpenApiParameter.QUERY
            is_string = parameter["schema"]["type"] == "string"
            is_url_field = parameter_name.endswith("__url")

            if all((is_query, is_string, is_url_field,)):
                parameter["schema"] = {"type": "string", "format": "uri"}

        return parameters

[SonnyBA]

I think this is a workable solution but I would make a separate FilterExtension for it to make things a bit more explicit. These changes currently are hidden away in the CamelizeFilterExtension which should only camelize the parameters in my opinion (like the name suggests).

Maybe we could also do a bit more filtering, like checking for the parameters type (string) and the in value (query) to prevent changing parameters that should not be affected.

Some inspiration:

class UUIDURLFilterExtension(DjangoFilterExtension):
    priority = 2

    def get_schema_operation_parameters(self, auto_schema, *args, **kwargs) -> list[dict]:
        parameters: list[dict] = super().get_schema_operation_parameters(
            auto_schema, *args, **kwargs
        )

        for parameter in parameters:
            parameter_name = parameter["name"]

            is_query = parameter["in"] == OpenApiParameter.QUERY
            is_string = parameter["schema"]["type"] == "string"
            is_url_field = parameter_name.endswith("__url")

            if all((is_query, is_string, is_url_field,)):
                parameter["schema"] = {"type": "string", "format": "uri"}

        return parameters

[bart-maykin]

@SonnyBA I did add the extra filtering for the DjangoFilterExtension but decided to only use 1 DjangoFilterExtension instead of your suggested 2 separate extentions, because they didn't take the processed data of the other into account.

[SonnyBA]

@bart-maykin see #292