diff --git a/process.stop.md b/process.stop.md new file mode 100644 index 0000000..7d3ea43 --- /dev/null +++ b/process.stop.md @@ -0,0 +1,54 @@ +### Request +* **Description**: Instructs the supervisor daemon to stop a registered process. +* **Subscribers**: [ProcessHandler](https://github.com/avatao-content/baseimage-tutorial-framework/wiki/ProcessHandler) + +```json +{ + "key": "process.stop", + "intent": "control", + "scope": "zmq" +} +``` + +| Parameter | Type | Required | Description | +| ------------ |:--------:|:------------------:| --------------------------- | +| *name* | `string` | :heavy_check_mark: | Name of the process. | + +*** + +**Example**: +```json +{ + "key": "process.stop", + "name": "webservice" +} +``` + +### Response +* **Description**: Raises an event that contains an `error` field if the process exited with an error code, otherwise it's just the same as the original request. +* **Subscribers**: *(none)* + +```json +{ + "key": "process.stop", + "intent": "event", + "scope": "broadcast" +} +``` + +| Parameter | Type | Required | Description | +| ------------ |:--------:|:------------------:| --------------------------- | +| *name* | `string` | :heavy_check_mark: | Name of of the process. | +| *error* | `string` | | Error message from the supervisor daemon. | + +*** + +**Example**: +```json +{ + "key": "process.stop", + "intent": "event", + "scope": "broadcast", + "name": "webservice", +} +``` \ No newline at end of file