docs: add API documentation for /flows/state

- Add description for  HTTP GET `/flows/state`
- Add description for HTTP POST `/flows/state`
- Add index pages to the methods table for rendering

Signed-off-by: Shantanoo 'Shan' Desai <[email protected]>

Author: shantanoo-desai

docs/api/admin/methods/get/flows/state/index.md

@@ -0,0 +1,39 @@
+---
+layout: docs-api
+toc: toc-api-admin.html
+title: GET /flows/state
+slug:
+  - url: "/docs/api/admin"
+    label: "admin"
+  - url: "/docs/api/admin/methods"
+    label: "methods"
+  - get flows state
+---
+
+Get the current runtime state of flows. Note that runtime state of flows is available only if
+`runtimeState` value is set to `enabled: true` in the `settings.js` file.
+
+### Headers
+
+Header | Value
+-------|-------
+`Authorization` | `Bearer [token]` - if authentication is enabled
+
+### Response
+
+Status Code | Reason         | Response
+------------|----------------|--------------
+`200`       | Success        | See example response body
+`401`       | Not authorized | _none_
+
+{% highlight json %}
+{
+    "state": "stop"
+}
+{% endhighlight %}
+
+The response object contains the following fields:
+
+Field          | Description
+---------------|------------
+`state`        | runtime state of the flows. Can be either `start` or `stop`

docs/api/admin/methods/index.md

@@ -15,9 +15,11 @@ slug:
 [<span class="method">POST</span>/auth/token](post/auth/token)             | Exchange credentials for access token
 [<span class="method">POST</span>/auth/revoke](post/auth/revoke)           | Revoke an access token
 [<span class="method">GET</span>/settings](get/settings)                   | Get the runtime settings
-[<span class="method">GET</span>/diagnostics](get/diagnostics)                   | Get the runtime diagnostics
+[<span class="method">GET</span>/diagnostics](get/diagnostics)             | Get the runtime diagnostics
 [<span class="method">GET</span>/flows](get/flows)                         | Get the active flow configuration
+[<span class="method">GET</span>/flows/state](get/flows/state)             | Get the active flow's runtime state
 [<span class="method">POST</span>/flows](post/flows)                       | Set the active flow configuration
+[<span class="method">POST</span>/flows/state](post/flows/state)           | Set the active flow's runtime state
 [<span class="method">POST</span>/flow](post/flow)                         | Add a flow to the active configuration
 [<span class="method">GET</span>/flow/:id](get/flow)                       | Get an individual flow configuration
 [<span class="method">PUT</span>/flow/:id](put/flow)                       | Update an individual flow configuration

docs/api/admin/methods/post/flows/state/index.md

@@ -0,0 +1,51 @@
+---
+layout: docs-api
+toc: toc-api-admin.html
+title: POST /flows/state
+slug:
+  - url: "/docs/api/admin"
+    label: "admin"
+  - url: "/docs/api/admin/methods"
+    label: "methods"
+  - set flows state
+---
+
+Set the runtime state of flows. Note that runtime state of flows is available only if
+`runtimeState` value is set to `enabled: true` in the `settings.js` file.
+
+Requires permission: <code>flows.write</code>
+
+### Headers
+
+Header | Value
+-------|-------
+`Authorization` | `Bearer [token]` - if authentication is enabled
+
+
+### Arguments
+
+The request body must be a URL-Encoded parameter with the following field:
+
+
+Field        | Description
+-------------|------------------------
+`state`      | Required runtime state of the flow. Can be either `start` or `stop` 
+
+### Response
+
+Status Code | Reason         | Response
+------------|----------------|--------------
+`200`       | Success        | See example response body
+`401`       | Not authorized | _none_
+
+{% highlight json %}
+{
+    "state": "stop"
+}
+{% endhighlight %}
+
+The response object contains the following fields:
+
+Field          | Description
+---------------|------------
+`state`        | runtime state of the flows. Can be either `start` or `stop`