Skip to content

Commit 62d1470

Browse files
Add rules endpoint to documentation (#302)
* Add rules endpoint to documentation
1 parent d2b4137 commit 62d1470

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

src/main/java/com/ericsson/ei/controller/RuleController.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212

1313
/**
14-
* This class is used for anything rules related. It's currently used to test rules on eiffel events and to fetch the active rules file content. Test rules must be enabled in Eiffel Intelligence for the /rule-check endpoints to work.
14+
* This class is used for anything rules related. It's currently used to test rules on Eiffel events and to fetch the active rules file content. Test rules must be enabled in Eiffel Intelligence for the /rule-check endpoints to work.
1515
* (Generated with springmvc-raml-parser v.2.0.4)
1616
*
1717
*/
@@ -22,7 +22,7 @@ public interface RuleController {
2222

2323

2424
/**
25-
* This method returns the active rules file content.
25+
* This method returns the active rules content.
2626
*
2727
*/
2828
@RequestMapping(value = "", method = RequestMethod.GET)

wiki/markdown/running-rules-on-objects.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
# Running Rules On Objects
22

3-
|Method|Endpoint |
4-
|------|---------------------|
5-
|POST |/rules/rule-check|
6-
|POST | /rules/rule-check/aggregation|
7-
|GET | /rules/rule-check/testRulePageEnabled |
8-
3+
|Method|Endpoint |
4+
|------|---------------------------------------|
5+
|GET | /rules |
6+
|POST | /rules/rule-check |
7+
|POST | /rules/rule-check/aggregation |
8+
|GET | /rules/rule-check/testRulePageEnabled |
9+
10+
## Checking the active rules in your backend instance
11+
12+
You can fetch the rules content from the backend to see what rules Eiffel Intelligence is currently using.
13+
This can give you an idea on how to write your own rules or could be saved and used
14+
in the /rules/rule-check endpoints to test the current rules against your events.
15+
16+
curl -X GET http://<host>:8090/rules
17+
18+
## Testing rules and events in Eiffel Intelligence
919

1020
Before deploying a new instance of Eiffel Intelligence it is good to test the
1121
desired rules that they give the desired outcome. Therefore it is possible to

0 commit comments

Comments
 (0)