Soft Patch Panel
 help / color / mirror / Atom feed
From: oda@valinux.co.jp
To: spp@dpdk.org
Subject: [spp] [PATCH v3 13/13] docs: add labels and captions for tables
Date: Fri,  5 Oct 2018 10:37:55 +0900	[thread overview]
Message-ID: <20181005013755.19838-14-oda@valinux.co.jp> (raw)
In-Reply-To: <20181005013755.19838-1-oda@valinux.co.jp>

From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>

For documentation, DPDK's documentation Guidelines[1] requires that
all of tables have labels and captions.

[1] https://doc.dpdk.org/guides/contributing/documentation.html

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Signed-off-by: Itsuro Oda <oda@valinux.co.jp>
---
 docs/guides/spp-ctl/api-reference.rst | 525 ++++++++++++++++----------
 1 file changed, 327 insertions(+), 198 deletions(-)

diff --git a/docs/guides/spp-ctl/api-reference.rst b/docs/guides/spp-ctl/api-reference.rst
index 3263934..23bc8db 100644
--- a/docs/guides/spp-ctl/api-reference.rst
+++ b/docs/guides/spp-ctl/api-reference.rst
@@ -30,15 +30,20 @@ Error code
 
 ``spp-ctl`` does basic syntax and lexical check of a request.
 
-+------+----------------------------------------------------------------+
-| Error| Description                                                    |
-+======+================================================================+
-| 400  | Syntax or lexical error, or SPP returns error for the request. |
-+------+----------------------------------------------------------------+
-| 404  | URL is not supported, or no SPP process of client-id in a URL. |
-+------+----------------------------------------------------------------+
-| 500  | System error occured in ``spp-ctl``.                           |
-+------+----------------------------------------------------------------+
+.. _table_spp_ctl_error_codes:
+
+.. table:: Error codes in spp-ctl.
+
+    +-------+----------------------------------------------------------------+
+    | Error | Description                                                    |
+    |       |                                                                |
+    +=======+================================================================+
+    | 400   | Syntax or lexical error, or SPP returns error for the request. |
+    +-------+----------------------------------------------------------------+
+    | 404   | URL is not supported, or no SPP process of client-id in a URL. |
+    +-------+----------------------------------------------------------------+
+    | 500   | System error occured in ``spp-ctl``.                           |
+    +-------+----------------------------------------------------------------+
 
 
 API independent of the process type
@@ -66,13 +71,18 @@ An array of process objects.
 
 process object:
 
-+-----------+---------+---------------------------------------------------------------+
-| Name      | Type    | Description                                                   |
-+===========+=========+===============================================================+
-| type      | string  | process type. one of ``primary``, ``vf`` or ``nfv``.          |
-+-----------+---------+---------------------------------------------------------------+
-| client-id | integer | client id. if type is ``primary`` this member does not exist. |
-+-----------+---------+---------------------------------------------------------------+
+.. _table_spp_ctl_processes:
+
+.. table:: Response params of getting processes info.
+
+    +-----------+---------+-----------------------------------------------------------------+
+    | Name      | Type    | Description                                                     |
+    |           |         |                                                                 |
+    +===========+=========+=================================================================+
+    | type      | string  | process type. one of ``primary``, ``nfv`` or ``vf``.            |
+    +-----------+---------+-----------------------------------------------------------------+
+    | client-id | integer | client id. if type is ``primary`` this member does not exist.   |
+    +-----------+---------+-----------------------------------------------------------------+
 
 Response example
 ^^^^^^^^^^^^^^^^
@@ -154,11 +164,16 @@ Get the information of the ``spp_nfv`` or ``spp_vm`` process.
 Request(path)
 ^^^^^^^^^^^^^
 
-+-----------+---------+-------------+
-| Name      | Type    | Description |
-+===========+=========+=============+
-| client_id | integer | client id.  |
-+-----------+---------+-------------+
+.. _table_spp_ctl_nfvs_get:
+
+.. table:: Request parameter for getting spp_nfv or spp_vm info.
+
+    +-----------+---------+-------------------------------------+
+    | Name      | Type    | Description                         |
+    |           |         |                                     |
+    +===========+=========+=====================================+
+    | client_id | integer | client id.                          |
+    +-----------+---------+-------------------------------------+
 
 Request example
 ^^^^^^^^^^^^^^^
@@ -171,27 +186,37 @@ Request example
 Response
 ^^^^^^^^
 
-+-----------+---------+-------------------------------------------+
-| Name      | Type    | Description                               |
-+===========+=========+===========================================+
-| client-id | integer | client id.                                |
-+-----------+---------+-------------------------------------------+
-| status    | string  | ``Running`` or ``Idle``.                  |
-+-----------+---------+-------------------------------------------+
-| ports     | array   | an array of port ids used by the process. |
-+-----------+---------+-------------------------------------------+
-| patches   | array   | an array of patches.                      |
-+-----------+---------+-------------------------------------------+
+.. _table_spp_ctl_spp_nfv_res:
+
+.. table:: Response params of getting spp_nfv or spp_vm info.
+
+    +-----------+---------+---------------------------------------------+
+    | Name      | Type    | Description                                 |
+    |           |         |                                             |
+    +===========+=========+=============================================+
+    | client-id | integer | client id.                                  |
+    +-----------+---------+---------------------------------------------+
+    | status    | string  | ``Running`` or ``Idle``.                    |
+    +-----------+---------+---------------------------------------------+
+    | ports     | array   | an array of port ids used by the process.   |
+    +-----------+---------+---------------------------------------------+
+    | patches   | array   | an array of patches.                        |
+    +-----------+---------+---------------------------------------------+
 
 patch objest
 
-+------+--------+----------------------+
-| Name | Type   | Description          |
-+======+========+======================+
-| src  | string | source port id.      |
-+------+--------+----------------------+
-| dst  | string | destination port id. |
-+------+--------+----------------------+
+.. _table_spp_ctl_patch_spp_nfv:
+
+.. table:: Attributes of patch of spp_nfv or spp_vm.
+
+    +------+--------+----------------------------------------------+
+    | Name | Type   | Description                                  |
+    |      |        |                                              |
+    +======+========+==============================================+
+    | src  | string | source port id.                              |
+    +------+--------+----------------------------------------------+
+    | dst  | string | destination port id.                         |
+    +------+--------+----------------------------------------------+
 
 Response example
 ^^^^^^^^^^^^^^^^
@@ -233,11 +258,16 @@ Start or Stop forwarding.
 Request(path)
 ^^^^^^^^^^^^^
 
-+-----------+---------+-------------+
-| Name      | Type    | Description |
-+===========+=========+=============+
-| client_id | integer | client id.  |
-+-----------+---------+-------------+
+.. _table_spp_ctl_spp_nfv_forward_get:
+
+.. table:: Request params of forward of spp_nfv or spp_vm.
+
+    +-----------+---------+---------------------------------+
+    | Name      | Type    | Description                     |
+    |           |         |                                 |
+    +===========+=========+=================================+
+    | client_id | integer | client id.                      |
+    +-----------+---------+---------------------------------+
 
 Request example
 ^^^^^^^^^^^^^^^
@@ -251,11 +281,16 @@ Request example
 Request(body)
 ^^^^^^^^^^^^^
 
-+--------+--------+------------------------+
-| Name   | Type   | Description            |
-+========+========+========================+
-| action | string | ``start`` or ``stop``. |
-+--------+--------+------------------------+
+.. _table_spp_ctl_spp_nfv_forward_get_body:
+
+.. table:: Request body params of forward of spp_nfv or spp_vm.
+
+    +--------+--------+-------------------------------------+
+    | Name   | Type   | Description                         |
+    |        |        |                                     |
+    +========+========+=====================================+
+    | action | string | ``start`` or ``stop``.              |
+    +--------+--------+-------------------------------------+
 
 Response
 ^^^^^^^^
@@ -289,22 +324,32 @@ Add or Delete port.
 Request(path)
 ^^^^^^^^^^^^^
 
-+-----------+---------+-------------+
-| Name      | Type    | Description |
-+===========+=========+=============+
-| client_id | integer | client id.  |
-+-----------+---------+-------------+
+.. _table_spp_ctl_spp_nfv_ports_get:
+
+.. table:: Request params of ports of spp_nfv or spp_vm.
+
+    +-----------+---------+--------------------------------+
+    | Name      | Type    | Description                    |
+    |           |         |                                |
+    +===========+=========+================================+
+    | client_id | integer | client id.                     |
+    +-----------+---------+--------------------------------+
 
 Request(body)
 ^^^^^^^^^^^^^
 
-+--------+--------+---------------------------------------------------------------+
-| Name   | Type   | Description                                                   |
-+========+========+===============================================================+
-| action | string | ``add`` or ``del``.                                           |
-+--------+--------+---------------------------------------------------------------+
-| port   | string | port id. port id is the form {interface_type}:{interface_id}. |
-+--------+--------+---------------------------------------------------------------+
+.. _table_spp_ctl_spp_nfv_ports_get_body:
+
+.. table:: Request body params of ports of spp_nfv or spp_vm.
+
+    +--------+--------+---------------------------------------------------------------+
+    | Name   | Type   | Description                                                   |
+    |        |        |                                                               |
+    +========+========+===============================================================+
+    | action | string | ``add`` or ``del``.                                           |
+    +--------+--------+---------------------------------------------------------------+
+    | port   | string | port id. port id is the form {interface_type}:{interface_id}. |
+    +--------+--------+---------------------------------------------------------------+
 
 Request example
 ^^^^^^^^^^^^^^^
@@ -339,22 +384,32 @@ Add a patch.
 Request(path)
 ^^^^^^^^^^^^^
 
-+-----------+---------+-------------+
-| Name      | Type    | Description |
-+===========+=========+=============+
-| client_id | integer | client id.  |
-+-----------+---------+-------------+
+.. _table_spp_ctl_spp_nfv_patches_get:
+
+.. table:: Request params of patches of spp_nfv or spp_vm.
+
+    +-----------+---------+---------------------------------+
+    | Name      | Type    | Description                     |
+    |           |         |                                 |
+    +===========+=========+=================================+
+    | client_id | integer | client id.                      |
+    +-----------+---------+---------------------------------+
 
 Request(body)
 ^^^^^^^^^^^^^
 
-+------+--------+----------------------+
-| Name | Type   | Description          |
-+======+========+======================+
-| src  | string | source port id.      |
-+------+--------+----------------------+
-| dst  | string | destination port id. |
-+------+--------+----------------------+
+.. _table_spp_ctl_spp_nfv_ports_patches_body:
+
+.. table:: Request body params of patches of spp_nfv or spp_vm.
+
+    +------+--------+------------------------------------+
+    | Name | Type   | Description                        |
+    |      |        |                                    |
+    +======+========+====================================+
+    | src  | string | source port id.                    |
+    +------+--------+------------------------------------+
+    | dst  | string | destination port id.               |
+    +------+--------+------------------------------------+
 
 Request example
 ^^^^^^^^^^^^^^^
@@ -389,11 +444,16 @@ Reset patches.
 Request(path)
 ^^^^^^^^^^^^^
 
-+-----------+---------+-------------+
-| Name      | Type    | Description |
-+===========+=========+=============+
-| client_id | integer | client id.  |
-+-----------+---------+-------------+
+.. _table_spp_ctl_spp_nfv_del_patches:
+
+.. table:: Request params of deleting patches of spp_nfv or spp_vm.
+
+    +-----------+---------+---------------------------------------+
+    | Name      | Type    | Description                           |
+    |           |         |                                       |
+    +===========+=========+=======================================+
+    | client_id | integer | client id.                            |
+    +-----------+---------+---------------------------------------+
 
 Request example
 ^^^^^^^^^^^^^^^
@@ -430,11 +490,16 @@ Get the information of the ``spp_vf`` process.
 Request(path)
 ^^^^^^^^^^^^^
 
-+-----------+---------+-------------+
-| Name      | Type    | Description |
-+===========+=========+=============+
-| client_id | integer | client id.  |
-+-----------+---------+-------------+
+.. _table_spp_ctl_vfs_get:
+
+.. table:: Request parameter for getting spp_vf.
+
+    +-----------+---------+--------------------------+
+    | Name      | Type    | Description              |
+    |           |         |                          |
+    +===========+=========+==========================+
+    | client_id | integer | client id.               |
+    +-----------+---------+--------------------------+
 
 Request example
 ^^^^^^^^^^^^^^^
@@ -447,67 +512,92 @@ Request example
 Response
 ^^^^^^^^
 
-+------------------+---------+-----------------------------------------------+
-| Name             | Type    | Description                                   |
-+==================+=========+===============================================+
-| client-id        | integer | client id.                                    |
-+------------------+---------+-----------------------------------------------+
-| ports            | array   | an array of port ids used by the process.     |
-+------------------+---------+-----------------------------------------------+
-| components       | array   | an array of component objects in the process. |
-+------------------+---------+-----------------------------------------------+
-| classifier_table | array   | an array of classifier tables in the process. |
-+------------------+---------+-----------------------------------------------+
+.. _table_spp_ctl_spp_vf_res:
+
+.. table:: Response params of getting spp_vf.
+
+    +------------------+---------+-----------------------------------------------+
+    | Name             | Type    | Description                                   |
+    |                  |         |                                               |
+    +==================+=========+===============================================+
+    | client-id        | integer | client id.                                    |
+    +------------------+---------+-----------------------------------------------+
+    | ports            | array   | an array of port ids used by the process.     |
+    +------------------+---------+-----------------------------------------------+
+    | components       | array   | an array of component objects in the process. |
+    +------------------+---------+-----------------------------------------------+
+    | classifier_table | array   | an array of classifier tables in the process. |
+    +------------------+---------+-----------------------------------------------+
 
 component object:
 
-+---------+---------+---------------------------------------------------------------------+
-| Name    | Type    | Description                                                         |
-+=========+=========+=====================================================================+
-| core    | integer | core id running on the component                                    |
-+---------+---------+---------------------------------------------------------------------+
-| name    | string  | an array of port ids used by the process.                           |
-+---------+---------+---------------------------------------------------------------------+
-| type    | string  | an array of component objects in the process.                       |
-+---------+---------+---------------------------------------------------------------------+
-| rx_port | array   | an array of port objects connected to the rx side of the component. |
-+---------+---------+---------------------------------------------------------------------+
-| tx_port | array   | an array of port objects connected to the tx side of the component. |
-+---------+---------+---------------------------------------------------------------------+
+.. _table_spp_ctl_spp_vf_res_comp:
+
+.. table:: Component objects of getting spp_vf.
+
+    +---------+---------+---------------------------------------------------------------------+
+    | Name    | Type    | Description                                                         |
+    |         |         |                                                                     |
+    +=========+=========+=====================================================================+
+    | core    | integer | core id running on the component                                    |
+    +---------+---------+---------------------------------------------------------------------+
+    | name    | string  | an array of port ids used by the process.                           |
+    +---------+---------+---------------------------------------------------------------------+
+    | type    | string  | an array of component objects in the process.                       |
+    +---------+---------+---------------------------------------------------------------------+
+    | rx_port | array   | an array of port objects connected to the rx side of the component. |
+    +---------+---------+---------------------------------------------------------------------+
+    | tx_port | array   | an array of port objects connected to the tx side of the component. |
+    +---------+---------+---------------------------------------------------------------------+
 
 port object:
 
-+---------+---------+---------------------------------------------------------------+
-| Name    | Type    | Description                                                   |
-+=========+=========+===============================================================+
-| port    | string  | port id. port id is the form {interface_type}:{interface_id}. |
-+---------+---------+---------------------------------------------------------------+
-| vlan    | object  | vlan operation which is applied to the port.                  |
-+---------+---------+---------------------------------------------------------------+
+.. _table_spp_ctl_spp_vf_res_port:
+
+.. table:: Port objects of getting spp_vf.
+
+    +---------+---------+---------------------------------------------------------------+
+    | Name    | Type    | Description                                                   |
+    |         |         |                                                               |
+    +=========+=========+===============================================================+
+    | port    | string  | port id. port id is the form {interface_type}:{interface_id}. |
+    +---------+---------+---------------------------------------------------------------+
+    | vlan    | object  | vlan operation which is applied to the port.                  |
+    +---------+---------+---------------------------------------------------------------+
 
 vlan object:
 
-+-----------+---------+-------------------------------+
-| Name      | Type    | Description                   |
-+===========+=========+===============================+
-| operation | string  | ``add``, ``del`` or ``none``. |
-+-----------+---------+-------------------------------+
-| id        | integer | vlan id.                      |
-+-----------+---------+-------------------------------+
-| pcp       | integer | vlan pcp.                     |
-+-----------+---------+-------------------------------+
+.. _table_spp_ctl_spp_vf_res_vlan:
+
+.. table:: Vlan objects of getting spp_vf.
+
+    +-----------+---------+-------------------------------+
+    | Name      | Type    | Description                   |
+    |           |         |                               |
+    +===========+=========+===============================+
+    | operation | string  | ``add``, ``del`` or ``none``. |
+    +-----------+---------+-------------------------------+
+    | id        | integer | vlan id.                      |
+    +-----------+---------+-------------------------------+
+    | pcp       | integer | vlan pcp.                     |
+    +-----------+---------+-------------------------------+
 
 classifier table:
 
-+-----------+--------+------------------------------------------------------------+
-| Name      | Type   | Description                                                |
-+===========+========+============================================================+
-| type      | string | ``mac`` or ``vlan``.                                       |
-+-----------+--------+------------------------------------------------------------+
-| value     | string | mac_address for ``mac``, vlan_id/mac_address for ``vlan``. |
-+-----------+--------+------------------------------------------------------------+
-| port      | string | port id applied to classify.                               |
-+-----------+--------+------------------------------------------------------------+
+.. _table_spp_ctl_spp_vf_res_vlan:
+
+.. table:: Vlan objects of getting spp_vf.
+
+    +-----------+--------+------------------------------------------------------------+
+    | Name      | Type   | Description                                                |
+    |           |        |                                                            |
+    +===========+========+============================================================+
+    | type      | string | ``mac`` or ``vlan``.                                       |
+    +-----------+--------+------------------------------------------------------------+
+    | value     | string | mac_address for ``mac``, vlan_id/mac_address for ``vlan``. |
+    +-----------+--------+------------------------------------------------------------+
+    | port      | string | port id applied to classify.                               |
+    +-----------+--------+------------------------------------------------------------+
 
 Response example
 ^^^^^^^^^^^^^^^^
@@ -635,25 +725,34 @@ Start the component.
 Request(path)
 ^^^^^^^^^^^^^
 
-+-----------+---------+-------------+
-| Name      | Type    | Description |
-+===========+=========+=============+
-| client_id | integer | client id.  |
-+-----------+---------+-------------+
+.. _table_spp_ctl_spp_vf_components:
+
+.. table:: Request params of components of spp_vf.
+
+    +-----------+---------+-------------+
+    | Name      | Type    | Description |
+    +===========+=========+=============+
+    | client_id | integer | client id.  |
+    +-----------+---------+-------------+
 
 
 Request(body)
 ^^^^^^^^^^^^^
 
-+-----------+---------+----------------------------------------------------------------------+
-| Name      | Type    | Description                                                          |
-+===========+=========+======================================================================+
-| name      | string  | component name. must be unique in the process.                       |
-+-----------+---------+----------------------------------------------------------------------+
-| core      | integer | core id.                                                             |
-+-----------+---------+----------------------------------------------------------------------+
-| type      | string  | component type. one of ``forward``, ``merge`` or ``classifier_mac``. |
-+-----------+---------+----------------------------------------------------------------------+
+.. _table_spp_ctl_spp_vf_components_res:
+
+.. table:: Response params of components of spp_vf.
+
+    +-----------+---------+----------------------------------------------------------------------+
+    | Name      | Type    | Description                                                          |
+    |           |         |                                                                      |
+    +===========+=========+======================================================================+
+    | name      | string  | component name. must be unique in the process.                       |
+    +-----------+---------+----------------------------------------------------------------------+
+    | core      | integer | core id.                                                             |
+    +-----------+---------+----------------------------------------------------------------------+
+    | type      | string  | component type. one of ``forward``, ``merge`` or ``classifier_mac``. |
+    +-----------+---------+----------------------------------------------------------------------+
 
 Request example
 ^^^^^^^^^^^^^^^
@@ -688,13 +787,18 @@ Stop the component.
 Request(path)
 ^^^^^^^^^^^^^
 
-+-----------+---------+-----------------+
-| Name      | Type    | Description     |
-+===========+=========+=================+
-| client_id | integer | client id.      |
-+-----------+---------+-----------------+
-| name      | string  | component name. |
-+-----------+---------+-----------------+
+.. _table_spp_ctl_spp_vf_del:
+
+.. table:: Request params of deleting component of spp_vf.
+
+    +-----------+---------+---------------------------------+
+    | Name      | Type    | Description                     |
+    |           |         |                                 |
+    +===========+=========+=================================+
+    | client_id | integer | client id.                      |
+    +-----------+---------+---------------------------------+
+    | name      | string  | component name.                 |
+    +-----------+---------+---------------------------------+
 
 Request example
 ^^^^^^^^^^^^^^^
@@ -728,40 +832,55 @@ Add or Delete port to the component.
 Request(path)
 ^^^^^^^^^^^^^
 
-+-----------+---------+-----------------+
-| Name      | Type    | Description     |
-+===========+=========+=================+
-| client_id | integer | client id.      |
-+-----------+---------+-----------------+
-| name      | string  | component name. |
-+-----------+---------+-----------------+
+.. _table_spp_ctl_spp_vf_comp_port:
+
+.. table:: Request params for ports of component of spp_vf.
+
+    +-----------+---------+---------------------------+
+    | Name      | Type    | Description               |
+    |           |         |                           |
+    +===========+=========+===========================+
+    | client_id | integer | client id.                |
+    +-----------+---------+---------------------------+
+    | name      | string  | component name.           |
+    +-----------+---------+---------------------------+
 
 Request(body)
 ^^^^^^^^^^^^^
 
-+---------+---------+-----------------------------------------------------------------+
-| Name    | Type    | Description                                                     |
-+=========+=========+=================================================================+
-| action  | string  | ``attach`` or ``detach``.                                       |
-+---------+---------+-----------------------------------------------------------------+
-| port    | string  | port id. port id is the form {interface_type}:{interface_id}.   |
-+---------+---------+-----------------------------------------------------------------+
-| dir     | string  | ``rx`` or ``tx``.                                               |
-+---------+---------+-----------------------------------------------------------------+
-| vlan    | object  | vlan operation which is applied to the port. it can be omitted. |
-+---------+---------+-----------------------------------------------------------------+
+.. _table_spp_ctl_spp_vf_comp_port_body:
+
+.. table:: Request body params for ports of component of spp_vf.
+
+    +---------+---------+-----------------------------------------------------------------+
+    | Name    | Type    | Description                                                     |
+    |         |         |                                                                 |
+    +=========+=========+=================================================================+
+    | action  | string  | ``attach`` or ``detach``.                                       |
+    +---------+---------+-----------------------------------------------------------------+
+    | port    | string  | port id. port id is the form {interface_type}:{interface_id}.   |
+    +---------+---------+-----------------------------------------------------------------+
+    | dir     | string  | ``rx`` or ``tx``.                                               |
+    +---------+---------+-----------------------------------------------------------------+
+    | vlan    | object  | vlan operation which is applied to the port. it can be omitted. |
+    +---------+---------+-----------------------------------------------------------------+
 
 vlan object:
 
-+-----------+---------+----------------------------------------------------------+
-| Name      | Type    | Description                                              |
-+===========+=========+==========================================================+
-| operation | string  | ``add``, ``del`` or ``none``.                            |
-+-----------+---------+----------------------------------------------------------+
-| id        | integer | vlan id. ignored when operation is ``del`` or ``none``.  |
-+-----------+---------+----------------------------------------------------------+
-| pcp       | integer | vlan pcp. ignored when operation is ``del`` or ``none``. |
-+-----------+---------+----------------------------------------------------------+
+.. _table_spp_ctl_spp_vf_comp_port_body_vlan:
+
+.. table:: Request body params for vlan ports of component of spp_vf.
+
+    +-----------+---------+----------------------------------------------------------+
+    | Name      | Type    | Description                                              |
+    |           |         |                                                          |
+    +===========+=========+==========================================================+
+    | operation | string  | ``add``, ``del`` or ``none``.                            |
+    +-----------+---------+----------------------------------------------------------+
+    | id        | integer | vlan id. ignored when operation is ``del`` or ``none``.  |
+    +-----------+---------+----------------------------------------------------------+
+    | pcp       | integer | vlan pcp. ignored when operation is ``del`` or ``none``. |
+    +-----------+---------+----------------------------------------------------------+
 
 Request example
 ^^^^^^^^^^^^^^^
@@ -811,28 +930,38 @@ Set or Unset classifier table.
 Request(path)
 ^^^^^^^^^^^^^
 
-+-----------+---------+-------------+
-| Name      | Type    | Description |
-+===========+=========+=============+
-| client_id | integer | client id.  |
-+-----------+---------+-------------+
+.. _table_spp_ctl_spp_vf_cls_table:
+
+.. table:: Request params for classifier_table of spp_vf.
+
+    +-----------+---------+---------------------------+
+    | Name      | Type    | Description               |
+    |           |         |                           |
+    +===========+=========+===========================+
+    | client_id | integer | client id.                |
+    +-----------+---------+---------------------------+
 
 Request(body)
 ^^^^^^^^^^^^^
 
-+-------------+-----------------+----------------------------------------------------+
-| Name        | Type            | Description                                        |
-+=============+=================+====================================================+
-| action      | string          | ``add`` or ``del``.                                |
-+-------------+-----------------+----------------------------------------------------+
-| type        | string          | ``mac`` or ``vlan``.                               |
-+-------------+-----------------+----------------------------------------------------+
-| vlan        | integer or null | vlan id for ``vlan``. null or omitted for ``mac``. |
-+-------------+-----------------+----------------------------------------------------+
-| mac_address | string          | mac address.                                       |
-+-------------+-----------------+----------------------------------------------------+
-| port        | string          | port id.                                           |
-+-------------+-----------------+----------------------------------------------------+
+.. _table_spp_ctl_spp_vf_cls_table_body:
+
+.. table:: Request body params for classifier_table of spp_vf.
+
+    +-------------+-----------------+----------------------------------------------------+
+    | Name        | Type            | Description                                        |
+    |             |                 |                                                    |
+    +=============+=================+====================================================+
+    | action      | string          | ``add`` or ``del``.                                |
+    +-------------+-----------------+----------------------------------------------------+
+    | type        | string          | ``mac`` or ``vlan``.                               |
+    +-------------+-----------------+----------------------------------------------------+
+    | vlan        | integer or null | vlan id for ``vlan``. null or omitted for ``mac``. |
+    +-------------+-----------------+----------------------------------------------------+
+    | mac_address | string          | mac address.                                       |
+    +-------------+-----------------+----------------------------------------------------+
+    | port        | string          | port id.                                           |
+    +-------------+-----------------+----------------------------------------------------+
 
 Request example
 ^^^^^^^^^^^^^^^
-- 
2.17.1

  parent reply	other threads:[~2018-10-05  1:37 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-12 23:25 [spp] [PATCH] spp-ctl: SPP controller with Web API Itsuro ODA
2018-09-18 10:00 ` Yasufumi Ogawa
2018-09-18 21:40   ` Itsuro ODA
2018-10-05  1:37 ` [spp] [PATCH v3 00/13] " oda
2018-10-05  1:37   ` [spp] [PATCH v3 01/13] docs: add overview of spp-ctl oda
2018-10-05  1:37   ` [spp] [PATCH v3 02/13] docs: add API reference " oda
2018-10-05  1:37   ` [spp] [PATCH v3 03/13] docs: add index " oda
2018-10-05  1:37   ` [spp] [PATCH v3 04/13] project: add requirements.txt for spp-ctl oda
2018-10-05  1:37   ` [spp] [PATCH v3 05/13] docs: add spp-ctl to index of doc root oda
2018-10-05  1:37   ` [spp] [PATCH v3 06/13] spp-ctl: add entry point oda
2018-10-05  1:37   ` [spp] [PATCH v3 07/13] spp-ctl: add Controller class oda
2018-10-05  1:37   ` [spp] [PATCH v3 08/13] spp-ctl: add web API handler oda
2018-10-05  1:37   ` [spp] [PATCH v3 09/13] spp-ctl: add spp command interfaces oda
2018-10-05  1:37   ` [spp] [PATCH v3 10/13] spp-ctl: update parsing spp_nfv status oda
2018-10-05  1:37   ` [spp] [PATCH v3 11/13] docs: add request examples of spp-ctl oda
2018-10-05  1:37   ` [spp] [PATCH v3 12/13] docs: correct directives " oda
2018-10-05  1:37   ` oda [this message]
2018-10-05  3:57 ` [spp] [PATCH v4 00/14] spp-ctl: SPP controller with Web API oda
2018-10-05  3:57   ` [spp] [PATCH v4 01/14] docs: add overview of spp-ctl oda
2018-10-05  3:57   ` [spp] [PATCH v4 02/14] docs: add API reference " oda
2018-10-05  3:57   ` [spp] [PATCH v4 03/14] docs: add index " oda
2018-10-05  3:57   ` [spp] [PATCH v4 04/14] project: add requirements.txt for spp-ctl oda
2018-10-05  3:57   ` [spp] [PATCH v4 05/14] docs: add spp-ctl to index of doc root oda
2018-10-05  3:57   ` [spp] [PATCH v4 06/14] spp-ctl: add entry point oda
2018-10-05  3:57   ` [spp] [PATCH v4 07/14] spp-ctl: add Controller class oda
2018-10-05  3:57   ` [spp] [PATCH v4 08/14] spp-ctl: add web API handler oda
2018-10-05  3:57   ` [spp] [PATCH v4 09/14] spp-ctl: add spp command interfaces oda
2018-10-05  3:57   ` [spp] [PATCH v4 10/14] spp-ctl: update parsing spp_nfv status oda
2018-10-05  3:57   ` [spp] [PATCH v4 11/14] docs: add request examples of spp-ctl oda
2018-10-05  3:57   ` [spp] [PATCH v4 12/14] docs: correct directives " oda
2018-10-05  3:57   ` [spp] [PATCH v4 13/14] docs: add labels and captions for tables oda
2018-10-05  3:57   ` [spp] [PATCH v4 14/14] spp-ctl: fix incorrect URL oda
2018-10-09  2:01   ` [spp] [PATCH v4 00/14] spp-ctl: SPP controller with Web API Yasufumi Ogawa

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20181005013755.19838-14-oda@valinux.co.jp \
    --to=oda@valinux.co.jp \
    --cc=spp@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).