diff options
| author |   pwielebs <piotr.wielebski@nokia.com> | 2018-09-13 13:49:33 +0200 |
|---|---|---|
| committer | pwielebs <piotr.wielebski@nokia.com> | 2018-09-13 13:56:41 +0200 |
| commit | 3d7081f169f4b0e971f4259b5245861cc2f7c82a (patch) | |
| tree | 3620af3cc7eaf39773ee15dd0c9d0d076d6ebbdf /docs/sections/apis/PRH.yaml | |
| parent | b4cb363a95cb12a6c176b8fe77f0271546f0dc09 (diff) | |
User documentation added
Change-Id: Ic5a14b247123a94fcfb1348b372d1603b6c26107
Issue-ID: DCAEGEN2-398
Signed-off-by: pwielebs <piotr.wielebski@nokia.com>
Diffstat (limited to 'docs/sections/apis/PRH.yaml')
| -rw-r--r-- | docs/sections/apis/PRH.yaml | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/docs/sections/apis/PRH.yaml b/docs/sections/apis/PRH.yaml new file mode 100644 index 00000000..37040bc8 --- /dev/null +++ b/docs/sections/apis/PRH.yaml @@ -0,0 +1,76 @@ +--- +swagger: '2.0' +info: + description: This page lists all the rest apis for PRH app server. + version: '1.0' + title: PRH app server +host: localhost:8100 +basePath: "/" +tags: +- name: heartbeat-controller + description: Check liveness of PRH service +- name: schedule-controller + description: Schedule Controller +paths: + "/heartbeat": + get: + tags: + - heartbeat-controller + summary: Returns liveness of PRH service + operationId: heartbeatUsingGET + produces: + - "*/*" + responses: + '200': + description: PRH sevice is living + schema: + "$ref": "#/definitions/Mono«ResponseEntity«string»»" + '401': + description: You are not authorized to view the resource + '403': + description: Accessing the resource you were trying to reach is forbidden + '404': + description: The resource you were trying to reach is not found + "/start": + get: + tags: + - schedule-controller + summary: Start scheduling worker request + operationId: startTasksUsingGET + produces: + - "*/*" + responses: + '200': + description: OK + schema: + "$ref": "#/definitions/Mono«ResponseEntity«string»»" + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + "/stopPrh": + get: + tags: + - schedule-controller + summary: Stop scheduling worker request + operationId: stopTaskUsingGET + produces: + - "*/*" + responses: + '200': + description: OK + schema: + "$ref": "#/definitions/Mono«ResponseEntity«string»»" + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found +definitions: + Mono«ResponseEntity«string»»: + type: object + title: Mono«ResponseEntity«string»» + |