Commit f099405b authored by Eduardo L. Buratti's avatar Eduardo L. Buratti
Browse files

Update API specs

parent e459a94f
...@@ -361,16 +361,14 @@ traits: ...@@ -361,16 +361,14 @@ traits:
"message": "The specified metric 'met:electricCharge' could not be found." "message": "The specified metric 'met:electricCharge' could not be found."
} }
/collect/{class}: /collect/{sourceName}:
description: | description: |
This API may be used to send data to the monitoring system. There are a This API may be used to send data to the monitoring system. All data
few available data types (like network bandwidth usage, machine sent must be identified with a sourceName, i.e. "gesacNetworkBandwidth".
inventory, etc.) and each of them requires a specific format for the
data being sent.
type: base type: base
uriParameters: uriParameters:
class: sourceName:
description: The class of data that is being collected. description: An identifying name for the data that is being collected.
type: string type: string
minLength: 4 minLength: 4
maxLength: 64 maxLength: 64
...@@ -390,6 +388,6 @@ traits: ...@@ -390,6 +388,6 @@ traits:
application/json: application/json:
example: | example: |
{ {
"id": "invalid_attribute", "id": "type_error",
"message": "Invalid attribute \"memory\" for data type \"network_bandwidth\"." "message": "Invalid type for attribute \"memory\"."
} }
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment