Update ReadTheDocs docs folder

[vid.git] / docs / consumedapis.rst

diff --git a/docs/consumedapis.rst b/docs/consumedapis.rst
new file mode 100644 (file)
index 0000000..4326aee
--- /dev/null
+++ b/docs/consumedapis.rst
@@ -0,0 +1,99 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Consumed APIs
+=============
+VID consumes the following APIs from other components:
+
+SDC
+----
+
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| /sdc/v1/catalog/services/meta                                                                                                 | Get available services                                                 |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| /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 a 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 owner 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 data regarding an instance and the instance's related nodes        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| GET aai/v11/                                                                                                                  | Get AIC zones for a 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 a custom query and has multiple types(declared in the url line)|
+|   “query/vnfFromModelbyRegion?cloudRegionId”,”                                                                                |                                                                        |
+|   vnf-topology-fromServiceInstance”)                                                                                          |                                                                        |
++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
+| Aai/v11/                                                                                                                      | Get the 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