From: oda@valinux.co.jp
To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp
Subject: [spp] [PATCH v4 12/14] docs: correct directives of spp-ctl
Date: Fri, 5 Oct 2018 12:57:55 +0900 [thread overview]
Message-ID: <20181005035757.23122-13-oda@valinux.co.jp> (raw)
In-Reply-To: <20181005035757.23122-1-oda@valinux.co.jp>
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Some of code-block directives are incorrect, and section headers are not
applied with the documentation guidelines of DPDK. This patch is to
correct following directives.
* Mistaken code-block directives.
* Section headers.
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 | 74 +++++++++++++--------------
1 file changed, 37 insertions(+), 37 deletions(-)
diff --git a/docs/guides/spp-ctl/api-reference.rst b/docs/guides/spp-ctl/api-reference.rst
index 285526e..3263934 100644
--- a/docs/guides/spp-ctl/api-reference.rst
+++ b/docs/guides/spp-ctl/api-reference.rst
@@ -3,17 +3,16 @@
.. _spp_ctl_api_ref:
-=============
API Reference
=============
Overview
-========
+--------
``spp-ctl`` provides simple REST like API. It supports http only, not https.
Request and Response
---------------------
+~~~~~~~~~~~~~~~~~~~~
Request body is JSON format.
It is accepted both ``text/plain`` and ``application/json``
@@ -26,7 +25,8 @@ If a request fails, the response is a text which shows error reason
and the content-type is ``text/plain``.
Error code
-----------
+~~~~~~~~~~
+
``spp-ctl`` does basic syntax and lexical check of a request.
@@ -42,10 +42,10 @@ Error code
API independent of the process type
-===================================
+-----------------------------------
GET /v1/processes
------------------
+~~~~~~~~~~~~~~~~~
Show the SPP processes connected to the ``spp-ctl``.
@@ -77,7 +77,7 @@ process object:
Response example
^^^^^^^^^^^^^^^^
-.. code-block:: yaml
+.. code-block:: json
[
{
@@ -95,10 +95,10 @@ Response example
API for spp_primary
-===================
+-------------------
GET /v1/primary/status
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
Show statistical information.
@@ -120,7 +120,7 @@ when ``spp_primary`` implements it.
DELETE /v1/primary/status
--------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~
Clear statistical information.
@@ -141,10 +141,10 @@ There is no body content for the response of a successful ``PUT`` request.
API for spp_nfv/spp_vm
-======================
+----------------------
GET /v1/nfvs/{client_id}
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
Get the information of the ``spp_nfv`` or ``spp_vm`` process.
@@ -196,7 +196,7 @@ patch objest
Response example
^^^^^^^^^^^^^^^^
-.. code-block:: yaml
+.. code-block:: json
{
"client-id": 1,
@@ -217,13 +217,13 @@ Response example
Equivalent CLI command
^^^^^^^^^^^^^^^^^^^^^^
-.. code-block:: console
+.. code-block:: none
sec {client_id};status
PUT /v1/nfvs/{client_id}/forward
---------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start or Stop forwarding.
@@ -267,19 +267,19 @@ Equivalent CLI command
action is ``start``
-.. code-block:: yaml
+.. code-block:: none
sec {client_id};forward
action is ``stop``
-.. code-block:: yaml
+.. code-block:: none
sec {client_id};stop
PUT /v1/nfvs/{client_id}/ports
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add or Delete port.
@@ -323,13 +323,13 @@ There is no body content for the response of a successful ``PUT`` request.
Equivalent CLI command
^^^^^^^^^^^^^^^^^^^^^^
-.. code-block:: console
+.. code-block:: none
sec {client_id};{action} {interface_type} {interface_id}
PUT /v1/nfvs/{client_id}/patches
---------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add a patch.
@@ -373,13 +373,13 @@ There is no body content for the response of a successful ``PUT`` request.
Equivalent CLI command
^^^^^^^^^^^^^^^^^^^^^^
-.. code-block:: console
+.. code-block:: none
sec {client_id};patch {src} {dst}
DELETE /v1/nfvs/{client_id}/patches
------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Reset patches.
@@ -411,16 +411,16 @@ There is no body content for the response of a successful ``DELETE`` request.
Equivalent CLI command
^^^^^^^^^^^^^^^^^^^^^^
-.. code-block:: console
+.. code-block:: none
sec {client_id};patch reset
API for spp_vf
-==============
+--------------
GET /v1/vfs/{client_id}
------------------------
+~~~~~~~~~~~~~~~~~~~~~~~
Get the information of the ``spp_vf`` process.
@@ -512,7 +512,7 @@ classifier table:
Response example
^^^^^^^^^^^^^^^^
-.. code-block:: yaml
+.. code-block:: json
{
"client-id": 1,
@@ -619,13 +619,13 @@ The component which type is ``unused`` is to indicate unused core.
Equivalent CLI command
^^^^^^^^^^^^^^^^^^^^^^
-.. code-block:: console
+.. code-block:: none
sec {client_id};status
POST /v1/vfs/{client_id}/components
------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start the component.
@@ -672,13 +672,13 @@ There is no body content for the response of a successful ``POST`` request.
Equivalent CLI command
^^^^^^^^^^^^^^^^^^^^^^
-.. code-block:: console
+.. code-block:: none
sec {client_id};component start {name} {core} {type}
DELETE /v1/vfs/{sec id}/components/{name}
------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop the component.
@@ -712,13 +712,13 @@ There is no body content for the response of a successful ``POST`` request.
Equivalent CLI command
^^^^^^^^^^^^^^^^^^^^^^
-.. code-block:: console
+.. code-block:: none
sec {client_id};component stop {name}
PUT /v1/vfs/{client_id}/components/{name}/ports
------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add or Delete port to the component.
@@ -789,19 +789,19 @@ Equivalent CLI command
action is ``attach``
-.. code-block:: console
+.. code-block:: none
sec {client_id};port add {port} {dir} {name} [add_vlantag {id} {pcp} | del_vlantag]
action is ``detach``
-.. code-block:: console
+.. code-block:: none
sec {client_id};port del {port} {dir} {name}
PUT /v1/vfs/{sec id}/classifier_table
--------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Set or Unset classifier table.
@@ -861,12 +861,12 @@ Equivalent CLI command
type is ``mac``
-.. code-block:: console
+.. code-block:: none
classifier_table {action} mac {mac_address} {port}
type is ``vlan``
-.. code-block:: console
+.. code-block:: none
classifier_table {action} vlan {vlan} {mac_address} {port}
--
2.17.1
next prev parent reply other threads:[~2018-10-05 3:58 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 ` [spp] [PATCH v3 13/13] docs: add labels and captions for tables oda
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 ` oda [this message]
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=20181005035757.23122-13-oda@valinux.co.jp \
--to=oda@valinux.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=ogawa.yasufumi@lab.ntt.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).