summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis/swagger-bbs-event-processor.yaml
blob: d1fa002d2af0215f60c7a83bad33717a036c59dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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»»