Skip to content

Commit 1e702a0

Browse files
committed
docs: use sse instead of websocket for ruletest
1 parent d99dedf commit 1e702a0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/en_US/api/restapi/ruletest.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ follows:
1414
is `http://locahost:10081/test/myid` where `10081` is the port value returned in step 1, and myid is the id of the
1515
test rule.
1616
3. [Start the test rule](#start-the-test-rule), wait for the test rule to run. The rule running result will be returned
17-
through the WebSocket service.
18-
4. After the rule trial run ends, [delete the test rule](#delete-the-test-rule), and close the WebSocket service.
17+
through the SSE service.
18+
4. After the rule trial run ends, [delete the test rule](#delete-the-test-rule), and close the SSE service.
1919

2020
::: tip
2121

22-
The WebSocket service defaults to port 10081, which can be modified by the `httpServerPort` field in the `kuiper.yaml`
22+
The SSE service defaults to port 10081, which can be modified by the `httpServerPort` field in the `kuiper.yaml`
2323
configuration file. Before using the test rule, please make sure that this port is accessible.
2424

2525
:::
@@ -93,7 +93,7 @@ If created successfully, the return example is as follows:
9393
}
9494
```
9595

96-
After the rule is created successfully, the websocket endpoint starts. Users can listen to the websocket
96+
After the rule is created successfully, the SSE endpoint starts. Users can listen to the SSE
9797
address `http://locahost:10081/test/uuid` to get the result output. Among them, the port and id are the above return
9898
values.
9999

@@ -111,12 +111,12 @@ If creation fails, the status code is 400, return error information, an example
111111
POST /ruletest/{id}/start
112112
```
113113

114-
Start the trial run rule, WebSocket will be able to receive the data output after the rule runs.
114+
Start the trial run rule, SSE will be able to receive the data output after the rule runs.
115115

116116
## Delete the Test Rule
117117

118118
```shell
119119
DELETE /ruletest/{id}
120120
```
121121

122-
Delete the trial run rule, WebSocket will stop the service.
122+
Delete the trial run rule, SSE will stop the service.

0 commit comments

Comments
 (0)