From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 63BB4A0487 for ; Tue, 30 Jul 2019 09:29:59 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 4A7411BEB5; Tue, 30 Jul 2019 09:29:59 +0200 (CEST) Received: from mail-pl1-f193.google.com (mail-pl1-f193.google.com [209.85.214.193]) by dpdk.org (Postfix) with ESMTP id D64641BEB5 for ; Tue, 30 Jul 2019 09:29:58 +0200 (CEST) Received: by mail-pl1-f193.google.com with SMTP id t14so28512739plr.11 for ; Tue, 30 Jul 2019 00:29:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id; bh=j8+FMjTjqdiYHxUHCQ4SPR8+7nCiruuna3n3b/qUg+M=; b=CpTVzkm6Fzfe92w6cIYir9mb269f4gb2lBrAzepSw+OJJpyDFu8qppApEgZcrBSzCu O4NeuH09gExEHDGq/51WTD9d/Q/h/cMCFX1dVlroaMhO47ljtnYD2B+XVayWRUVzcjI+ c1JMpa0iJyEp7+ls3sHtJnrJG3pt0TphEkkvIBR8BCtSn97rqlxezsXIhT6lWP3N1ocV vkZcHwW0T9hexC72D+rYar1nlxQXRuQpzDxfGqXByJvmL820DD9wk7Y5ujDBXn8Tojwr VHzf4DnHyBKu5ExquYAuLYetjvdfDbBvn76lggnQKyCEBZrYw+fO78kD/95d+evIhIRt AoYg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id; bh=j8+FMjTjqdiYHxUHCQ4SPR8+7nCiruuna3n3b/qUg+M=; b=l7w+b3GCe6DAP+Bifd0wPTpZkEOxdQp6ht9OKhKmWFzg35Mb9icqD4Jklo1aGS004V xrTjABL95cn6qkZWzovt5uN5fvyOwyMAJTckF4NMLFS7hmLyVlnxx7s+QXz182cTPFFq beIvPSUrAXkiZqRMzlaWTEcQhBf/OxYbe+ywu5JVJPNk/kQHLhW1QeZOY37tQXms4eh1 kzNS7sFwPiar7fHS8A/fPgwL9xgyYMHfwD9C5YHk0nsmSsI4TWG4/72IwTIH3dklPhbz NyvtZMdleaHDY0CVsMhRkJjpT7c1XAxHM5HiKhjeBXrFlB7asHXVxgdRdzuIEi6ftBZZ SlNw== X-Gm-Message-State: APjAAAVrWnn9W21aUTphvduJsiA+zemeyqqqb1gp+jvThkg7aEYqGrST viFLZyPJ8FNtc/CO+jpNTK4bGUrg X-Google-Smtp-Source: APXvYqyvrh4AZicGPqElyIqck6CSN0RyLKNJ8eAzUufQYxMAxonMK06L/vsxK4uR2Ihr54P46f6qXQ== X-Received: by 2002:a17:902:bd49:: with SMTP id b9mr19765822plx.343.1564471798125; Tue, 30 Jul 2019 00:29:58 -0700 (PDT) Received: from localhost.localdomain ([192.47.164.146]) by smtp.gmail.com with ESMTPSA id s185sm96082933pgs.67.2019.07.30.00.29.56 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 30 Jul 2019 00:29:57 -0700 (PDT) From: yasufum.o@gmail.com To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com Date: Tue, 30 Jul 2019 16:29:53 +0900 Message-Id: <20190730072953.9258-1-yasufum.o@gmail.com> X-Mailer: git-send-email 2.17.1 Subject: [spp] [PATCH] docs: add API to add or del spp_primary ports 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: , Errors-To: spp-bounces@dpdk.org Sender: "spp" From: Yasufumi Ogawa This update is to add REST API for spp_primary for adding or deleting ports. Signed-off-by: Yasufumi Ogawa --- docs/guides/api_ref/spp_primary.rst | 48 +++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/docs/guides/api_ref/spp_primary.rst b/docs/guides/api_ref/spp_primary.rst index 276c7e9..1345a46 100644 --- a/docs/guides/api_ref/spp_primary.rst +++ b/docs/guides/api_ref/spp_primary.rst @@ -136,6 +136,54 @@ Response example } +PUT /v1/primary/ports +--------------------- + +Add or delete port. + +* Normal response codes: 204 +* Error response codes: 400, 404 + + +Request (body) +~~~~~~~~~~~~~~ + +.. _table_spp_ctl_spp_primary_ports_get_body: + +.. table:: Request body params of ports of ``spp_primary``. + + +--------+--------+--------------------------------------------------+ + | Name | Type | Description | + | | | | + +========+========+==================================================+ + | action | string | ``add`` or ``del``. | + +--------+--------+--------------------------------------------------+ + | port | string | Resource UID of {port_type}:{port_id}. | + +--------+--------+--------------------------------------------------+ + + +Request example +~~~~~~~~~~~~~~~ + +.. code-block:: console + + $ curl -X PUT -H 'application/json' \ + -d '{"action": "add", "port": "ring:0"}' \ + http://127.0.0.1:7777/v1/primary/ports + + +Response +~~~~~~~~ + +There is no body content for the response of a successful ``PUT`` request. + + +Equivalent CLI command +~~~~~~~~~~~~~~~~~~~~~~ + +Not supported in SPP CLI. + + DELETE /v1/primary/status ------------------------- -- 2.17.1