summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis
diff options
context:
space:
mode:
authorStavros Kanarakis <stavros.kanarakis@nokia.com>2019-04-04 13:55:13 +0300
committerStavros Kanarakis <stavros.kanarakis@nokia.com>2019-04-11 12:57:37 +0300
commit596e7c047dde2a04d9deb20b99f0312b9e762141 (patch)
treeea1c2e1775476b6dc3a76af2b25fffa2914f1cca /docs/sections/apis
parent580eae246a3ac7bf9533df96d20c0fc9b5425d3c (diff)
Documentation stubs for BBS-ep
Change-Id: Id32f23c1cd74cb6209f1ab6babba47c716e17400 Issue-ID: DCAEGEN2-1393 Signed-off-by: Stavros Kanarakis <stavros.kanarakis@nokia.com>
Diffstat (limited to 'docs/sections/apis')
-rw-r--r--docs/sections/apis/swagger-bbs-event-processor.yaml164
1 files changed, 164 insertions, 0 deletions
diff --git a/docs/sections/apis/swagger-bbs-event-processor.yaml b/docs/sections/apis/swagger-bbs-event-processor.yaml
new file mode 100644
index 00000000..d1fa002d
--- /dev/null
+++ b/docs/sections/apis/swagger-bbs-event-processor.yaml
@@ -0,0 +1,164 @@
+---
+swagger: '2.0'
+info:
+ description: This page lists bbs-event-processor REST API details
+ version: '1.0'
+ title: BBS Event Processor
+host: localhost:32100
+basePath: "/"
+tags:
+- name: bbs-event-processor-controller
+ description: Manage bbs-event-processor microService
+paths:
+ "/cancel-tasks":
+ post:
+ tags:
+ - bbs-event-processor-controller
+ summary: Returns result of request to cancel running microservice tasks
+ operationId: cancelTasksUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - "*/*"
+ responses:
+ '200':
+ description: Tasks were successfully cancelled
+ schema:
+ "$ref": "#/definitions/Mono«ResponseEntity«string»»"
+ '201':
+ description: Created
+ '401':
+ description: Not authorized to view the resource
+ '403':
+ description: Resource access is forbidden
+ '404':
+ description: Resource is not found
+ '406':
+ description: Cancellation failed. Check logs
+ "/heartbeat":
+ get:
+ tags:
+ - bbs-event-processor-controller
+ summary: Returns liveness of bbs-event-processor microService
+ operationId: handleHeartBeatUsingGET
+ produces:
+ - "*/*"
+ responses:
+ '200':
+ description: bbs-event-processor microService is alive
+ schema:
+ "$ref": "#/definitions/Mono«ResponseEntity«string»»"
+ '401':
+ description: Not authorized to view the resource
+ '403':
+ description: Resource access is forbidden
+ '404':
+ description: Resource is not found
+ "/logging/{level}":
+ post:
+ tags:
+ - bbs-event-processor-controller
+ summary: Returns result of request to change application logging level
+ operationId: changeLoggingLevelUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - "*/*"
+ parameters:
+ - name: level
+ in: path
+ description: level
+ required: true
+ type: string
+ responses:
+ '200':
+ description: Application logging level was successfully changed
+ schema:
+ "$ref": "#/definitions/Mono«ResponseEntity«string»»"
+ '201':
+ description: Created
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ '406':
+ description: Application logging level change failure. Check logs
+ "/poll-cpe-authentication-events":
+ post:
+ tags:
+ - bbs-event-processor-controller
+ summary: Returns result of request submission. CPE authentication polling will
+ occur asynchronously
+ operationId: handleCpeAuthenticationRestCallUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - "*/*"
+ responses:
+ '200':
+ description: CPE authentication task submitted successfully
+ schema:
+ "$ref": "#/definitions/Mono«ResponseEntity«string»»"
+ '201':
+ description: Created
+ '401':
+ description: Not authorized to view the resource
+ '403':
+ description: Resource access is forbidden
+ '404':
+ description: Resource is not found
+ "/poll-reregistration-events":
+ post:
+ tags:
+ - bbs-event-processor-controller
+ summary: Returns result of request submission. PNF re-registration polling will
+ occur asynchronously
+ operationId: handleReRegistrationRestCallUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - "*/*"
+ responses:
+ '200':
+ description: Polling Re-registration events task submitted successfully
+ schema:
+ "$ref": "#/definitions/Mono«ResponseEntity«string»»"
+ '201':
+ description: Created
+ '401':
+ description: Not authorized to view the resource
+ '403':
+ description: Resource access is forbidden
+ '404':
+ description: Resource is not found
+ "/start-tasks":
+ post:
+ tags:
+ - bbs-event-processor-controller
+ summary: Returns result of request to start microservice tasks
+ operationId: reScheduleTasksUsingPOST
+ consumes:
+ - application/json
+ produces:
+ - "*/*"
+ responses:
+ '200':
+ description: Tasks were successfully started
+ schema:
+ "$ref": "#/definitions/Mono«ResponseEntity«string»»"
+ '201':
+ description: Created
+ '401':
+ description: Not authorized to view the resource
+ '403':
+ description: Resource access is forbidden
+ '404':
+ description: Resource is not found
+ '406':
+ description: Task initiation failed. Check logs
+definitions:
+ Mono«ResponseEntity«string»»:
+ type: object
+ title: Mono«ResponseEntity«string»»