Skip to content

Commit 4054603

Browse files
committed
[DOCS] Add documentation about reaction response, resolves #386
1 parent ae41c45 commit 4054603

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

ChangeLog

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
2025-08-20 Francois Suter (Idéative) <[email protected]>
22

33
* Consider only live records in uid repository, resolves #387
4+
* Add documentation about reaction response, resolves #386
45

56
2025-07-23 Francois Suter (Idéative) <[email protected]>
67

Documentation/User/Reaction/Index.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,3 +164,18 @@ is not used by the delete process. In fact the only properties that are used fro
164164
If the delete reaction tries to delete an already deleted record, the operation will
165165
be silently successful. On the contrary, trying to delete a record which doesn't exist at all,
166166
triggers an error.
167+
168+
169+
.. _user-reaction-response:
170+
171+
Reaction response
172+
"""""""""""""""""
173+
174+
The response contains a :code:`success` entry with value :code:`true` or :code:`false`.
175+
176+
If the :code:`success` is :code:`false`, the response will contain a :code:`error` entry (string) for the delete reaction
177+
or an :code:`errors` entry (array of strings) for the import reaction. These contain information about what went wrong.
178+
179+
If the :code:`success` is :code:`true`, the response will contain a :code:`message` entry (string) for the delete reaction
180+
or an :code:`messages` entry (array of strings) for the import reaction. These contain information about the number of
181+
operations performed.

0 commit comments

Comments
 (0)