From a14fec3e184629428810cc85223a8b38ec12ea32 Mon Sep 17 00:00:00 2001
From: ni-richard <ni-richard@protonmail.ch>
Date: Thu, 12 Sep 2019 11:32:10 +0200
Subject: [PATCH] Created deploy.finish (markdown)

---
 deploy.finish.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 deploy.finish.md

diff --git a/deploy.finish.md b/deploy.finish.md
new file mode 100644
index 0000000..12707f8
--- /dev/null
+++ b/deploy.finish.md
@@ -0,0 +1,24 @@
+* **Description**: The default action to [deploy.start](https://github.com/avatao-content/baseimage-tutorial-framework/wiki/deploy.start) is to restart a service and deployment is considered successful when the process stays alive or exits with an expected status code.
+* **Subscribers**: [DeployHandler](https://github.com/avatao-content/baseimage-tutorial-framework/wiki/DeployHandler)
+
+```json
+{
+    "key": "deploy.finish",
+    "scope": "websocket"
+}
+```
+
+| Parameter    | Type     | Required           | Description                 |
+| ------------ |:--------:|:------------------:| --------------------------- |
+| *error* | `string` | | The presence of this field determines the deployment's status. When omitted, it is considered successful, otherwise you can state the reason of the failure here. By default, this is the message returned by the supervisor daemon. |
+
+***
+
+**Example**:
+```json
+{
+    "key": "deploy.finish",
+    "scope": "websocket",
+    "error": "Syntax error."
+}
+```
\ No newline at end of file