docs/sections/apis/PRH.json

   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   },
   8   "host": "localhost:8100",
   9   "basePath": "/",
  10   "tags": [
  11     {
  12       "name": "heartbeat-controller",
  13       "description": "Check liveness of PRH service"
  14     },
  15     {
  16       "name": "schedule-controller",
  17       "description": "Schedule Controller"
  18     }
  19   ],
  20   "paths": {
  21     "/heartbeat": {
  22       "get": {
  23         "tags": [
  24           "heartbeat-controller"
  25         ],
  26         "summary": "Returns liveness of PRH service",
  27         "operationId": "heartbeatUsingGET",
  28         "produces": [
  29           "*/*"
  30         ],
  31         "responses": {
  32           "200": {
  33             "description": "PRH sevice is living",
  34             "schema": {
  35               "$ref": "#/definitions/Mono«ResponseEntity«string»»"
  36             }
  37           },
  38           "401": {
  39             "description": "You are not authorized to view the resource"
  40           },
  41           "403": {
  42             "description": "Accessing the resource you were trying to reach is forbidden"
  43           },
  44           "404": {
  45             "description": "The resource you were trying to reach is not found"
  46           }
  47         }
  48       }
  49     },
  50     "/start": {
  51       "get": {
  52         "tags": [
  53           "schedule-controller"
  54         ],
  55         "summary": "Start scheduling worker request",
  56         "operationId": "startTasksUsingGET",
  57         "produces": [
  58           "*/*"
  59         ],
  60         "responses": {
  61           "200": {
  62             "description": "OK",
  63             "schema": {
  64               "$ref": "#/definitions/Mono«ResponseEntity«string»»"
  65             }
  66           },
  67           "401": {
  68             "description": "Unauthorized"
  69           },
  70           "403": {
  71             "description": "Forbidden"
  72           },
  73           "404": {
  74             "description": "Not Found"
  75           }
  76         }
  77       }
  78     },
  79     "/stopPrh": {
  80       "get": {
  81         "tags": [
  82           "schedule-controller"
  83         ],
  84         "summary": "Stop scheduling worker request",
  85         "operationId": "stopTaskUsingGET",
  86         "produces": [
  87           "*/*"
  88         ],
  89         "responses": {
  90           "200": {
  91             "description": "OK",
  92             "schema": {
  93               "$ref": "#/definitions/Mono«ResponseEntity«string»»"
  94             }
  95           },
  96           "401": {
  97             "description": "Unauthorized"
  98           },
  99           "403": {
 100             "description": "Forbidden"
 101           },
 102           "404": {
 103             "description": "Not Found"
 104           }
 105         }
 106       }
 107     }
 108   },
 109   "definitions": {
 110     "Mono«ResponseEntity«string»»": {
 111       "type": "object",
 112       "title": "Mono«ResponseEntity«string»»"
 113     }
 114   }
 115 }