From d35270b5fad301a036eded776167e9a05d136945 Mon Sep 17 00:00:00 2001
From: Erik Reid <erik.reid@geant.org>
Date: Tue, 10 Mar 2020 12:13:31 +0100
Subject: [PATCH] added doc for /msr/access-services
---
README.md | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
diff --git a/README.md b/README.md
index c90e813e..ec524e2c 100644
--- a/README.md
+++ b/README.md
@@ -1044,6 +1044,44 @@ Any non-empty responses are JSON formatted messages.
```
+* /msr/access-services
+
+ The response will be the list of services that
+ are of type 'IP Acccess', and will formatted
+ according to the following schema:
+
+ ```json
+ {
+ "$schema": "http://json-schema.org/draft-07/schema#",
+
+ "definitions": {
+ "service": {
+ "type": "object",
+ "properties": {
+ "id": {"type": "integer"},
+ "name": {"type": "string"},
+ "equipment": {"type": "string"},
+ "pop_name": {"type": "string"},
+ "other_end_equipment": {"type": "string"},
+ "other_end_pop_name": {"type": "string"},
+ "speed_value": {"type": "integer"},
+ "speed_unit": {"type": "string"}
+ },
+ "required": [
+ "id", "name",
+ "pop_name", "equipment",
+ "other_end_pop_name", "other_end_equipment",
+ "speed_value", "speed_unit"
+ ],
+ "additionalProperties": False
+ }
+ },
+
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"}
+ }
+ ```
+
### Testing utilities
The following routes are only available if the server
--
GitLab