ag-admin/OpenSlides
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Change name

Browse Source
This commit is contained in:
Finn Stutzenstein 2020-11-19 15:01:49 +01:00
parent cb7e91d8c5
commit a0d0a4ac0b
No known key found for this signature in database
GPG Key ID: 9042F605C6324654
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/interfaces/action-service.txt
View File

@ -3,11 +3,11 @@
/** /**
* Executes multiple actions in the context of the user given by the user_id. * Executes multiple actions in the context of the user given by the user_id.
* There are two modes of execution: * There are two modes of execution:
* single_validation=false (default): * atomic=false (default):
* All actions are validated in common, so if one action or one payload of * All actions are validated in common, so if one action or one payload of
* one action fails, the request is aborted with an ActionException indicating * one action fails, the request is aborted with an ActionException indicating
* the problematic action with both indices. * the problematic action with both indices.
* single_validation=true: * atomic=true:
* Each action is validated by it's own. If there is an error, the error must * Each action is validated by it's own. If there is an error, the error must
* be reported via an ActionError in the ActionsResponse. The actions result * be reported via an ActionError in the ActionsResponse. The actions result
* is not written into the Datastore. It might raise an ActionException if the * is not written into the Datastore. It might raise an ActionException if the
@ -22,7 +22,7 @@ handle_request(payload: Action[], user_id: Id): ActionsResponse
interface Action { interface Action {
action: string; action: string;
data: object[]; data: object[];
single_validation?: boolean; atomic?: boolean;
} }
interace ActionsResponse { interace ActionsResponse {
@ -59,7 +59,7 @@ interface ActionError {
* use the action_error_index and action_payload_error_index to indicate the errored * use the action_error_index and action_payload_error_index to indicate the errored
* action and payload. If there were general errors, both indices must be omitted. * action and payload. If there were general errors, both indices must be omitted.
* *
* If the single_validation Flag was true in the request, it is not allowed to send * If the atomic flag was true in the request, it is not allowed to send
* action-specific errors with this exception. It must be responded through ActionsResponse. * action-specific errors with this exception. It must be responded through ActionsResponse.
*/ */
Exception ActionException { Exception ActionException {