summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/ves-openapi-manager/index.rst
diff options
context:
space:
mode:
authorMichal Banka <michal.banka@nokia.com>2021-03-10 14:30:09 +0100
committerMichal Banka <michal.banka@nokia.com>2021-03-15 09:14:44 +0100
commit5fb2f1d247be63de9e567c2fa0da3d3f0f1b4601 (patch)
treec92ef21a3ee2cfda1cbebf57dd749aa1d4ed1539 /docs/sections/services/ves-openapi-manager/index.rst
parentbcbf98beec6118acad4584d99ebef900f386690b (diff)
Add ves-openapi-manager documentation
Signed-off-by: Michal Banka <michal.banka@nokia.com> Change-Id: I84294800070ddbec7bee1bc3ea4ac63df076cc53 Issue-ID: DCAEGEN2-2571
Diffstat (limited to 'docs/sections/services/ves-openapi-manager/index.rst')
-rw-r--r--docs/sections/services/ves-openapi-manager/index.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/sections/services/ves-openapi-manager/index.rst b/docs/sections/services/ves-openapi-manager/index.rst
new file mode 100644
index 00000000..e6cc15c3
--- /dev/null
+++ b/docs/sections/services/ves-openapi-manager/index.rst
@@ -0,0 +1,27 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+VES OpenAPI Manager
+===================
+
+VES OpenAPI Manager has been created to validate the presence of OpenAPI schemas declared in *VES_EVENT* type artifacts,
+within the DCAE run-time environment during Service Model distribution in SDC. When deployed, it automatically listens
+to events of Service Models distributions by using SDC Distribution Client in order to read the declared OpenAPI
+descriptions. Purpose of this component is to partially validate artifacts of type *VES_EVENT* from Resources of
+distributed services. During validation phase it checks whether *stndDefined* events defined in VES_EVENT type artifact,
+contain only *schemaReferences* that local copies are accessible by DCAE VES Collector. If any of schemaReference is
+absent in local externalSchema repository, the VES OpenAPI Manager informs ONAP user which schemas need to be uploaded
+to the DCAE run-time environment.
+
+
+VES OpenAPI Manager overview and functions
+------------------------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ ./architecture.rst
+ ./artifacts.rst
+ ./deployment.rst
+ ./use-cases.rst