From f099405b4ac9e58bd9ac0bd7c81c2ceb9261a3ad Mon Sep 17 00:00:00 2001
From: "Eduardo L. Buratti" <elburatti@inf.ufpr.br>
Date: Wed, 31 Aug 2016 12:40:39 -0300
Subject: [PATCH] Update API specs
---
specs/blendb-api-v1.raml | 16 +++++++---------
1 file changed, 7 insertions(+), 9 deletions(-)
diff --git a/specs/blendb-api-v1.raml b/specs/blendb-api-v1.raml
index 98cfdc3f..2693c9ca 100644
--- a/specs/blendb-api-v1.raml
+++ b/specs/blendb-api-v1.raml
@@ -361,16 +361,14 @@ traits:
"message": "The specified metric 'met:electricCharge' could not be found."
}
-/collect/{class}:
+/collect/{sourceName}:
description: |
- This API may be used to send data to the monitoring system. There are a
- few available data types (like network bandwidth usage, machine
- inventory, etc.) and each of them requires a specific format for the
- data being sent.
+ This API may be used to send data to the monitoring system. All data
+ sent must be identified with a sourceName, i.e. "gesacNetworkBandwidth".
type: base
uriParameters:
- class:
- description: The class of data that is being collected.
+ sourceName:
+ description: An identifying name for the data that is being collected.
type: string
minLength: 4
maxLength: 64
@@ -390,6 +388,6 @@ traits:
application/json:
example: |
{
- "id": "invalid_attribute",
- "message": "Invalid attribute \"memory\" for data type \"network_bandwidth\"."
+ "id": "type_error",
+ "message": "Invalid type for attribute \"memory\"."
}
--
GitLab