aboutsummaryrefslogtreecommitdiffstats
path: root/api/swagger.yaml
blob: fb59e08fc56af69c36a75b7744161decd6fbd972 (plain) (blame)
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
openapi: 3.0.0
info:
  version: 1.0.0-oas3
  title: hived
  description: hived's API
servers:
  - description: SwaggerHub API Auto Mocking
    url: 'https://virtserver.swaggerhub.com/xashmith/hived/0.1'
paths:
  /price:
    get:
      description: Returns the price of the crypto
      parameters:
        - name: name
          in: query
          description: the symbol of the cryptocurrency
          schema:
            type: string
        - name: unit
          in: query
          description: the unit the return the price in
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                required:
                  - name
                  - unit
                  - price
                properties:
                  name:
                    type: string
                  unit:
                    type: string
                  price:
                    type: number
  /pair:
    get:
      description: Returns the ratio of one to two multiplied by a value
      parameters:
        - name: one
          in: query
          description: the name of the currency that's going to be multiplied
          schema:
            type: string
        - name: two
          in: query
          description: the name of the second currency
          schema:
            type: string
        - name: multiplier
          in: query
          description: the amount hte first currency is going to be multiplied
          schema:
            type: number
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                required:
                  - ratio
                properties:
                  ratio:
                    type: number
  /alerts:
    post:
      description: Add alerts to the alertmanager's list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - expr
              properties:
                name:
                  type: string
                expr:
                  type: string
      responses:
        '200':
          description: successful update
          content:
            application/json:
              schema:
                type: object
                properties:
                  err:
                    type: string
                  isSuccessful:
                    type: boolean
    delete:
      description: Remove an alert from alertmanager's list
      parameters:
        - name : id
          in: query
          description: the name of the alert that should be deleted
          schema:
            type: string
      responses:
        '200':
          description: successful delete
          content:
            application/json:
              schema:
                type: object
                properties:
                  err:
                    type: string
                  isSuccessful:
                    type: string
  /ex:
    get:
      description: Returns the list of currencies that are available for trade
      responses:
        '200':
          description: seccussful update
          content:
            application/json:
              schema:
                type: object
                properties:
                  err:
                    type: string
                  isSuccessful:
                    type: boolean
                  tradaeble:
                    type: array
                    items:
                      type: string
  /health:
    get:
      description: Returns the health status of hived
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  isOK:
                    type: boolean
                  Err:
                    type: string