aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorUlas Kozat <ulas.kozat@gmail.com>2016-06-01 10:22:20 -0700
committerUlas Kozat <ulas.kozat@gmail.com>2016-06-01 10:36:30 -0700
commitc9eeadee671ada3b90c68e7318cf4cc5ef283fcc (patch)
treef85fd534078925280afde13235378f4375a97861
parentd813578b665de38a89383befd8702c81bb043fce (diff)
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>
-rw-r--r--docs/userguide/api-documentation.rst18
1 files changed, 8 insertions, 10 deletions
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
====================