docs/sections/services/ves-openapi-manager/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4
   5 VES OpenAPI Manager
   6 ===================
   7
   8 VES OpenAPI Manager has been created to validate the presence of OpenAPI schemas declared in *VES_EVENT* type artifacts,
   9 within the DCAE run-time environment during Service Model distribution in SDC. When deployed, it automatically listens
  10 to events of Service Models distributions by using SDC Distribution Client in order to read the declared OpenAPI
  11 descriptions. Purpose of this component is to partially validate artifacts of type *VES_EVENT* from Resources of
  12 distributed services. During validation phase it checks whether *stndDefined* events defined in VES_EVENT type artifact,
  13 contain only *schemaReferences* that local copies are accessible by DCAE VES Collector. If any of schemaReference is
  14 absent in local externalSchema repository, the VES OpenAPI Manager informs ONAP user which schemas need to be uploaded
  15 to the DCAE run-time environment.
  16
  17
  18 VES OpenAPI Manager overview and functions
  19 ------------------------------------------
  20
  21 .. toctree::
  22   :maxdepth: 1
  23
  24   ./architecture.rst
  25   ./artifacts.rst
  26   ./deployment.rst
  27   ./use-cases.rst