aboutsummaryrefslogtreecommitdiffstats
path: root/api/swagger.yaml
diff options
context:
space:
mode:
authorterminaldweller <thabogre@gmail.com>2021-02-26 02:55:08 +0000
committerterminaldweller <thabogre@gmail.com>2021-02-26 02:55:08 +0000
commitfd7b299442c95e6d3a870aefa51b04f38b2c70e2 (patch)
tree60fe45334c7748be3b4a4dc98e9a0dd6fb1fbbec /api/swagger.yaml
parentupdated readme with todo list (diff)
downloadhived-fd7b299442c95e6d3a870aefa51b04f38b2c70e2.tar.gz
hived-fd7b299442c95e6d3a870aefa51b04f38b2c70e2.zip
added a health endpoint. change endpoint name to alert. added a health endpoint.maybe a travis fix?
Diffstat (limited to '')
-rw-r--r--api/swagger.yaml56
1 files changed, 55 insertions, 1 deletions
diff --git a/api/swagger.yaml b/api/swagger.yaml
index 9100e82..fb59e08 100644
--- a/api/swagger.yaml
+++ b/api/swagger.yaml
@@ -70,7 +70,7 @@ paths:
properties:
ratio:
type: number
- /addalerts:
+ /alerts:
post:
description: Add alerts to the alertmanager's list
requestBody:
@@ -99,3 +99,57 @@ paths:
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