Skip to content

Commit cf0299b

Browse files
committed
Ref: #7 FEO: config schema alignment
1 parent c556c4f commit cf0299b

File tree

1 file changed

+20
-92
lines changed

1 file changed

+20
-92
lines changed

components/feo/docs/concepts/01_design_manifest.rst

+20-92
Original file line numberDiff line numberDiff line change
@@ -18,67 +18,16 @@ Config file schema
1818
whatever_property: 1 # Example how additional properties for the activities can be provided later on
1919
RunConcurrent1: &RunConcurrent1_label
2020
prop1: 2
21+
depends_on: # List of dependencies
22+
- *GetData_label
2123
RunConcurrent2: &RunConcurrent2_label
2224
prop1: 1
25+
depends_on:
26+
- *RunConcurrent2_label
2327
RunSync: &RunSync_label
2428
prop1: 3
25-
26-
state: # Define any states needed for the switch action
27-
state1: &state1_label
28-
intitial_value: 1
29-
30-
events: 3 Define events if needed
31-
event1: &event1_label
32-
33-
# We assume that each flow is executed as a loop, running sequentially from the top to the bottom, unless it is shut down.
34-
flows:
35-
flow_name1: # Flow declaration
36-
some_other_prop: whatever # Example how any new properties can be added to flow later
37-
actions:
38-
- class: execute
39-
activity: *GetData_label
40-
- class: concurrent
41-
actions:
42-
- class: execute
43-
activity: *RunConcurrent1_label
44-
- class: execute
45-
activity: *RunConcurrent2_label
46-
- class: sequence
47-
actions:
48-
- class: execute
49-
activity: *RunConcurrent1_label
50-
- class: execute
51-
activity: *RunConcurrent2_label
52-
- class: trigger
53-
event: *event1_label
54-
- class: execute
55-
activity: *RunSync_label
56-
- class: switch
57-
state: *state1_label
58-
default_action: # optional
59-
class: execute
60-
activity: *RunConcurrent2_label
61-
cases:
62-
- state_value: 0
63-
action:
64-
class: sequence
65-
actions:
66-
- class: execute
67-
activity: *RunConcurrent2_label
68-
- state_value: 2
69-
action:
70-
class: execute
71-
activity: *RunConcurrent2_label
72-
73-
## Included here for now to help understand what kinds of flow items are available.
74-
documentation_node:
75-
class:
76-
- sequence # organize activities to be called one after another
77-
- execute # activity execution, in particular calling Step()
78-
- concurrent # organize activities to be called concurrently
79-
- switch # execute activities based on a state
80-
- synchronize # wait for an event to continue
81-
- trigger # trigger and event
29+
depends_on:
30+
- *RunSync_label
8231
8332
8433
Example
@@ -98,44 +47,23 @@ Config
9847
activities: # Define activities in the application
9948
Activity1: &Activity1_label
10049
Activity2: &Activity2_label
50+
depends_on:
51+
- *Activity1_label
10152
Activity3: &Activity3_label
53+
depends_on:
54+
- *Activity1_label
10255
Activity4: &Activity4_label
56+
depends_on:
57+
- *Activity2_label
10358
Activity5: &Activity5_label
59+
depends_on:
60+
- *Activity3_label
10461
Activity6: &Activity6_label
62+
depends_on:
63+
- *Activity5_label
10564
Activity7: &Activity7_label
65+
depends_on:
66+
- *Activity5_label
10667
Activity8: &Activity8_label
107-
flows:
108-
app_flow:
109-
actions: # PICTURE_1_TAG
110-
- class: execute
111-
activity: *Activity1_label
112-
- class: concurrent # PICTURE_2_TAG
113-
actions:
114-
- class: sequence # PICTURE_3_TAG
115-
actions:
116-
- class: execute
117-
activity: *Activity2_label
118-
- class: execute
119-
activity: *Activity4_label
120-
- class: sequence # PICTURE_4_TAG
121-
actions:
122-
- class: execute
123-
activity: *Activity3_label
124-
- class: execute
125-
activity: *Activity5_label
126-
- class: concurrent
127-
actions:
128-
- class: execute
129-
activity: *Activity6_label
130-
- class: execute
131-
activity: *Activity7_label
132-
- class: execute
133-
activity: *Activity8_label
134-
135-
136-
To be done
137-
-----------
138-
When conclusion is reached, still to be done:
139-
140-
- schema (for sake of correct understanding in future)
141-
- additional docs for config fields/sections
68+
depends_on:
69+
- *Activity5_label

0 commit comments

Comments
 (0)