From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama50.ecl.ntt.co.jp (tama50.ecl.ntt.co.jp [129.60.39.147]) by dpdk.org (Postfix) with ESMTP id CDEBA293B for ; Thu, 17 Jan 2019 03:49:00 +0100 (CET) Received: from vc1.ecl.ntt.co.jp (vc1.ecl.ntt.co.jp [129.60.86.153]) by tama50.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id x0H2mxPw009720; Thu, 17 Jan 2019 11:48:59 +0900 Received: from vc1.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id ED658EA7939; Thu, 17 Jan 2019 11:48:58 +0900 (JST) Received: from localhost.localdomain (lobster.nslab.ecl.ntt.co.jp [129.60.13.95]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id DFBE2EA77BE; Thu, 17 Jan 2019 11:48:58 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, spp@dpdk.org, ogawa.yasufumi@lab.ntt.co.jp Date: Thu, 17 Jan 2019 11:46:40 +0900 Message-Id: <1547693205-17710-3-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1547693205-17710-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> References: <1547693205-17710-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-TM-AS-MML: disable Subject: [spp] [PATCH 2/7] docs: remove spp_vm from spp-ctl API X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 17 Jan 2019 02:49:01 -0000 From: Yasufumi Ogawa Remove spp_vm from spp-ctl REST API reference. Signed-off-by: Yasufumi Ogawa --- docs/guides/api_ref/spp-ctl.rst | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/guides/api_ref/spp-ctl.rst b/docs/guides/api_ref/spp-ctl.rst index 237f91e..7502360 100644 --- a/docs/guides/api_ref/spp-ctl.rst +++ b/docs/guides/api_ref/spp-ctl.rst @@ -285,13 +285,13 @@ Response There is no body content for the response of a successful ``DELETE`` request. -API for spp_nfv/spp_vm ----------------------- +API for spp_nfv +--------------- GET /v1/nfvs/{client_id} ~~~~~~~~~~~~~~~~~~~~~~~~ -Get the information of the ``spp_nfv`` or ``spp_vm`` process. +Get the information of ``spp_nfv``. * Normal response codes: 200 * Error response codes: 400, 404 @@ -301,7 +301,7 @@ Request(path) .. _table_spp_ctl_nfvs_get: -.. table:: Request parameter for getting spp_nfv or spp_vm info. +.. table:: Request parameter for getting info of ``spp_nfv``. +-----------+---------+-------------------------------------+ | Name | Type | Description | @@ -323,7 +323,7 @@ Response .. _table_spp_ctl_spp_nfv_res: -.. table:: Response params of getting spp_nfv or spp_vm info. +.. table:: Response params of getting info of ``spp_nfv``. +-----------+---------+---------------------------------------------+ | Name | Type | Description | @@ -342,7 +342,7 @@ patch objest .. _table_spp_ctl_patch_spp_nfv: -.. table:: Attributes of patch of spp_nfv or spp_vm. +.. table:: Attributes of patch command of ``spp_nfv``. +------+--------+----------------------------------------------+ | Name | Type | Description | @@ -395,7 +395,7 @@ Request(path) .. _table_spp_ctl_spp_nfv_forward_get: -.. table:: Request params of forward of spp_nfv or spp_vm. +.. table:: Request params of forward command of ``spp_nfv``. +-----------+---------+---------------------------------+ | Name | Type | Description | @@ -418,7 +418,7 @@ Request(body) .. _table_spp_ctl_spp_nfv_forward_get_body: -.. table:: Request body params of forward of spp_nfv or spp_vm. +.. table:: Request body params of forward of ``spp_nfv``. +--------+--------+-------------------------------------+ | Name | Type | Description | @@ -461,7 +461,7 @@ Request(path) .. _table_spp_ctl_spp_nfv_ports_get: -.. table:: Request params of ports of spp_nfv or spp_vm. +.. table:: Request params of ports of ``spp_nfv``. +-----------+---------+--------------------------------+ | Name | Type | Description | @@ -475,7 +475,7 @@ Request(body) .. _table_spp_ctl_spp_nfv_ports_get_body: -.. table:: Request body params of ports of spp_nfv or spp_vm. +.. table:: Request body params of ports of ``spp_nfv``. +--------+--------+---------------------------------------------------------------+ | Name | Type | Description | @@ -521,7 +521,7 @@ Request(path) .. _table_spp_ctl_spp_nfv_patches_get: -.. table:: Request params of patches of spp_nfv or spp_vm. +.. table:: Request params of patches of ``spp_nfv``. +-----------+---------+---------------------------------+ | Name | Type | Description | @@ -535,7 +535,7 @@ Request(body) .. _table_spp_ctl_spp_nfv_ports_patches_body: -.. table:: Request body params of patches of spp_nfv or spp_vm. +.. table:: Request body params of patches of ``spp_nfv``. +------+--------+------------------------------------+ | Name | Type | Description | @@ -581,7 +581,7 @@ Request(path) .. _table_spp_ctl_spp_nfv_del_patches: -.. table:: Request params of deleting patches of spp_nfv or spp_vm. +.. table:: Request params of deleting patches of ``spp_nfv``. +-----------+---------+---------------------------------------+ | Name | Type | Description | @@ -614,7 +614,7 @@ Equivalent CLI command DELETE /v1/nfvs/{client_id} ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Terminate ``spp_nfv`` or ``spp_vm`` process. +Terminate ``spp_nfv``. * Normal response codes: 204 * Error response codes: 400, 404 @@ -624,7 +624,7 @@ Request(path) .. _table_spp_ctl_nfvs_delete: -.. table:: Request parameter for terminating spp_nfv or spp_vm. +.. table:: Request parameter for terminating ``spp_nfv``. +-----------+---------+-------------------------------------+ | Name | Type | Description | -- 2.7.4