Merge pull request #4722 from open-formulieren/task/4721-document-obj…

…ects-api-update-existing-object [#4721] Update docs concerning prefill and Objects API
open-formulieren · Oct 8, 2024 · e25afd6 · e25afd6
2 parents 5f2f818 + 9a79c81
commit e25afd6
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 0 deletions.
diff --git a/docs/configuration/prefill/_assets/update_existing_object.png b/docs/configuration/prefill/_assets/update_existing_object.png
diff --git a/docs/configuration/prefill/objects_api.rst b/docs/configuration/prefill/objects_api.rst
@@ -46,3 +46,14 @@ Configuration
 8. Save the form
 
 The Objects API configuration is now complete.
+
+.. note::
+
+ The Objects API prefill can be used not only for prefilling and showing the data to the user,
+ but it can also work together with the Objects API registration plugin
+ (see :ref:`Objects API configuration (English) <configuration_registration_objects>`) in order to make 
+ modifications to an existing object in the Objects API. This requires the form user to be the "owner"
+ of the object and the necessary configuration in the Objects API registration at the form level
+ (by choosing to update the existing object).
+
+ .. image:: _assets/update_existing_object.png
diff --git a/docs/manual/registration/_assets/objects_api_modal.png b/docs/manual/registration/_assets/objects_api_modal.png
diff --git a/docs/manual/registration/_assets/objects_api_registration_variables.png b/docs/manual/registration/_assets/objects_api_registration_variables.png
diff --git a/docs/manual/registration/_assets/objects_plugin_variables.png b/docs/manual/registration/_assets/objects_plugin_variables.png
diff --git a/docs/manual/registration/_assets/variables_tab.png b/docs/manual/registration/_assets/variables_tab.png