From: ogawa.yasufumi@lab.ntt.co.jp
To: ferruh.yigit@intel.com, spp@dpdk.org, ogawa.yasufumi@lab.ntt.co.jp
Subject: [spp] [PATCH 2/7] docs: remove spp_vm from spp-ctl API
Date: Thu, 17 Jan 2019 11:46:40 +0900 [thread overview]
Message-ID: <1547693205-17710-3-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <1547693205-17710-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp>
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Remove spp_vm from spp-ctl REST API reference.
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
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
next prev parent reply other threads:[~2019-01-17 2:49 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-17 2:46 [spp] [PATCH 0/7] Remove spp_vm from documentation ogawa.yasufumi
2019-01-17 2:46 ` [spp] [PATCH 1/7] docs: remove spp_vm from howto use section ogawa.yasufumi
2019-01-17 2:46 ` ogawa.yasufumi [this message]
2019-01-17 2:46 ` [spp] [PATCH 3/7] docs: remove spp_vm from SPP container ogawa.yasufumi
2019-01-17 2:46 ` [spp] [PATCH 4/7] docs: remove spp_vm from usecases ogawa.yasufumi
2019-01-17 2:46 ` [spp] [PATCH 5/7] docs: remove spp_vm from secondary commands ogawa.yasufumi
2019-01-17 2:46 ` [spp] [PATCH 6/7] docs: remove spp_vf from image of usecase ogawa.yasufumi
2019-01-17 2:46 ` [spp] [PATCH 7/7] docs: update hugepages setup ogawa.yasufumi
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=1547693205-17710-3-git-send-email-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).