aboutsummaryrefslogtreecommitdiffstats
path: root/docs/modules
diff options
context:
space:
mode:
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/modules.rst7
-rw-r--r--docs/modules/onapsdk.aai.business.rst109
-rw-r--r--docs/modules/onapsdk.aai.cloud_infrastructure.rst37
-rw-r--r--docs/modules/onapsdk.aai.rst46
-rw-r--r--docs/modules/onapsdk.cds.rst53
-rw-r--r--docs/modules/onapsdk.clamp.rst29
-rw-r--r--docs/modules/onapsdk.configuration.rst29
-rw-r--r--docs/modules/onapsdk.cps.rst45
-rw-r--r--docs/modules/onapsdk.dmaap.rst29
-rw-r--r--docs/modules/onapsdk.msb.k8s.rst37
-rw-r--r--docs/modules/onapsdk.msb.rst45
-rw-r--r--docs/modules/onapsdk.nbi.rst21
-rw-r--r--docs/modules/onapsdk.rst65
-rw-r--r--docs/modules/onapsdk.sdc.rst101
-rw-r--r--docs/modules/onapsdk.sdnc.rst29
-rw-r--r--docs/modules/onapsdk.so.rst45
-rw-r--r--docs/modules/onapsdk.utils.rst53
-rw-r--r--docs/modules/onapsdk.ves.rst29
-rw-r--r--docs/modules/onapsdk.vid.rst21
19 files changed, 830 insertions, 0 deletions
diff --git a/docs/modules/modules.rst b/docs/modules/modules.rst
new file mode 100644
index 0000000..e66ce77
--- /dev/null
+++ b/docs/modules/modules.rst
@@ -0,0 +1,7 @@
+onapsdk
+=======
+
+.. toctree::
+ :maxdepth: 4
+
+ onapsdk
diff --git a/docs/modules/onapsdk.aai.business.rst b/docs/modules/onapsdk.aai.business.rst
new file mode 100644
index 0000000..1bec9ac
--- /dev/null
+++ b/docs/modules/onapsdk.aai.business.rst
@@ -0,0 +1,109 @@
+onapsdk.aai.business package
+============================
+
+Submodules
+----------
+
+onapsdk.aai.business.customer module
+------------------------------------
+
+.. automodule:: onapsdk.aai.business.customer
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.instance module
+------------------------------------
+
+.. automodule:: onapsdk.aai.business.instance
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.line\_of\_business module
+----------------------------------------------
+
+.. automodule:: onapsdk.aai.business.line_of_business
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.network module
+-----------------------------------
+
+.. automodule:: onapsdk.aai.business.network
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.owning\_entity module
+------------------------------------------
+
+.. automodule:: onapsdk.aai.business.owning_entity
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.platform module
+------------------------------------
+
+.. automodule:: onapsdk.aai.business.platform
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.pnf module
+-------------------------------
+
+.. automodule:: onapsdk.aai.business.pnf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.project module
+-----------------------------------
+
+.. automodule:: onapsdk.aai.business.project
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.service module
+-----------------------------------
+
+.. automodule:: onapsdk.aai.business.service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.sp\_partner module
+---------------------------------------
+
+.. automodule:: onapsdk.aai.business.sp_partner
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.vf\_module module
+--------------------------------------
+
+.. automodule:: onapsdk.aai.business.vf_module
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.business.vnf module
+-------------------------------
+
+.. automodule:: onapsdk.aai.business.vnf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.aai.business
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.aai.cloud_infrastructure.rst b/docs/modules/onapsdk.aai.cloud_infrastructure.rst
new file mode 100644
index 0000000..307676b
--- /dev/null
+++ b/docs/modules/onapsdk.aai.cloud_infrastructure.rst
@@ -0,0 +1,37 @@
+onapsdk.aai.cloud\_infrastructure package
+=========================================
+
+Submodules
+----------
+
+onapsdk.aai.cloud\_infrastructure.cloud\_region module
+------------------------------------------------------
+
+.. automodule:: onapsdk.aai.cloud_infrastructure.cloud_region
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.cloud\_infrastructure.complex module
+------------------------------------------------
+
+.. automodule:: onapsdk.aai.cloud_infrastructure.complex
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.cloud\_infrastructure.tenant module
+-----------------------------------------------
+
+.. automodule:: onapsdk.aai.cloud_infrastructure.tenant
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.aai.cloud_infrastructure
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.aai.rst b/docs/modules/onapsdk.aai.rst
new file mode 100644
index 0000000..161e291
--- /dev/null
+++ b/docs/modules/onapsdk.aai.rst
@@ -0,0 +1,46 @@
+onapsdk.aai package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ onapsdk.aai.business
+ onapsdk.aai.cloud_infrastructure
+
+Submodules
+----------
+
+onapsdk.aai.aai\_element module
+-------------------------------
+
+.. automodule:: onapsdk.aai.aai_element
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.bulk module
+-----------------------
+
+.. automodule:: onapsdk.aai.bulk
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.aai.service\_design\_and\_creation module
+-------------------------------------------------
+
+.. automodule:: onapsdk.aai.service_design_and_creation
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.aai
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.cds.rst b/docs/modules/onapsdk.cds.rst
new file mode 100644
index 0000000..c0b8d51
--- /dev/null
+++ b/docs/modules/onapsdk.cds.rst
@@ -0,0 +1,53 @@
+onapsdk.cds package
+===================
+
+Submodules
+----------
+
+onapsdk.cds.blueprint module
+----------------------------
+
+.. automodule:: onapsdk.cds.blueprint
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.cds.blueprint\_model module
+-----------------------------------
+
+.. automodule:: onapsdk.cds.blueprint_model
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.cds.blueprint\_processor module
+---------------------------------------
+
+.. automodule:: onapsdk.cds.blueprint_processor
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.cds.cds\_element module
+-------------------------------
+
+.. automodule:: onapsdk.cds.cds_element
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.cds.data\_dictionary module
+-----------------------------------
+
+.. automodule:: onapsdk.cds.data_dictionary
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.cds
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.clamp.rst b/docs/modules/onapsdk.clamp.rst
new file mode 100644
index 0000000..65d9888
--- /dev/null
+++ b/docs/modules/onapsdk.clamp.rst
@@ -0,0 +1,29 @@
+onapsdk.clamp package
+=====================
+
+Submodules
+----------
+
+onapsdk.clamp.clamp\_element module
+-----------------------------------
+
+.. automodule:: onapsdk.clamp.clamp_element
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.clamp.loop\_instance module
+-----------------------------------
+
+.. automodule:: onapsdk.clamp.loop_instance
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.clamp
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.configuration.rst b/docs/modules/onapsdk.configuration.rst
new file mode 100644
index 0000000..4833ad3
--- /dev/null
+++ b/docs/modules/onapsdk.configuration.rst
@@ -0,0 +1,29 @@
+onapsdk.configuration package
+=============================
+
+Submodules
+----------
+
+onapsdk.configuration.global\_settings module
+---------------------------------------------
+
+.. automodule:: onapsdk.configuration.global_settings
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.configuration.loader module
+-----------------------------------
+
+.. automodule:: onapsdk.configuration.loader
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.configuration
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.cps.rst b/docs/modules/onapsdk.cps.rst
new file mode 100644
index 0000000..a65d0d4
--- /dev/null
+++ b/docs/modules/onapsdk.cps.rst
@@ -0,0 +1,45 @@
+onapsdk.cps package
+===================
+
+Submodules
+----------
+
+onapsdk.cps.anchor module
+-------------------------
+
+.. automodule:: onapsdk.cps.anchor
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.cps.cps\_element module
+-------------------------------
+
+.. automodule:: onapsdk.cps.cps_element
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.cps.dataspace module
+----------------------------
+
+.. automodule:: onapsdk.cps.dataspace
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.cps.schemaset module
+----------------------------
+
+.. automodule:: onapsdk.cps.schemaset
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.cps
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.dmaap.rst b/docs/modules/onapsdk.dmaap.rst
new file mode 100644
index 0000000..dc17d2e
--- /dev/null
+++ b/docs/modules/onapsdk.dmaap.rst
@@ -0,0 +1,29 @@
+onapsdk.dmaap package
+=====================
+
+Submodules
+----------
+
+onapsdk.dmaap.dmaap module
+--------------------------
+
+.. automodule:: onapsdk.dmaap.dmaap
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.dmaap.dmaap\_service module
+-----------------------------------
+
+.. automodule:: onapsdk.dmaap.dmaap_service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.dmaap
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.msb.k8s.rst b/docs/modules/onapsdk.msb.k8s.rst
new file mode 100644
index 0000000..aaba76a
--- /dev/null
+++ b/docs/modules/onapsdk.msb.k8s.rst
@@ -0,0 +1,37 @@
+onapsdk.msb.k8s package
+=======================
+
+Submodules
+----------
+
+onapsdk.msb.k8s.connectivity\_info module
+-----------------------------------------
+
+.. automodule:: onapsdk.msb.k8s.connectivity_info
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.msb.k8s.definition module
+---------------------------------
+
+.. automodule:: onapsdk.msb.k8s.definition
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.msb.k8s.instance module
+-------------------------------
+
+.. automodule:: onapsdk.msb.k8s.instance
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.msb.k8s
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.msb.rst b/docs/modules/onapsdk.msb.rst
new file mode 100644
index 0000000..eeea5b7
--- /dev/null
+++ b/docs/modules/onapsdk.msb.rst
@@ -0,0 +1,45 @@
+onapsdk.msb package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ onapsdk.msb.k8s
+
+Submodules
+----------
+
+onapsdk.msb.esr module
+----------------------
+
+.. automodule:: onapsdk.msb.esr
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.msb.msb\_service module
+-------------------------------
+
+.. automodule:: onapsdk.msb.msb_service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.msb.multicloud module
+-----------------------------
+
+.. automodule:: onapsdk.msb.multicloud
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.msb
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.nbi.rst b/docs/modules/onapsdk.nbi.rst
new file mode 100644
index 0000000..b0a68b5
--- /dev/null
+++ b/docs/modules/onapsdk.nbi.rst
@@ -0,0 +1,21 @@
+onapsdk.nbi package
+===================
+
+Submodules
+----------
+
+onapsdk.nbi.nbi module
+----------------------
+
+.. automodule:: onapsdk.nbi.nbi
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.nbi
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.rst b/docs/modules/onapsdk.rst
new file mode 100644
index 0000000..77e5575
--- /dev/null
+++ b/docs/modules/onapsdk.rst
@@ -0,0 +1,65 @@
+onapsdk package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ onapsdk.aai
+ onapsdk.cds
+ onapsdk.clamp
+ onapsdk.configuration
+ onapsdk.dmaap
+ onapsdk.msb
+ onapsdk.nbi
+ onapsdk.sdc
+ onapsdk.sdnc
+ onapsdk.so
+ onapsdk.utils
+ onapsdk.ves
+ onapsdk.vid
+
+Submodules
+----------
+
+onapsdk.constants module
+------------------------
+
+.. automodule:: onapsdk.constants
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.exceptions module
+-------------------------
+
+.. automodule:: onapsdk.exceptions
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.onap\_service module
+----------------------------
+
+.. automodule:: onapsdk.onap_service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.version module
+----------------------
+
+.. automodule:: onapsdk.version
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.sdc.rst b/docs/modules/onapsdk.sdc.rst
new file mode 100644
index 0000000..5ba5ec3
--- /dev/null
+++ b/docs/modules/onapsdk.sdc.rst
@@ -0,0 +1,101 @@
+onapsdk.sdc package
+===================
+
+Submodules
+----------
+
+onapsdk.sdc.category\_management module
+---------------------------------------
+
+.. automodule:: onapsdk.sdc.category_management
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdc.component module
+----------------------------
+
+.. automodule:: onapsdk.sdc.component
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdc.pnf module
+----------------------
+
+.. automodule:: onapsdk.sdc.pnf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdc.properties module
+-----------------------------
+
+.. automodule:: onapsdk.sdc.properties
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdc.sdc\_element module
+-------------------------------
+
+.. automodule:: onapsdk.sdc.sdc_element
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdc.sdc\_resource module
+--------------------------------
+
+.. automodule:: onapsdk.sdc.sdc_resource
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdc.service module
+--------------------------
+
+.. automodule:: onapsdk.sdc.service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdc.vendor module
+-------------------------
+
+.. automodule:: onapsdk.sdc.vendor
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdc.vf module
+---------------------
+
+.. automodule:: onapsdk.sdc.vf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdc.vl module
+---------------------
+
+.. automodule:: onapsdk.sdc.vl
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdc.vsp module
+----------------------
+
+.. automodule:: onapsdk.sdc.vsp
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.sdc
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.sdnc.rst b/docs/modules/onapsdk.sdnc.rst
new file mode 100644
index 0000000..2a87163
--- /dev/null
+++ b/docs/modules/onapsdk.sdnc.rst
@@ -0,0 +1,29 @@
+onapsdk.sdnc package
+====================
+
+Submodules
+----------
+
+onapsdk.sdnc.preload module
+---------------------------
+
+.. automodule:: onapsdk.sdnc.preload
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.sdnc.sdnc\_element module
+---------------------------------
+
+.. automodule:: onapsdk.sdnc.sdnc_element
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.sdnc
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.so.rst b/docs/modules/onapsdk.so.rst
new file mode 100644
index 0000000..eae1eda
--- /dev/null
+++ b/docs/modules/onapsdk.so.rst
@@ -0,0 +1,45 @@
+onapsdk.so package
+==================
+
+Submodules
+----------
+
+onapsdk.so.deletion module
+--------------------------
+
+.. automodule:: onapsdk.so.deletion
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.so.instantiation module
+-------------------------------
+
+.. automodule:: onapsdk.so.instantiation
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.so.so\_db\_adapter module
+---------------------------------
+
+.. automodule:: onapsdk.so.so_db_adapter
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.so.so\_element module
+-----------------------------
+
+.. automodule:: onapsdk.so.so_element
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.so
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.utils.rst b/docs/modules/onapsdk.utils.rst
new file mode 100644
index 0000000..cbb4c73
--- /dev/null
+++ b/docs/modules/onapsdk.utils.rst
@@ -0,0 +1,53 @@
+onapsdk.utils package
+=====================
+
+Submodules
+----------
+
+onapsdk.utils.configuration module
+----------------------------------
+
+.. automodule:: onapsdk.utils.configuration
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.utils.headers\_creator module
+-------------------------------------
+
+.. automodule:: onapsdk.utils.headers_creator
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.utils.jinja module
+--------------------------
+
+.. automodule:: onapsdk.utils.jinja
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.utils.mixins module
+---------------------------
+
+.. automodule:: onapsdk.utils.mixins
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.utils.tosca\_file\_handler module
+-----------------------------------------
+
+.. automodule:: onapsdk.utils.tosca_file_handler
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.ves.rst b/docs/modules/onapsdk.ves.rst
new file mode 100644
index 0000000..51a4c6b
--- /dev/null
+++ b/docs/modules/onapsdk.ves.rst
@@ -0,0 +1,29 @@
+onapsdk.ves package
+===================
+
+Submodules
+----------
+
+onapsdk.ves.ves module
+----------------------
+
+.. automodule:: onapsdk.ves.ves
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+onapsdk.ves.ves\_service module
+-------------------------------
+
+.. automodule:: onapsdk.ves.ves_service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.ves
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/modules/onapsdk.vid.rst b/docs/modules/onapsdk.vid.rst
new file mode 100644
index 0000000..36a6705
--- /dev/null
+++ b/docs/modules/onapsdk.vid.rst
@@ -0,0 +1,21 @@
+onapsdk.vid package
+===================
+
+Submodules
+----------
+
+onapsdk.vid.vid module
+----------------------
+
+.. automodule:: onapsdk.vid.vid
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: onapsdk.vid
+ :members:
+ :undoc-members:
+ :show-inheritance: