Set PluginInstanceRequest.additionalProperties={}

FNNDSC · Oct 1, 2024 · 743e61b · 743e61b
1 parent 5ca0271
commit 743e61b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/chris_backend/config/settings/common.py b/chris_backend/config/settings/common.py
@@ -202,7 +202,8 @@
     ],
     'POSTPROCESSING_HOOKS': [
         'drf_spectacular.hooks.postprocess_schema_enums',
-        'collectionjson.spectacular_hooks.postprocess_remove_collectionjson'
+        'collectionjson.spectacular_hooks.postprocess_remove_collectionjson',
+        'plugininstances.spectacular_hooks.additionalproperties_for_plugins_instances_create'
     ],
 
     'SCHEMA_PATH_PREFIX': '/api/v1/',

diff --git a/chris_backend/plugininstances/spectacular_hooks.py b/chris_backend/plugininstances/spectacular_hooks.py
@@ -0,0 +1,12 @@
+def additionalproperties_for_plugins_instances_create(result, **_kwargs):
+    """
+    Set ``additionalProperties: {}`` for the request body of ``plugins_instances_create``
+    (``additionalProperties`` cannot be set ordinarily using drf-spectacular ``@extend_schema``).
+    This is necessary because ``[POST] api/v1/plugins/N/instances/`` receives
+    plugin instance parameters as arbitrary properties.
+
+    :param result: an OpenAPI specification
+    """
+    result['components']['schemas']['PluginInstanceRequest']['additionalProperties'] = {}
+    return result
+