aboutsummaryrefslogtreecommitdiffstats
path: root/docs/platform/APIs
diff options
context:
space:
mode:
authorthmsdt <thomas.kulik@telekom.de>2023-07-04 13:43:14 +0200
committerthmsdt <thomas.kulik@telekom.de>2023-07-05 17:29:09 +0200
commit129029584597941bb7603dd7440b7d37f823ef96 (patch)
tree02e92b4c5383d48ad51bbf5498516a42c2040027 /docs/platform/APIs
parentfbece5930eebe53f88b1c2a657cc9871490f8ca6 (diff)
fix doc config files and doc files + top-level tox.ini
Issue-ID: DOC-811 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I67dd9f27a851c4a12f078f28c4f9904959c42393
Diffstat (limited to 'docs/platform/APIs')
-rw-r--r--docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst20
-rw-r--r--docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst9
2 files changed, 15 insertions, 14 deletions
diff --git a/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
index cebc637e..9f4ab5f0 100644
--- a/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
+++ b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
@@ -47,7 +47,7 @@ Table 2-1 abbreviations
+---------------------+--------------------------------------------------------------+
| If Definition | Description |
+=====================+==============================================================+
-| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances |
+| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances |
+---------------------+--------------------------------------------------------------+
| Operation | POST |
+---------------------+--------------------------------------------------------------+
@@ -102,7 +102,7 @@ Table 2-1 abbreviations
+---------------------+------------------------------------------------------------------------------+
| If Definition | Description |
+=====================+==============================================================================+
-| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances/{vnfInstanceId} |
+| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances/{vnfInstanceId} |
+---------------------+------------------------------------------------------------------------------+
| Operation | DELETE |
+---------------------+------------------------------------------------------------------------------+
@@ -143,7 +143,7 @@ Table 2-1 abbreviations
+---------------------+-------------------------------------------------------------------------------------------+
| If Definition | Description |
+=====================+===========================================================================================+
-| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf_instances/{vnfInstanceId}/instantiate |
+| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf_instances/{vnfInstanceId}/instantiate |
+---------------------+-------------------------------------------------------------------------------------------+
| Operation | POST |
+---------------------+-------------------------------------------------------------------------------------------+
@@ -216,13 +216,13 @@ Table 2-1 abbreviations
+-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
| vimId | M | 1 | Identifier | The identifier of the VIM. |
+-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
-| interfaceInfo | M | 0..N | KeyValuePair | Information about the interface to the VIM, including VIM provider type, API version and protocol type. |
+| interfaceInfo | M | 0..N | KeyValuePair | Information about the interface to the VIM, including VIM provider type, API version and protocol type. |
+-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
| accessInfo | M | 0..N | KeyValuePair | Authentication credentials for accessing the VIM. Examples may include those to support different authentication schemes, e.g., OAuth, |
-| | | | | Token etc. |
+| | | | | Token etc. |
+-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
| interface | M | 1 | String | Information about the interface endpoint. An example is a URL. |
-| Endpoint | | | | Token etc. |
+| Endpoint | | | | Token etc. |
+-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
**interfaceInfo:**
@@ -402,7 +402,7 @@ Table 2-1 abbreviations
+---------------------+-----------------------------------------------------------------------------------------+
| If Definition | Description |
+=====================+=========================================================================================+
-| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances/{vnfInstanceId}/term inate |
+| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances/{vnfInstanceId}/term inate |
+---------------------+-----------------------------------------------------------------------------------------+
| Operation | POST |
+---------------------+-----------------------------------------------------------------------------------------+
@@ -485,7 +485,7 @@ Table 2-1 abbreviations
+---------------------+--------------------------------------------------------------+
| If Definition | Description |
+=====================+==============================================================+
-| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances |
+| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances |
+---------------------+--------------------------------------------------------------+
| Operation | GET |
+---------------------+--------------------------------------------------------------+
@@ -933,7 +933,7 @@ Table 2-1 abbreviations
+---------------------+------------------------------------------------------------------------------+
| If Definition | Description |
+=====================+==============================================================================+
-| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf_instances/{vnfInstanceId} |
+| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf_instances/{vnfInstanceId} |
+---------------------+------------------------------------------------------------------------------+
| Operation | GET |
+---------------------+------------------------------------------------------------------------------+
@@ -1143,7 +1143,7 @@ Table 2-1 abbreviations
+---------------------+-------------------------------------------------------------------------------------------------+
| If Definition | Description |
+=====================+=================================================================================================+
-| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_lc\_ops/{vnfLcOpId}&response Id={responseId} |
+| URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_lc\_ops/{vnfLcOpId}&response Id={responseId} |
+---------------------+-------------------------------------------------------------------------------------------------+
| Operation | GET |
+---------------------+-------------------------------------------------------------------------------------------------+
diff --git a/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
index 86440933..f86055bd 100644
--- a/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
+++ b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
@@ -7,9 +7,10 @@
**1. Scope**
==============
-The scope of the present document is to describe the VNFM driver integrated related API specification.
-Some content has been updated, about the API Swagger definition, you can find
-here 'VNFM driver development related API<https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob;f=lcm/swagger/vfc.vnfdriver.swagger.json;h=fc35adbdc75df1307ca2c43a11bfb472da2a27c6;hb=HEAD>'
+The scope of the present document is to describe the VNFM driver integrated
+related API specification. Some content has been updated, about the API Swagger
+definition, you can find here 'VNFM driver development related
+API<https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob;f=lcm/swagger/vfc.vnfdriver.swagger.json;h=fc35adbdc75df1307ca2c43a11bfb472da2a27c6;hb=HEAD>'
**2. Terms, Definitions and Abbreviations**
@@ -20,7 +21,7 @@ For the purposes of the present document, the following abbreviations apply:
+-------------+-----------------------------------------------+
|Abbreviation | |
+-------------+-----------------------------------------------+
-|NFVO |Network Function Virtualization Orchestrator |
+|NFVO |Network Function Virtualization Orchestrator |
+-------------+-----------------------------------------------+
|VNFM |Virtual Network Function Manager |
+-------------+-----------------------------------------------+