summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis/PRH.yaml
blob: 37040bc8447100c79523e53e5416a22c31436702 (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
---
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»»