From a008cd8921419a8ff047ef867d7b93a3b58c3d02 Mon Sep 17 00:00:00 2001
From: Sonny Bakker <sonny@maykinmedia.nl>
Date: Tue, 20 Sep 2022 15:09:31 +0200
Subject: [PATCH] [#210] add comments above `FileFieldExtension`

---
 vng_api_common/inspectors/files.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/vng_api_common/inspectors/files.py b/vng_api_common/inspectors/files.py
index a66b7270..238e2a57 100644
--- a/vng_api_common/inspectors/files.py
+++ b/vng_api_common/inspectors/files.py
@@ -5,6 +5,10 @@
 from drf_spectacular.types import OpenApiTypes
 
 
+# Note that some API's may require a seperate request/response schema in order
+# to properly display this in the schema.
+# See https://drf-spectacular.readthedocs.io/en/latest/client_generation.html?highlight=COMPONENT_SPLIT_REQUEST#component-issues
+# and https://github.com/tfranzel/drf-spectacular/issues/778
 class FileFieldExtension(OpenApiSerializerFieldExtension):
     target_class = "drf_extra_fields.fields.Base64FileField"
     match_subclasses = True