From: ogawa.yasufumi@lab.ntt.co.jp
To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp
Subject: [spp] [PATCH 5/5] docs: add DELETE method for exiting spp_nfv
Date: Thu, 25 Oct 2018 14:19:43 +0900 [thread overview]
Message-ID: <20181025051943.17129-6-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <20181025051943.17129-1-ogawa.yasufumi@lab.ntt.co.jp>
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
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 <ogawa.yasufumi@lab.ntt.co.jp>
---
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
prev parent reply other threads:[~2018-10-25 5:19 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-25 5:19 [spp] [PATCH 0/5] Add exit command support for spp_nfv and spp_vm ogawa.yasufumi
2018-10-25 5:19 ` [spp] [PATCH 1/5] spp_nfv: chage to return msg of exit command ogawa.yasufumi
2018-10-25 5:19 ` [spp] [PATCH 2/5] spp-ctl: add exit cmd support for spp_nfv ogawa.yasufumi
2018-10-25 5:19 ` [spp] [PATCH 3/5] spp_vm: chage to return msg of exit command ogawa.yasufumi
2018-10-25 5:19 ` [spp] [PATCH 4/5] controller: update sec exit cmd to call REST API ogawa.yasufumi
2018-10-25 5:19 ` ogawa.yasufumi [this message]
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=20181025051943.17129-6-ogawa.yasufumi@lab.ntt.co.jp \
--to=ogawa.yasufumi@lab.ntt.co.jp \
--cc=ferruh.yigit@intel.com \
--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).