diff options
| author |   Eric Debeau <eric.debeau@orange.com> | 2019-05-14 17:45:22 +0000 |
|---|---|---|
| committer | Eric Debeau <eric.debeau@orange.com> | 2019-05-16 13:58:23 +0000 |
| commit | 1af30536774a0872b180f6c74a3e4ed487218747 (patch) | |
| tree | bd09e30c08462cd1a032ca21ac6c5aac54ef1399 /docs/sections/apis/pmmapper.rst | |
| parent | b643761e44851acf519fa039e11c2f413e7a25aa (diff) | |
Integration with Swagger
Correct doc8 errors
Add licence in RST
Add API table
Add swaggerv2doc when OK
Issue-ID: DCAEGEN2-1049
Change-Id: I7478b1c34625ce03ee4f1278a04a408f6f73718e
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Diffstat (limited to 'docs/sections/apis/pmmapper.rst')
| -rw-r--r-- | docs/sections/apis/pmmapper.rst | 21 |
1 files changed, 8 insertions, 13 deletions
diff --git a/docs/sections/apis/pmmapper.rst b/docs/sections/apis/pmmapper.rst index 6b736e36..5da8bf16 100644 --- a/docs/sections/apis/pmmapper.rst +++ b/docs/sections/apis/pmmapper.rst @@ -1,12 +1,12 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + ======================== 3GPP PM Mapper ======================== .. contents:: :depth: 3 -.. Overview ======== @@ -15,7 +15,6 @@ Component description can be found under `3GPP PM Mapper`_. .. _3GPP PM Mapper: ../../sections/services/pm-mapper/index.html - Paths ===== @@ -26,7 +25,6 @@ Description ~~~~~~~~~~~ Publish the PM Measurment file to PM Mapper. - Responses ~~~~~~~~~ @@ -36,15 +34,14 @@ Responses | **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, the server is either dead or no connection to pm mapper. +This is the health check endpoint. If this returns a 200, the server is alive. +If anything other than a 200, the server is either dead or no connection to +pm mapper. Responses ~~~~~~~~~ @@ -55,15 +52,13 @@ Responses | **200** | successful response | +-----------+---------------------+ - GET ``/reconfigure`` -------------------- - - Description ~~~~~~~~~~~ -This is the reconfigure endpoint to fetch updated config information using config binding service. +This is the reconfigure endpoint to fetch updated config information using +config binding service. Responses ~~~~~~~~~ |