summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis
diff options
context:
space:
mode:
authorrajendrajaiswal <rajendra.jaiswal@ericsson.com>2019-02-18 17:20:26 +0000
committerrajendrajaiswal <rajendra.jaiswal@ericsson.com>2019-02-20 16:16:29 +0000
commitfdd14ecf4856426b95499d8a523dbb0b640e9768 (patch)
tree1af56fc9d66e0aeb8c0f76d9a185500ea835e9ef /docs/sections/apis
parent1c85755843786d77099dfa8459db7d3e8cf21701 (diff)
Documentation for 3GPP PM Mapper
Change-Id: Ifbc4928630a329eed019c1c79f129234dfa1fdd3 Issue-ID: DCAEGEN2-567 Signed-off-by: Rajendra Jaiswal <rajendra.jaiswal@ericsson.com>
Diffstat (limited to 'docs/sections/apis')
-rw-r--r--docs/sections/apis/pmmapper.rst56
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/sections/apis/pmmapper.rst b/docs/sections/apis/pmmapper.rst
new file mode 100644
index 00000000..1e9333a8
--- /dev/null
+++ b/docs/sections/apis/pmmapper.rst
@@ -0,0 +1,56 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+========================
+3GPP PM Mapper
+========================
+
+.. contents::
+ :depth: 3
+..
+
+Overview
+========
+
+Component description can be found under `3GPP PM Mapper`_.
+
+.. _3GPP PM Mapper: ../../sections/services/pm-mapper/index.html
+
+
+Paths
+=====
+
+PUT ``/delivery``
+---------------------------------------------------
+
+Description
+~~~~~~~~~~~
+Publish the PM Measurment file to PM Mapper.
+
+
+Responses
+~~~~~~~~~
+
++-----------+---------------------+
+| HTTP Code | Description |
++===========+=====================+
+| **200** | successful response |
++-----------+---------------------+
+
+
+GET ``/healthcheck``
+--------------------
+
+
+
+Description
+~~~~~~~~~~~
+This is the health check endpoint. If this returns a 200, the server is alive. If anything other than a 200, either dead, or no connection to pm mapper.
+
+Responses
+~~~~~~~~~
+
++-----------+---------------------+
+| HTTP Code | Description |
++===========+=====================+
+| **200** | successful response |
++-----------+---------------------+