RS: Add fields and descriptions returned by /v1/actions to REST API reference (#1257)

* DOC-4920 RS: Add fields and descriptions returned by /v1/actions to REST API reference

* DOC-4920 Added more details about pending_ops structure and fields

* Added missing commas to JSON example

* DOC-4920 Fixed pending_ops heartbeat and last_sample_time descriptions in action REST API reference

Author: rrelledge

content/operate/rs/references/rest-api/requests/actions/_index.md

@@ -23,7 +23,7 @@ weight: $weight
 GET /v1/actions
 ```
 
-Get the status of all actions (executing, queued, or completed) on all entities (clusters, nodes, and databases). This API tracks long-lived API requests that return either a `task_id` or an `action_uid`.
+Get the status of all running, pending, or completed actions on all clusters, nodes, and databases. This API tracks long-lived API requests that return either a `task_id` or an `action_uid`.
 
 #### Required permissions
 
@@ -41,7 +41,18 @@ GET /v1/actions
 
 ### Response {#get-all-response}
 
-Returns a JSON array of [action objects]({{< relref "/operate/rs/references/rest-api/objects/action" >}}) and an array of [state-machine objects]({{< relref "/operate/rs/references/rest-api/objects/state-machine" >}}).
+Returns a JSON array of [action objects]({{< relref "/operate/rs/references/rest-api/objects/action" >}}), which represent tasks, and an array of [state-machine objects]({{< relref "/operate/rs/references/rest-api/objects/state-machine" >}}).
+
+| Field | Type/Value | Description |
+|-------|------------|-------------|
+| action_uid | string | The action's globally unique identifier |
+| name | string | Name of the running or failed state machine |
+| progress | float (range: 0-100) | Percent of completed steps for the action |
+| status | "pending"<br />"active"<br />"completed"<br />"failed" | The action's status |
+| node_uid | string | UID of the node where the operation runs (optional) |
+| object_name | string | The object that the action runs on (optional) |
+| state | string | The current state of the state machine (optional)  |
+| pending_ops | JSON object | List of operations that are waiting to run (optional)<br />{{<code>}}"pending_ops": {<br />  "3": {<br />    "heartbeat": integer,<br />    "snapshot": { ... },<br />    "last_sample_time": integer,<br />    "op_name": string,<br />    "status_code": string,<br />    "status_description": string,<br />    "progress": float<br />  }<br />}{{</code>}}<br />`pending_ops` is a map where the key is the `shard_id`, and the value is a map that can include the following optional fields:<br />**heartbeat**: The time, in seconds since the Unix epoch, since the last change in the progress of the operation.<br />**snapshot**: A map of properties stored by the operation that are needed to run.<br />**last_sample_time**: The time, in seconds since the Unix epoch, when the last snapshot of the operation was taken.<br />**op_name**: The name of the operation from the state machine that is running.<br />**status_code**: The code for the operation's current status.<br />**status_description**: The operation's current status.<br />**progress**: The operation's progress in percentage (1 to 100). |
 
 Regardless of an action’s source, each action in the response contains the following attributes: `name`, `action_uid`, `status`, and `progress`.
 
@@ -93,7 +104,7 @@ Regardless of an action’s source, each action in the response contains the fol
 GET /v1/actions/{uid}
 ```
 
-Get the status of a currently executing, queued, or completed action.
+Get the status of a specific action.
 
 #### Required permissions
 
@@ -119,6 +130,17 @@ GET /v1/actions/{uid}
 
 Returns an [action object]({{< relref "/operate/rs/references/rest-api/objects/action" >}}).
 
+| Field | Type/Value | Description |
+|-------|------------|-------------|
+| action_uid | string | The action's globally unique identifier |
+| name | string | Name of the running or failed state machine |
+| progress | float (range: 0-100) | Percent of completed steps for the action |
+| status | "pending"<br />"active"<br />"completed"<br />"failed" | The action's status |
+| node_uid | string | UID of the node where the operation runs (optional) |
+| object_name | string | The object that the action runs on (optional) |
+| state | string | The current state of the state machine (optional)  |
+| pending_ops | JSON object | List of operations that are waiting to run (optional)<br />{{<code>}}"pending_ops": {<br />  "3": {<br />    "heartbeat": integer,<br />    "snapshot": { ... },<br />    "last_sample_time": integer,<br />    "op_name": string,<br />    "status_code": string,<br />    "status_description": string,<br />    "progress": float<br />  }<br />}{{</code>}}<br />`pending_ops` is a map where the key is the `shard_id`, and the value is a map that can include the following optional fields:<br />**heartbeat**: The time, in seconds since the Unix epoch, since the last change in the progress of the operation.<br />**snapshot**: A map of properties stored by the operation that are needed to run.<br />**last_sample_time**: The time, in seconds since the Unix epoch, when the last snapshot of the operation was taken.<br />**op_name**: The name of the operation from the state machine that is running.<br />**status_code**: The code for the operation's current status.<br />**status_description**: The operation's current status.<br />**progress**: The operation's progress in percentage (1 to 100). |
+
 Regardless of an action’s source, each action contains the following attributes: `name`, `action_uid`, `status`, and `progress`.
 
 #### Example JSON body