From 4b1dc8492bd9c9ba8c0ef0fdbca244d9fb9ad5d4 Mon Sep 17 00:00:00 2001
From: Erik Reid <erik.reid@geant.org>
Date: Mon, 28 Jan 2019 15:37:46 +0100
Subject: [PATCH] added doc for poller/interfaces/hostname
---
README.md | 45 +++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 43 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 42b82c12..20c0231d 100644
--- a/README.md
+++ b/README.md
@@ -310,5 +310,46 @@ Any non-empty responses are JSON formatted messages.
"type": "object"
}
```
-
-### Test Commit
\ No newline at end of file
+
+* /poller/interfaces/*`hostname`*
+
+ The response will be the list of active interfaces on the
+ router `hostname`.
+ Each element of the returned list contains information necessary
+ for setting up snmp throughput counter polling.
+
+ The response will be formatted according to the following schema:
+
+ ```json
+ {
+ "$schema": "http://json-schema.org/draft-07/schema#",
+
+ "definitions": {
+ "circuit": {
+ "type": "object",
+ "properties": {
+ "type": {"type": "string"},
+ "id": {"type": "integer"}
+ },
+ "required": ["type", "id"],
+ "additionalProperties": False
+ }
+ },
+
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "circuits": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/circuit"}
+ },
+ "description": {"type": "string"},
+ "name": {"type": "string"},
+ "snmp-index": {"type": "integer"}
+ },
+ "required": ["circuits", "description", "name", "snmp-index"],
+ "additionalProperties": False
+ }
+ }
+ ```
--
GitLab