summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authoranjali.walsatwar <anjali.walsatwar@huawei.com>2019-08-08 18:12:13 +0530
committeranjali.walsatwar <anjali.walsatwar@huawei.com>2019-08-08 18:12:13 +0530
commitf7832b8ad4c8fb7dc9a1c432b8a999e97c57ad29 (patch)
treeac891399bace4898f3626c87d85b61e8fb2f3baf /docs
parentdcb65d6c693dd1e9137b19dc8f538f9405bd8c5f (diff)
fix for VNFLCM_API,VNFM_Driver_API,index
documents have different spelling mistakes and grammatical issues Issue-ID: VFC-1483 Signed-off-by: anjali.walsatwar <anjali.walsatwar@huawei.com> Change-Id: I97d6791dc63c2af443f33681e2c0d61450fab763
Diffstat (limited to 'docs')
-rw-r--r--docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst14
-rw-r--r--docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst6
-rw-r--r--docs/platform/APIs/index.rst8
3 files changed, 14 insertions, 14 deletions
diff --git a/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
index ec6c58fa..cebc637e 100644
--- a/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
+++ b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
@@ -8,14 +8,14 @@
**1 Scope**
=============
-The scope of the present document is to describe the GVNFM exposed API specification over Or-Vnfm reference point and Ve-Vnfm-vnf reference point.
+The scope of the this document is to describe the GVNFM exposed API specification over Or-Vnfm reference point and Ve-Vnfm-vnf reference point.
Some content has been updated, about the API Swagger definition, you can find here 'GVNFM_LCM_APIs<https://gerrit.onap.org/r/gitweb?p=vfc/gvnfm/vnflcm.git;a=blob;f=lcm/lcm/swagger/swagger.json;h=f098d282927d3535f5e9e6950f26b9171e04d30c;hb=HEAD>'.
**2 Terms, Definitions and Abbreviations**
===========================================
- For the purposes of the present document, the following
+ For the purpose of the present document, the following
abbreviations apply:
+------------------------+-----------------------------------------------------+
@@ -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:**
@@ -232,7 +232,7 @@ Table 2-1 abbreviations
+==================+===============+======================================+
| vimType | String | The type of the VIM. |
+------------------+---------------+--------------------------------------+
-| apiVersion | String | The Version of the api of the VIM. |
+| apiVersion | String | The version of the api of the VIM. |
+------------------+---------------+--------------------------------------+
| protocolType | String | http https |
+------------------+---------------+--------------------------------------+
@@ -1682,4 +1682,4 @@ Table 2-1 abbreviations
.. |image0| image:: VNFM_API.png
:width: 5.07047in
- :height: 5.6320in \ No newline at end of file
+ :height: 5.6320in
diff --git a/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
index d51f10c9..86440933 100644
--- a/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
+++ b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
@@ -20,7 +20,7 @@ For the purposes of the present document, the following abbreviations apply:
+-------------+-----------------------------------------------+
|Abbreviation | |
+-------------+-----------------------------------------------+
-|NFVO |Network Functions Virtualization Orchestrator |
+|NFVO |Network Function Virtualization Orchestrator |
+-------------+-----------------------------------------------+
|VNFM |Virtual Network Function Manager |
+-------------+-----------------------------------------------+
@@ -96,7 +96,7 @@ juju
| | | | | manages this resource. |
| | | | | This attribute shall be supported |
| | | | | and present if VNF-related resource |
-| | | | | management in direct applicable. |
+| | | | | management is direct applicable. |
+--------------+------------+-------------+----------+----------------------------------------+
| networkId | M | 1 | String | The network UUID of VIM |
+--------------+------------+-------------+----------+----------------------------------------+
@@ -596,7 +596,7 @@ VNF filter: vnfInstanceId via url [R1]
| vduid | M | 1 | String | Defines the id of vdu. |
+--------------------+------------+-------------+-------------+---------------------------------+
| vmname | M | 1 | | Defines the name of virtual |
-| | | | | machines. |
+| | | | | machine. |
+--------------------+------------+-------------+-------------+---------------------------------+
.. code-block:: json
diff --git a/docs/platform/APIs/index.rst b/docs/platform/APIs/index.rst
index 3d58652f..f4acf6df 100644
--- a/docs/platform/APIs/index.rst
+++ b/docs/platform/APIs/index.rst
@@ -9,7 +9,7 @@ VF-C Offered APIs
:depth: 2
Now VF-C provides the NS life cycle management APIs to UUI,SO,Policy and package management APIs to UUI.
-For VNFM vendor, VF-C also provides the VNFM integration APIs, they can reference these APIs to implmemet their VNFMDriver to integrate with VF-C and ONAP.
+For VNFM vendor, VF-C also provides the VNFM integration APIs, they can reference these APIs to implement their VNFMDriver to integrate with VF-C and ONAP.
|image0|
@@ -106,8 +106,8 @@ GVNFM Northbound & Southbound APIs
----------------------------------
VF-C provides the Generic VFNM , it can be as the GVNFM reference implementaton.
-Now the Northbound APIs of GVNFM has been compli1t with SOL003 and it now can be integrate with VF-C NFVO.
-In tosca-based vCPE use case, the GVNFM founction have been verified in Casablanca release.
+Now the Northbound APIs of GVNFM has been compete with SOL003 and it now can be integrate with VF-C NFVO.
+In tosca-based vCPE use case, the GVNFM function have been verified in Casablanca release.
GVNFM Northbound & Southbound APIs for VNF Integration
@@ -125,4 +125,4 @@ CATALOG APIs for VNF Integration
.. toctree::
:maxdepth: 1
- CATALOG_API/index \ No newline at end of file
+ CATALOG_API/index