adding initial documentation

Adding rough-draft outline plus api docs.

Issue-ID: VNFSDK-95

Change-Id: Icfa4ab711b7e22d13f2bf3b540610ff82d24bff6
Signed-off-by: Chris Donley <christopher.donley@huawei.com>

2 files changed, 256 insertions, 0 deletions

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..ec64377
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,53 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. toctree::
+   :maxdepth: 1
+
+   vnfsdk-apis
+
+
+# Documentation Outline
+
+API Documentation
+# Components
+
+VNF Packaging Model/Blueprint 
+-----------------------------
+VNF product model/blueprint provides a declarative way to define deployment, operational and functional attributes of a VNF product. The VNF product is defined in terms of deployment time requirements and dependencies and exposed telemetry indicator definitions.
+
+The deployment time requirements and dependencies define any and all compute infrastructure needs of the VNF product, such as specific hardware architecture, on-chip features, instruction set availability and hypervisor capabilities.
+
+The telemetry indicator definitions define a set of default indicators exposed by a given VNF product for use by monitoring and assurance tools. This list can be extended and customized once a given VNF product is on-boarded and instantiated at run-time.
+
+The VNF product model is specified using the TOSCA NFV simple profile. It is persisted, along with the product executables and data, using TOSCA CSAR files.
+
+# VNF SDK Tools 
+VNF SDK tools provide VNF product DevOps engineers with command line tools and client side API language bindings to define the VNF product model and package content. The following tools are included...
+
+•	VNF Package Builder - creates a CSAR file based on inputs provided by the VNF product DevOps engineer
+
+•	VNF Package Validator - validates the content of the VNF packages to ensure that everything has been built correctly
+
+•	VNF Package Extractor - extracts VNF product model and executables from the CSAR file
+
+•	VNF Package Parser - translates VNF proeduct blueprint into a format consumable by OPEN-O components
+
+•	VNF Package Dry Run - performs a "dry run" install to ensure that the package can be deployed during instantiation
+
+# VNF Validation Tests 
+
+TBD
+
+# User Guides
+ 
+  ## VNF Package Tools User Guide 
+
+VNF Package Designer, provides VNF product DevOps engineers with a graphical tool to define the VNF product model and package content. It is made available as part of the VNF Supplier SDK tools.The package designer makes use of the VNF SDK command line interfaces (CLIs) and client-side API language bindings in order to define the model and the package content. As such, it is functionally equivalent to the VNF SDK tools.
+
+  ## Marketplace User Guide for Operators 
+
+TBD
+
+  ## Marketplace User Guide for VNF Suppliers 
+
+TBD
diff --git a/docs/vnfsdk-apis.rst b/docs/vnfsdk-apis.rst
new file mode 100644
index 0000000..2531a14
--- /dev/null
+++ b/docs/vnfsdk-apis.rst
@@ -0,0 +1,203 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.

+.. http://creativecommons.org/licenses/by/4.0

+

+

+VNF SDK APIs

+============

+

+Market Place API

+----------------

+Upload/Re-upload VNF Package

+++++++++++++++++++++++++++++

+

++--------------------+-----------------------------+

+|Interface Definition|Description                  |

++====================+=============================+

+|URI                 |/onapapi/marketplace/v1/csars|

++--------------------+-----------------------------+

+|Operation Type      |POST                         |

++--------------------+-----------------------------+

+|Content-Type        |multipart/form-data	   |

++--------------------+-----------------------------+

+

+Request Parameters:

+

++---------+---------+-----------+--------------------------+-----------------------+

+|Attribute|Qualifier|Cardinality|Content                   |Description            |

++=========+=========+===========+==========================+=======================+

+|file     |M        |1          |InputStream               |The CSAR file stream   |

++---------+---------+-----------+--------------------------+-----------------------+

+|file     |M        |1          |FormDataContentDisposition|The detail of CSAR file|

++---------+---------+-----------+--------------------------+-----------------------+

+

+FormDataContentDisposition

+

++----------------+------------------+-----------------------------------------+

+|Attribute       |Content           |Description                              |

++================+==================+=========================================+

+|type            |String            |the disposition type. will be "form-data"|

++----------------+------------------+-----------------------------------------+

+|name            |String            |the control name                         |

++----------------+------------------+-----------------------------------------+

+|fileName        |String            |the file name                            |

++----------------+------------------+-----------------------------------------+

+|creationDate    |Date              |the creation date                        |

++----------------+------------------+-----------------------------------------+

+|modificationDate|Date              |the modification date                    |

++----------------+------------------+-----------------------------------------+

+|readDate        |Date              |the read date                            |

++----------------+------------------+-----------------------------------------+

+|size            |String            |the size                                 |

++----------------+------------------+-----------------------------------------+

+|parameters      |Map<String,String>|the parameters                           |

++----------------+------------------+-----------------------------------------+

+

+Response:

+

++---------+---------+-----------+-------+------------------------------------------------------------------------+

+|Attribute|Qualifier|Cardinality|Content|Description                                                             |

++---------+---------+-----------+-------+------------------------------------------------------------------------+

+|csarId   |M        |1          |String |The CSAR identifier is a unique identifier generated by the Market place|

++---------+---------+-----------+-------+------------------------------------------------------------------------+

+

+Delete VNF package by csarId

+++++++++++++++++++++++++++++

+

++--------------------+--------------------------------------+

+|Interface Definition|Description                           |

++====================+======================================+

+|URI                 |/onapapi/marketplace/v1/csars/{csarId}|

++--------------------+--------------------------------------+

+|Operation Type      |DELETE                                |

++--------------------+--------------------------------------+

+

+Request Parameters:

+

++---------+---------+-----------+-------+----------------------+

+|Attribute|Qualifier|Cardinality|Content|Description           |

++=========+=========+===========+=======+======================+

+|csarId   |M        |1          |String |The id of CSAR package|

++---------+---------+-----------+-------+----------------------+

+

+Response:

+

+HTTP Success or Error Code

+

+Download VNF package files 

+++++++++++++++++++++++++++

+

++--------------------+--------------------------------------------+

+|Interface Definition|Description                                 |

++====================+============================================+

+|URI                 |/onapapi/marketplace/v1/csars/{csarId}/files|

++--------------------+--------------------------------------------+

+|Operation Type      |GET                                         |

++--------------------+--------------------------------------------+

+

+Request Parameters:

+

++---------+---------+-----------+-------+--------------+

+|Attribute|Qualifier|Cardinality|Content|Description   |

++=========+=========+===========+=======+==============+

+|csarId   |M        |1          |String |The id of CSAR|

++---------+---------+-----------+-------+--------------+

+

+Sample:

+

+/onapapi/marketplace/v1/csars/78ede6f3-66cc-46ab-b748-38a6c010d272/files?

+

+Response:

+

+CSAR Package

+

+Query VNF package information by csarId

++++++++++++++++++++++++++++++++++++++++

+

++--------------------+--------------------------------------+

+|Interface Definition|Description                           |

++====================+======================================+

+|URI                 |/onapapi/marketplace/v1/csars/{csarId}|

++--------------------+--------------------------------------+

+|Operation Type      |GET                                   |

++--------------------+--------------------------------------+

+

+Request Parameters:

+

++---------+---------+-----------+-------+----------------------+

+|Attribute|Qualifier|Cardinality|Content|Description           |

++=========+=========+===========+=======+======================+

+|csarId   |M        |1          |String |The id of CSAR package|

++---------+---------+-----------+-------+----------------------+

+

+Response:

+

+PackageMetaData

+

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|Attribute    |Qualifier|Cardinality|Content|Description                                             |

++=============+=========+===========+=======+========================================================+

+|csarId       |M        |1          |String |The id of CSAR package                                  |

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|name         |M        |1          |String |Name of package                                         |

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|provider     |M        |1          |String |Provider company name                                   |

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|version      |M        |1          |String |version of the package                                  |

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|createTime   |M        |1          |String |create time of package                                  |

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|modifyTime   |M        |1          |String |modify time of package                                  |

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|downloadUri  |M        |1          |String |download uri                                            |

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|size         |M        |1          |String |size of the package                                     |

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|downloadCount|M        |1          |Integer|Number of times the package is download from marketplace|

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|shortdesc    |M        |1          |String |Short description                                       |

++-------------+---------+-----------+-------+--------------------------------------------------------+

+|details      |M        |1          |String |Detailed description                                    |

++-------------+---------+-----------+-------+--------------------------------------------------------+

+

+Sample:

+::

+   {

+       "csarId":"78ede6f3-66cc-46ab-b748-38a6c010d272",

+       "name":"NanocellGateway",

+       "provider":"XYZ",

+       "version":"V1.0",

+       "createTime":"2016-06-29 03:33:15",

+       "modifyTime":"2016-06-29 09:33:15",

+       "size":"0.93M",

+       "downloadUri":"http://msb_ip:msb_port/files/marketplace/CSAR/XYZ/NanocellGW/v1.0/NanocellGateway.csar",

+       "type":"CSAR"

+   }

+

+Query list of VNF package information by conditions

++++++++++++++++++++++++++++++++++++++++++++++++++++

+

++--------------------+-------------------------------------------------------------------------------------------+

+|Interface Definition|Description                                                                                |

++====================+===========================================================================================+

+|URI                 |/onapapi/marketplace/v1/csars?name={name}&version={version}&type={type}&provider={provider}|

++--------------------+-------------------------------------------------------------------------------------------+

+|Operation Type      |GET                                                                                        |

++--------------------+-------------------------------------------------------------------------------------------+

+

+Query Param

+

++---------+---------+-----------+-------+-------------+

+|Attribute|Qualifier|Cardinality|Content|Description  |

++=========+=========+===========+=======+=============+

+|name     |M        |1          |String |csar Name    |

++---------+---------+-----------+-------+-------------+

+|version  |M        |1          |String |csar version |

++---------+---------+-----------+-------+-------------+

+|type     |M        |1          |String |csar type    |

++---------+---------+-----------+-------+-------------+

+|provider |M        |1          |String |csar provider|

++---------+---------+-----------+-------+-------------+

+

+Response:

+

+List of PackageMetaData