Skip to content

Commit 7990676

Browse files
author
alexey
committed
JE-27467 [CS docs] Events documentation - fixes after cr
1 parent cbd878f commit 7990676

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/reference/events.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Events
22

3-
Any action, available to be performed by means of API (including custom users’ scripts running), should be binded to some event, i.e. executed as a result of this event occurrence.
4-
Each event belongs to a particular entity. For example, the entry point for performing any actions with application is the application’s event onInstall.
5-
Subscription to the particular application’s lifecycle events (e.g. topology changes) can be done via [Environment Level Events](#environment-level-events).
6-
It’s also possible to bind the extension’s execution to the onUninstall event and in such a way implement the included to it custom logic of this extension removal from an environment.
3+
Any action, available to be performed by means of API (including custom users’ scripts running), should be bound to some event, i.e. executed as a result of this event occurrence.
4+
Each event belongs to a particular entity. For example, the entry point for performing any actions with application is the application’s event *onInstall*.
5+
Subscription to a particular application’s lifecycle events (e.g. topology changes) can be done via [Environment Level Events](#environment-level-events).
6+
It’s also possible to bind extension’s execution to the *onUninstall* event and, in such a way, implement the included to it custom logic of this extension removal from an environment.
77

88
## Application Level Events
99
```
@@ -90,7 +90,7 @@ It’s also possible to bind the extension’s execution to the onUninstall even
9090
}
9191
```
9292

93-
## Events params and responses placeholders
93+
## Events parameters and response placeholders
9494
### BeforeChangeTopology
9595
```
9696
{
@@ -1188,8 +1188,8 @@ Only for Docker®
11881188
```
11891189
## Events filtering
11901190

1191-
Events can be filtered by nodeGroup, nodeType, nodeId.
1192-
So defined actions will be executed only when events will be called on filter rules.
1191+
Events can be filtered by *nodeGroup*, *nodeType*, *nodeId*.
1192+
So defined actions will be executed only when called events match specified filter rules.
11931193

11941194
###By nodeGroup:
11951195
```
@@ -1227,4 +1227,5 @@ So defined actions will be executed only when events will be called on filter ru
12271227
}
12281228
}
12291229
```
1230-
- `number` - nodeId value
1230+
where
1231+
- `number` - *nodeId* value

0 commit comments

Comments
 (0)