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 4CF684CE4 for ; Thu, 25 Oct 2018 07:19:57 +0200 (CEST) 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 w9P5JuOs022737; Thu, 25 Oct 2018 14:19:56 +0900 Received: from vc1.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 30F2FEA7D4D; Thu, 25 Oct 2018 14:19:56 +0900 (JST) Received: from localhost.localdomain (unknown [129.60.13.51]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 18273EA7CFC; Thu, 25 Oct 2018 14:19:56 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp Date: Thu, 25 Oct 2018 14:19:43 +0900 Message-Id: <20181025051943.17129-6-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.13.1 In-Reply-To: <20181025051943.17129-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20181025051943.17129-1-ogawa.yasufumi@lab.ntt.co.jp> X-TM-AS-MML: disable Subject: [spp] [PATCH 5/5] docs: add DELETE method for exiting spp_nfv 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, 25 Oct 2018 05:19:57 -0000 From: Yasufumi Ogawa To support `exit` of `sec` command of `spp.py`, add DELETE method. It is called with client ID as following example. $ curl -X DELETE http://127.0.0.1:7777/v1/nfvs/1 Signed-off-by: Yasufumi Ogawa --- docs/guides/spp-ctl/api-reference.rst | 43 +++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/docs/guides/spp-ctl/api-reference.rst b/docs/guides/spp-ctl/api-reference.rst index 3ae90fd..f0661c8 100644 --- a/docs/guides/spp-ctl/api-reference.rst +++ b/docs/guides/spp-ctl/api-reference.rst @@ -582,6 +582,49 @@ Equivalent CLI command sec {client_id};patch reset +DELETE /v1/nfvs/{client_id} +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Terminate ``spp_nfv`` or ``spp_vm`` process. + +* Normal response codes: 204 +* Error response codes: 400, 404 + +Request(path) +^^^^^^^^^^^^^ + +.. _table_spp_ctl_nfvs_delete: + +.. table:: Request parameter for terminating spp_nfv or spp_vm. + + +-----------+---------+-------------------------------------+ + | Name | Type | Description | + | | | | + +===========+=========+=====================================+ + | client_id | integer | client id. | + +-----------+---------+-------------------------------------+ + +Request example +^^^^^^^^^^^^^^^ + +.. code-block:: console + + curl -X DELETE -H 'application/json' \ + http://127.0.0.1:7777/v1/nfvs/1 + +Response example +^^^^^^^^^^^^^^^^ + +There is no body content for the response of a successful ``DELETE`` request. + +Equivalent CLI command +^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + sec {client_id}; exit + + API for spp_vf -------------- -- 2.7.4