| Stavros Kanarakis | 596e7c0 | 2019-04-04 13:55:13 +0300 | [diff] [blame] | 1 | --- |
| 2 | swagger: '2.0' |
| 3 | info: |
| 4 | description: This page lists bbs-event-processor REST API details |
| 5 | version: '1.0' |
| 6 | title: BBS Event Processor |
| 7 | host: localhost:32100 |
| 8 | basePath: "/" |
| 9 | tags: |
| 10 | - name: bbs-event-processor-controller |
| 11 | description: Manage bbs-event-processor microService |
| 12 | paths: |
| 13 | "/cancel-tasks": |
| 14 | post: |
| 15 | tags: |
| 16 | - bbs-event-processor-controller |
| 17 | summary: Returns result of request to cancel running microservice tasks |
| 18 | operationId: cancelTasksUsingPOST |
| 19 | consumes: |
| 20 | - application/json |
| 21 | produces: |
| 22 | - "*/*" |
| 23 | responses: |
| 24 | '200': |
| 25 | description: Tasks were successfully cancelled |
| 26 | schema: |
| 27 | "$ref": "#/definitions/Mono«ResponseEntity«string»»" |
| 28 | '201': |
| 29 | description: Created |
| 30 | '401': |
| 31 | description: Not authorized to view the resource |
| 32 | '403': |
| 33 | description: Resource access is forbidden |
| 34 | '404': |
| 35 | description: Resource is not found |
| 36 | '406': |
| 37 | description: Cancellation failed. Check logs |
| 38 | "/heartbeat": |
| 39 | get: |
| 40 | tags: |
| 41 | - bbs-event-processor-controller |
| 42 | summary: Returns liveness of bbs-event-processor microService |
| 43 | operationId: handleHeartBeatUsingGET |
| 44 | produces: |
| 45 | - "*/*" |
| 46 | responses: |
| 47 | '200': |
| 48 | description: bbs-event-processor microService is alive |
| 49 | schema: |
| 50 | "$ref": "#/definitions/Mono«ResponseEntity«string»»" |
| 51 | '401': |
| 52 | description: Not authorized to view the resource |
| 53 | '403': |
| 54 | description: Resource access is forbidden |
| 55 | '404': |
| 56 | description: Resource is not found |
| 57 | "/logging/{level}": |
| 58 | post: |
| 59 | tags: |
| 60 | - bbs-event-processor-controller |
| 61 | summary: Returns result of request to change application logging level |
| 62 | operationId: changeLoggingLevelUsingPOST |
| 63 | consumes: |
| 64 | - application/json |
| 65 | produces: |
| 66 | - "*/*" |
| 67 | parameters: |
| 68 | - name: level |
| 69 | in: path |
| 70 | description: level |
| 71 | required: true |
| 72 | type: string |
| 73 | responses: |
| 74 | '200': |
| 75 | description: Application logging level was successfully changed |
| 76 | schema: |
| 77 | "$ref": "#/definitions/Mono«ResponseEntity«string»»" |
| 78 | '201': |
| 79 | description: Created |
| 80 | '401': |
| 81 | description: Unauthorized |
| 82 | '403': |
| 83 | description: Forbidden |
| 84 | '404': |
| 85 | description: Not Found |
| 86 | '406': |
| 87 | description: Application logging level change failure. Check logs |
| 88 | "/poll-cpe-authentication-events": |
| 89 | post: |
| 90 | tags: |
| 91 | - bbs-event-processor-controller |
| 92 | summary: Returns result of request submission. CPE authentication polling will |
| 93 | occur asynchronously |
| 94 | operationId: handleCpeAuthenticationRestCallUsingPOST |
| 95 | consumes: |
| 96 | - application/json |
| 97 | produces: |
| 98 | - "*/*" |
| 99 | responses: |
| 100 | '200': |
| 101 | description: CPE authentication task submitted successfully |
| 102 | schema: |
| 103 | "$ref": "#/definitions/Mono«ResponseEntity«string»»" |
| 104 | '201': |
| 105 | description: Created |
| 106 | '401': |
| 107 | description: Not authorized to view the resource |
| 108 | '403': |
| 109 | description: Resource access is forbidden |
| 110 | '404': |
| 111 | description: Resource is not found |
| 112 | "/poll-reregistration-events": |
| 113 | post: |
| 114 | tags: |
| 115 | - bbs-event-processor-controller |
| 116 | summary: Returns result of request submission. PNF re-registration polling will |
| 117 | occur asynchronously |
| 118 | operationId: handleReRegistrationRestCallUsingPOST |
| 119 | consumes: |
| 120 | - application/json |
| 121 | produces: |
| 122 | - "*/*" |
| 123 | responses: |
| 124 | '200': |
| 125 | description: Polling Re-registration events task submitted successfully |
| 126 | schema: |
| 127 | "$ref": "#/definitions/Mono«ResponseEntity«string»»" |
| 128 | '201': |
| 129 | description: Created |
| 130 | '401': |
| 131 | description: Not authorized to view the resource |
| 132 | '403': |
| 133 | description: Resource access is forbidden |
| 134 | '404': |
| 135 | description: Resource is not found |
| 136 | "/start-tasks": |
| 137 | post: |
| 138 | tags: |
| 139 | - bbs-event-processor-controller |
| 140 | summary: Returns result of request to start microservice tasks |
| 141 | operationId: reScheduleTasksUsingPOST |
| 142 | consumes: |
| 143 | - application/json |
| 144 | produces: |
| 145 | - "*/*" |
| 146 | responses: |
| 147 | '200': |
| 148 | description: Tasks were successfully started |
| 149 | schema: |
| 150 | "$ref": "#/definitions/Mono«ResponseEntity«string»»" |
| 151 | '201': |
| 152 | description: Created |
| 153 | '401': |
| 154 | description: Not authorized to view the resource |
| 155 | '403': |
| 156 | description: Resource access is forbidden |
| 157 | '404': |
| 158 | description: Resource is not found |
| 159 | '406': |
| 160 | description: Task initiation failed. Check logs |
| 161 | definitions: |
| 162 | Mono«ResponseEntity«string»»: |
| 163 | type: object |
| 164 | title: Mono«ResponseEntity«string»» |