X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fpm%2Findex.rst;h=5b680b1e60d8907fd752774960e67f3809a9425e;hb=HEAD;hp=2ed6600983174d82ce47d6c7e01ff1a06289af57;hpb=2b8bb7bfd6f3586ecdf914ce4ed95f21dd0ee46b;p=oam%2Fnf-oam-adopter.git diff --git a/docs/pm/index.rst b/docs/pm/index.rst index 2ed6600..5b680b1 100644 --- a/docs/pm/index.rst +++ b/docs/pm/index.rst @@ -2,20 +2,16 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. +=============== PM REST Manager -############### +=============== PM REST Manager library follows `VES Event Listener 7.1 `_ -.. toctree:: - :maxdepth: 3 - :caption: Contents: - PM VES Message -============== +-------------- -Datatype: commonEventHeader -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Datatype: commonEventHeader** .. list-table:: :header-rows: 1 @@ -142,8 +138,7 @@ Datatype: commonEventHeader - none -Datatype: measurementFields -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Datatype: measurementFields** .. list-table:: :header-rows: 1 @@ -180,19 +175,17 @@ Datatype: measurementFields - none REST PM Configuration -===================== +--------------------- -Rest Adapter configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Rest Adapter configuration** Configuration file **application.yml** contains global definitions required to be consumed by PM REST adapters services. - **synchronization-time-start** Defines the time for execution of pull of PM files and forwarding as VES Message -- **synchronization-time-frequency** Defines the time for execution of pull of PM files and forwarding as VES Message +- **synchronization-time-frequency** Define the frequency to trigger the pull and forward of PM data after first execution. - **mapping-config-path** Defines the path where mapping configuration file is located -Rest SB Client Adapter configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Rest SB Client Adapter configuration** - **ran-token-endpoint** Defines rand endpoint from where token will be obtained - **ran-pm-endpoint:** Defines rand endpoint from where ZIP with PM files will be GET. @@ -202,7 +195,7 @@ Rest SB Client Adapter configuration :language: YAML Mapping Configuration -~~~~~~~~~~~~~~~~~~~~~ +--------------------- Configuration file **pm-ves-message-mapping.yaml** contains all definitions required to define the mapping from ZIP file with collection of csv files information to VES Message format @@ -231,20 +224,18 @@ from ZIP file with collection of csv files information to VES Message format :language: YAML PM Adapter Configuration -======================== +------------------------ PM Adapters can be instantiated at runtime -Create a PM Adapter -~~~~~~~~~~~~~~~~~~~ +**Create a PM Adapter** **POST** ``https://:/adapters/adapter`` .. literalinclude:: create-adapter.json :language: JSON -Get PM Adapters -~~~~~~~~~~~~~~~ +**Get PM Adapters** **GET** ``https://:/adapters/`` @@ -252,7 +243,6 @@ Get PM Adapters :language: JSON -Delete PM Adapter -~~~~~~~~~~~~~~~~~ +**Delete PM Adapter** **DELETE** ``https://:/adapters/adapter/10.53.40.50``