Update ReadTheDocs docs folder

Change-Id: I994250de6ae148832c71ab87ca2057642497bd12
Issue-ID: VID-71
Signed-off-by: Ofir Sonsino <os0695@att.com>

diff --git a/docs/docs-consumedapis.rst b/docs/docs-consumedapis.rst
index c2af4c2..189b80a 100644 (file)
--- a/docs/docs-consumedapis.rst
+++ b/docs/docs-consumedapis.rst
@@ -3,14 +3,97 @@
 
 Consumed APIs
 =============
+VID consumes the following APIs from other components:
 
-.. note::
-   * This section is used to reference APIs that a software component depends on
-     and uses from other sources.  
-   
-   * Consumed APIs should be a specific link to the offered APIs from another component
-     or external source.
+SDC
+----
 
-   * This note must be removed after content has been added.
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| /sdc/v1/catalog/services/meta                                                                                                 | Get services general.                                                  |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| /sdc/v1/catalog/services/toscaModel                                                                                           | Download csar by UUID                                                  |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
 
+SO
+---
 
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| POST /serviceInstances/v5                                                                                                     | Create instance                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| DELETE                                                                                                                        | Delete instance                                                        |
+|   /serviceInstances/v5/<instance-id>                                                                                          |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| POST                                                                                                                          | Create VNF                                                             |
+|   /serviceInstances/v5/<service_instance_id>/vnfs                                                                             |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| DELETE                                                                                                                        | Delete VNF                                                             |
+|   /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_id>                                                                    |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| POST                                                                                                                          | Create VF-Module                                                       |
+|   /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/vfModules                                                 |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| DELETE                                                                                                                        | Delete VF-Module                                                       |
+|   /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/vfModules                                                 |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| POST                                                                                                                          | Create Volume group                                                    |
+|   /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/volumeGroups                                              |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| DELETE                                                                                                                        | Delete Volume Group                                                    |
+|   /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/volumeGroups                                              |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| POST                                                                                                                          | Create configuration                                                   |
+|   /serviceInstances/v5/<service_instance_id>/configurations/                                                                  |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| DELETE                                                                                                                        | Delete configuration                                                   |
+|   serviceInstances/v5/<service_instance_id>/configurations/<configuration_id>                                                 |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| POST                                                                                                                          | Create network                                                         |
+|   /serviceInstances/v5/<service_instance_id>/networks                                                                         |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| DELETE                                                                                                                        | Delete network (network instance id)                                   |
+|   /serviceInstances/v5/<service_instance_id>/networks/<network_instance_id>                                                   |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| GET /orchestrationRequests/v5                                                                                                 | Get orchestration status                                               |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| GET /tasks/v1                                                                                                                 | Get available Manual tasks by request id                               |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+
+
+A&AI
+-----
+
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| GET                                                                                                                           | Get all subscribers                                                    |
+|   aai/v11/business/customers?subscriber-type=INFRA&depth=2                                                                    |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| GET aai/v11/                                                                                                                  | Get data for specific subscriber including its available services      |
+|   business/customers/customer/<global_customer_id>                                                                            |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| GET                                                                                                                           | Get all service types                                                  |
+|   aai/v11/service-design-and-creation/services                                                                                |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| GET                                                                                                                           | Get services by owning entity id                                       |
+|   aai/v11/business/owning-entities?<owning_entitiy_ids>                                                                       |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| GET                                                                                                                           | Get services by project name                                           |
+|   aai/v11/business/projects?<project-names>                                                                                   |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| GET aai/v11/network/zones                                                                                                     | Get all AIC zones                                                      |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| POST search/named-query                                                                                                       | Get the data regarding instance and it’s related nodes                 |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| GET aai/v11/                                                                                                                  | Get AIC zones for specific service instance                            |
+|   business/customers/customer/<global_customer_id>/                                                                           |                                                                        |
+|   /service-subscriptions/service-subscription/<service_type>/service-instances/service-instance/<service_instance_id>         |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| PUT Aai/v11/query?format=simple(types:                                                                                        | This is custom query and has multiple types (declared in the url line) |
+|   “query/vnfFromModelbyRegion?cloudRegionId”,”                                                                                |                                                                        |
+|   vnf-topology-fromServiceInstance”)                                                                                          |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| Aai/v11/                                                                                                                      | Get human readable version by version id                               |
+|   service-design-and-creation/models?depth=2                                                                                  |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| business/customers/customer/<global_customer_id>/service-subscriptions/service-subscription/<service_Subscription_Id>?depth=0 | Get all service subscriptions                                          |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+|                                                                                                                               |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
\ No newline at end of file

diff --git a/docs/index.rst b/docs/index.rst
index 4f5b8db..752fb42 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,6 +14,5 @@ VID Documentation
    docs-logging.rst
    docs-installation.rst
    docs-configuration.rst
-   docs-administration.rst
    docs-humaninterfaces.rst
    docs-release-notes.rst