From: Ulas Kozat <ulas.kozat@gmail.com>
Date: Wed, 1 Jun 2016 17:22:20 +0000 (-0700)
Subject: Update user guide
X-Git-Tag: colorado.1.0~46
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=c9eeadee671ada3b90c68e7318cf4cc5ef283fcc;p=domino.git

Update user guide

Change-Id: I65c93bc7ba443008597ebdd2bc3c64082a661c78
Signed-off-by: Ulas Kozat <ulas.kozat@gmail.com>

Update user guide

Change-Id: I7a6993154e30751076239900a859cb97f91cddbf
Signed-off-by: Ulas Kozat <ulas.kozat@gmail.com>
---

diff --git a/docs/userguide/api-documentation.rst b/docs/userguide/api-documentation.rst
index 041e2f4..b588dc9 100644
--- a/docs/userguide/api-documentation.rst
+++ b/docs/userguide/api-documentation.rst
@@ -1,7 +1,7 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-.. image:: ../etc/opnfv-logo.png 
+.. image:: ../etc/opnfv-logo.png
   :height: 40
   :width: 200
   :alt: OPNFV
@@ -14,21 +14,19 @@ Using domino-cli Client
 
 * heartbeat message
 
-Message fields:
+Command line input:
 
 .. code-block:: bash
-  struct HeartBeatMessage {
-   1: MessageType messageType = HEART_BEAT,
-   2: i64 domino_udid,
-   3: i64 seq_no  
-  }
 
-Command line:
+  ./domino-cli.py heartbeat
 
-.. code-block:: bash
+This message has the following fields that are automatically filled in.
 
-  ./domino-cli.py heartbeat
+.. code-block:: bash
 
+  Message Type (= HEART_BEAT)
+  UDID (= assigned during registration)
+  Sequence Number (=incremented after each RPC call)
 
 Interactive CLI mode
 ====================