From 596e7c047dde2a04d9deb20b99f0312b9e762141 Mon Sep 17 00:00:00 2001 From: Stavros Kanarakis Date: Thu, 4 Apr 2019 13:55:13 +0300 Subject: Documentation stubs for BBS-ep Change-Id: Id32f23c1cd74cb6209f1ab6babba47c716e17400 Issue-ID: DCAEGEN2-1393 Signed-off-by: Stavros Kanarakis --- .../bbs-event-processor/development_info.rst | 30 ++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/sections/services/bbs-event-processor/development_info.rst (limited to 'docs/sections/services/bbs-event-processor/development_info.rst') diff --git a/docs/sections/services/bbs-event-processor/development_info.rst b/docs/sections/services/bbs-event-processor/development_info.rst new file mode 100644 index 00000000..4f4b4b1b --- /dev/null +++ b/docs/sections/services/bbs-event-processor/development_info.rst @@ -0,0 +1,30 @@ +Compiling BBS-EP +================ + +BBS-ep is a sub-project of dcaegen2/services (inside components directory). +To build just the BBS-ep component, run the following maven command from within **components/bbs-event-processor** directory +`mvn clean install` + + +API Endpoints +============= + +Running with dev-mode of BBS-EP + - Heartbeat: **GET http://:8100/heartbeat** + - Start Polling for events: **POST http://:8100/start-tasks** + - Stop Polling for events: **POST http://:8100/cancel-tasks** + - Execute just one polling for PNF re-registration internal events: **POST http://:8100/poll-reregistration-events** + - Execute just one polling for CPE authentication events: **POST http://:8100/poll-cpe-authentication-events** + - Change application logging level: **POST http://:8100/logging/{level}** + +More detailed API specifications can be found in :doc:`../../apis/swagger-bbs-event-processor`. + +Maven GroupId: +============== + +org.onap.dcaegen2.services.components + +Maven Parent ArtifactId: +======================== + +org.onap.oparen:oparent:1.2.3 \ No newline at end of file -- cgit 1.2.3-korg