Debian Codegraph @

releasenotes/notes/action_providers-a1b65db20bd01071.yaml

raw
1 ---
2 features:
3 - |
4 There has been a big change in the Mistral action management. All Mistral
5 subsystems don't access the database directly if they need to work with
6 action definitions. Instead, they work action providers registered in
7 the new entry point "mistral.action.providers". All action providers need
8 to implement the base class ActionProvider declared in "mistral-lib"
9 starting with the version 2.3.0. Action providers are responsible for
10 delivering so-called action descriptors that carry all the most important
11 information about particular actions like "name", "description", names
12 of input parameters and so on. The entire system has now been refactored
13 with action providers. Using this new mechanism it's now possible to
14 deliver actions into the system dynamically w/o having to reboot Mistral.
15 We just need to come up with an action provider implementation that can
16 do that and register it in the entry point from any Python project
17 installed on the same Python environment.
18 This approach also means that actions don't have to be stored in the
19 database anymore. It fully depends on a particular action provider how
20 to store action descriptors and how to perform lookup. It is possible
21 to create action providers fetching information about actions over
22 HTTP, AMQP and potentially any other protocol.
23 Additionally, switching to action providers allowed to make engine code
24 much cleaner and more encapsulated. For example, ad-hoc actions are no
25 longer a concern of the Mistral engine. Instead of implementing all
26 ad-hoc action logic in the engine there's now a special action provider
27 fully responsible for ad-hoc actions.
28 The detailed documentation on using action providers will be added soon.
29 upgrade:
30 - |
31 As part of the transition to action providers the compatibility of the
32 /actions REST API endpoint has been broken to some extent. For ad-hoc
33 actions it remained almost the same. We still can do all CRUD operations
34 upon them. However, all the standard actions (prefixed with "std.") are
35 not stored in the DB anymore. For that reason this type of actions doesn't
36 have IDs anymore, and generally actions are not identified by IDs anymore,
37 only by name. This change needs to be taken into account when updating
38 to this version of Mistral.