umutbozkurt/django-rest-framework-mongoengine

Let's use ref_name for nested embedded fields as well

krsteve opened this issue · 5 comments

krsteve commented

Hi,

I'm using drf-mongoengine with drf-yasg, and terrible things happen with the Swagger spec generation because the ref_name is "Embedded" across all the nested embedded fields.

I was able to fix this issue by adding a ref_name line for the build_nested_embedded_field method of DocumentSerializer.

    def build_nested_embedded_field(self, field_name, relation_info, embedded_depth):
        subclass = self.serializer_embedded_nested or EmbeddedDocumentSerializer
        class EmbeddedSerializer(subclass):
            class Meta:
                model = relation_info.related_model
                depth_embedding = embedded_depth - 1
                ref_name = f"{self.get_model().__name__}_{field_name}".replace(
                    ".", "_"
                ).replace("_child", "")

The following link is the fork repo I'm using for my project. If you like this idea, please add this feature!
lessbutter@52da614

BurkovBA commented

Hello, @krsteve.

I've never tested DRF-Mongoengine with Swagger spec support, and definitely cannot guarantee that they work together. To be honest, I've switched to other projects full-time and have not really been maintaining DRF-Mongoengine now.

Do you suggest that addition of ref_name field to the Serializer.Meta would improve its display in Swagger documentation, auto-generated by DRF-YASG? Is this solution similar to this post: https://stackoverflow.com/questions/59885543/problem-reusing-serializers-with-django-and-drf-yasg?

Thanks for your suggestion. Could you, maybe, create a unit-test for this functionality and submit a pull-request? I'll review it and merge, if everything works.

  • 👍1
krsteve commented

Sadly I don't think I have the time to create a unit-test as I'm currently working way past hours... :(

Anyways, great package! Helped me a lot. Thanks :)

skeletorXVI commented

Hello, @krsteve.

I've never tested DRF-Mongoengine with Swagger spec support, and definitely cannot guarantee that they work together. To be honest, I've switched to other projects full-time and have not really been maintaining DRF-Mongoengine now.

Do you suggest that addition of ref_name field to the Serializer.Meta would improve its display in Swagger documentation, auto-generated by DRF-YASG? Is this solution similar to this post: https://stackoverflow.com/questions/59885543/problem-reusing-serializers-with-django-and-drf-yasg?

Thanks for your suggestion. Could you, maybe, create a unit-test for this functionality and submit a pull-request? I'll review it and merge, if everything works.

@BurkovBA @krsteve Take a look at #281, we ran into this problem in the beginning of 2021 and solved, deployed and run this successfully in production using drf-yasg. Unfortunately I can't invest time into adding unit tests in the foreseeable future, as we migrated our application to fastapi and I am busy with the last semester before my Bachlor thesis.

IATF commented
BurkovBA commented

@skeletorXVI Sorry for my non-existence. Reviewed the PR, merged. Thank you for submitting it!