docs/sections/apis/PRH.yaml

   1 ---
   2 swagger: '2.0'
   3 info:
   4   description: This page lists all the rest apis for PRH app server.
   5   version: '1.0'
   6   title: PRH app server
   7 host: localhost:8100
   8 basePath: "/"
   9 tags:
  10 - name: heartbeat-controller
  11   description: Check liveness of PRH service
  12 - name: schedule-controller
  13   description: Schedule Controller
  14 paths:
  15   "/heartbeat":
  16     get:
  17       tags:
  18       - heartbeat-controller
  19       summary: Returns liveness of PRH service
  20       operationId: heartbeatUsingGET
  21       produces:
  22       - "*/*"
  23       responses:
  24         '200':
  25           description: PRH sevice is living
  26           schema:
  27             "$ref": "#/definitions/Mono«ResponseEntity«string»»"
  28         '401':
  29           description: You are not authorized to view the resource
  30         '403':
  31           description: Accessing the resource you were trying to reach is forbidden
  32         '404':
  33           description: The resource you were trying to reach is not found
  34   "/start":
  35     get:
  36       tags:
  37       - schedule-controller
  38       summary: Start scheduling worker request
  39       operationId: startTasksUsingGET
  40       produces:
  41       - "*/*"
  42       responses:
  43         '200':
  44           description: OK
  45           schema:
  46             "$ref": "#/definitions/Mono«ResponseEntity«string»»"
  47         '401':
  48           description: Unauthorized
  49         '403':
  50           description: Forbidden
  51         '404':
  52           description: Not Found
  53   "/stopPrh":
  54     get:
  55       tags:
  56       - schedule-controller
  57       summary: Stop scheduling worker request
  58       operationId: stopTaskUsingGET
  59       produces:
  60       - "*/*"
  61       responses:
  62         '200':
  63           description: OK
  64           schema:
  65             "$ref": "#/definitions/Mono«ResponseEntity«string»»"
  66         '401':
  67           description: Unauthorized
  68         '403':
  69           description: Forbidden
  70         '404':
  71           description: Not Found
  72 definitions:
  73   Mono«ResponseEntity«string»»:
  74     type: object
  75     title: Mono«ResponseEntity«string»»
  76