aboutsummaryrefslogtreecommitdiffstats
path: root/api
diff options
context:
space:
mode:
Diffstat (limited to 'api')
-rw-r--r--api/hived.postman_collection.json255
-rw-r--r--api/swagger.yaml155
2 files changed, 0 insertions, 410 deletions
diff --git a/api/hived.postman_collection.json b/api/hived.postman_collection.json
deleted file mode 100644
index f025c5b..0000000
--- a/api/hived.postman_collection.json
+++ /dev/null
@@ -1,255 +0,0 @@
-{
- "info": {
- "_postman_id": "75c431f8-b05d-4706-a6a8-e7ba5b36b2fe",
- "name": "hived",
- "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
- },
- "item": [
- {
- "name": "price",
- "request": {
- "method": "GET",
- "header": [],
- "url": {
- "raw": "http://127.0.0.1:8008/price?name=CAKE&unit=USD",
- "protocol": "http",
- "host": [
- "127",
- "0",
- "0",
- "1"
- ],
- "port": "8008",
- "path": [
- "price"
- ],
- "query": [
- {
- "key": "name",
- "value": "CAKE"
- },
- {
- "key": "unit",
- "value": "USD"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "pair",
- "request": {
- "method": "GET",
- "header": [],
- "url": {
- "raw": "http://127.0.0.1:8008/pair?one=BNB&two=CAKE&multiplier=41.56",
- "protocol": "http",
- "host": [
- "127",
- "0",
- "0",
- "1"
- ],
- "port": "8008",
- "path": [
- "pair"
- ],
- "query": [
- {
- "key": "one",
- "value": "BNB"
- },
- {
- "key": "two",
- "value": "CAKE"
- },
- {
- "key": "multiplier",
- "value": "41.56"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "alert-post",
- "request": {
- "method": "POST",
- "header": [],
- "body": {
- "mode": "raw",
- "raw": "{\r\n \"name\":\"alert4\",\r\n \"expr\":\"ETH>CAKE\"\r\n}"
- },
- "url": {
- "raw": "http://127.0.0.1:8008/alert",
- "protocol": "http",
- "host": [
- "127",
- "0",
- "0",
- "1"
- ],
- "port": "8008",
- "path": [
- "alert"
- ]
- }
- },
- "response": []
- },
- {
- "name": "alert-put",
- "request": {
- "method": "PUT",
- "header": [],
- "body": {
- "mode": "raw",
- "raw": "{\r\n \"name\":\"alert4\",\r\n \"expr\":\"ETH<CAKE\"\r\n}"
- },
- "url": {
- "raw": "http://127.0.0.1:8008/alert",
- "protocol": "http",
- "host": [
- "127",
- "0",
- "0",
- "1"
- ],
- "port": "8008",
- "path": [
- "alert"
- ]
- }
- },
- "response": []
- },
- {
- "name": "alert-patch",
- "request": {
- "method": "PATCH",
- "header": [],
- "body": {
- "mode": "raw",
- "raw": "{\r\n \"name\":\"alert4\",\r\n \"expr\":\"ETH==CAKE\"\r\n}"
- },
- "url": {
- "raw": "http://127.0.0.1:8008/alert",
- "protocol": "http",
- "host": [
- "127",
- "0",
- "0",
- "1"
- ],
- "port": "8008",
- "path": [
- "alert"
- ]
- }
- },
- "response": []
- },
- {
- "name": "alert-delete",
- "request": {
- "method": "DELETE",
- "header": [],
- "url": {
- "raw": "http://127.0.0.1:8008/alert?key=alert4",
- "protocol": "http",
- "host": [
- "127",
- "0",
- "0",
- "1"
- ],
- "port": "8008",
- "path": [
- "alert"
- ],
- "query": [
- {
- "key": "key",
- "value": "alert4"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "alert-get",
- "request": {
- "method": "GET",
- "header": [],
- "url": {
- "raw": "http://127.0.0.1:8008/alert?key=alert4",
- "protocol": "http",
- "host": [
- "127",
- "0",
- "0",
- "1"
- ],
- "port": "8008",
- "path": [
- "alert"
- ],
- "query": [
- {
- "key": "key",
- "value": "alert4"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "ex",
- "request": {
- "method": "GET",
- "header": [],
- "url": {
- "raw": "http://127.0.0.1:8008/ex",
- "protocol": "http",
- "host": [
- "127",
- "0",
- "0",
- "1"
- ],
- "port": "8008",
- "path": [
- "ex"
- ]
- }
- },
- "response": []
- },
- {
- "name": "health",
- "request": {
- "method": "GET",
- "header": [],
- "url": {
- "raw": "http://127.0.0.1:8008/health",
- "protocol": "http",
- "host": [
- "127",
- "0",
- "0",
- "1"
- ],
- "port": "8008",
- "path": [
- "health"
- ]
- }
- },
- "response": []
- }
- ]
-} \ No newline at end of file
diff --git a/api/swagger.yaml b/api/swagger.yaml
deleted file mode 100644
index fb59e08..0000000
--- a/api/swagger.yaml
+++ /dev/null
@@ -1,155 +0,0 @@
-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
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-23 10:17:59 +0000