[spp] [PATCH 2/3] docs: add REST API for pipe PMD

[Itsuro Oda]

This patch adds description about REST API for pipe PMD.

Signed-off-by: Itsuro Oda <oda at valinux.co.jp>
---
 docs/guides/api_ref/spp_primary.rst | 54 ++++++++++++++++++++++++-----
 1 file changed, 46 insertions(+), 8 deletions(-)

diff --git a/docs/guides/api_ref/spp_primary.rst b/docs/guides/api_ref/spp_primary.rst
index fbf8874..28596cb 100644
--- a/docs/guides/api_ref/spp_primary.rst
+++ b/docs/guides/api_ref/spp_primary.rst
@@ -41,6 +41,8 @@ Response
     +------------+-------+----------------------------------------+
     | ring_ports | array | Array of statistics of ring ports.     |
     +------------+-------+----------------------------------------+
+    | pipes      | array | Array of pipe ports.                   |
+    +------------+-------+----------------------------------------+
 
 Physical port object.
 
@@ -84,6 +86,23 @@ Ring port object.
     | tx_drop | integer | The total number of dropped packets of transferred. |
     +---------+---------+-----------------------------------------------------+
 
+Pipe port object.
+
+.. _table_spp_ctl_primary_status_pipe:
+
+.. table:: Attributes of pipe port of primary status.
+
+    +---------+---------+-----------------------------------------------------+
+    | Name    | Type    | Description                                         |
+    |         |         |                                                     |
+    +=========+=========+=====================================================+
+    | id      | integer | Port ID of the pipe port.                           |
+    +---------+---------+-----------------------------------------------------+
+    | rx      | integer | Port ID of the ring port for rx.                    |
+    +---------+---------+-----------------------------------------------------+
+    | tx      | integer | Port ID of the ring port for tx.                    |
+    +---------+---------+-----------------------------------------------------+
+
 
 Response example
 ~~~~~~~~~~~~~~~~
@@ -132,6 +151,13 @@ Response example
           "tx": 0,
           "tx_drop": 0
         }
+      ],
+      "pipes": [
+        {
+          "id": 0,
+          "rx": 0,
+          "tx": 1
+        }
       ]
     }
 
@@ -192,14 +218,18 @@ Request (body)
 
 .. table:: Request body params of ports of ``spp_primary``.
 
-    +--------+--------+--------------------------------------------------+
-    | Name   | Type   | Description                                      |
-    |        |        |                                                  |
-    +========+========+==================================================+
-    | action | string | ``add`` or ``del``.                              |
-    +--------+--------+--------------------------------------------------+
-    | port   | string | Resource UID of {port_type}:{port_id}.           |
-    +--------+--------+--------------------------------------------------+
+    +--------+--------+---------------------------------------------------------+
+    | Name   | Type   | Description                                             |
+    |        |        |                                                         |
+    +========+========+=========================================================+
+    | action | string | ``add`` or ``del``.                                     |
+    +--------+--------+---------------------------------------------------------+
+    | port   | string | Resource UID of {port_type}:{port_id}.                  |
+    +--------+--------+---------------------------------------------------------+
+    | rx     | string | Rx ring for pipe. It is necessary for adding pipe only. |
+    +--------+--------+---------------------------------------------------------+
+    | tx     | string | Tx ring for pipe. It is necessary for adding pipe only. |
+    +--------+--------+---------------------------------------------------------+
 
 
 Request example
@@ -211,6 +241,14 @@ Request example
       -d '{"action": "add", "port": "ring:0"}' \
       http://127.0.0.1:7777/v1/primary/ports
 
+For adding pipe.
+
+.. code-block:: console
+
+    $ curl -X PUT -H 'application/json' \
+      -d '{"action": "add", "port": "pipe:0", \
+      "rx": "ring:0", "tx": "ring:1"}' \
+      http://127.0.0.1:7777/v1/primary/ports
 
 Response
 ~~~~~~~~
-- 
2.17.0