added interface spec for the lg route

README.md

@@ -738,7 +738,7 @@ Any non-empty responses are JSON formatted messages.
 
 * /poller/interfaces/*`hostname`*
 
-  The response will be the list of active interfac`es on the
+  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.
@@ -781,6 +781,62 @@ Any non-empty responses are JSON formatted messages.
     }
     ```
 
+* /lg/routers/*`access`*
+
+  The response will be the list of routers with pop location information.
+  The list will be filtered according to the value of the `access` parameter.
+
+  There are 2 valid values for `access`, these are: `public`, `all`
+
+  The response will be formatted according to the following schema:
+
+    ```json
+    {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+
+        "definitions": {
+            "pop-info": {
+                "type": "object",
+                "properties": {
+                    "name": {"type": "string"},
+                    "abbreviation": {"type": "string"},
+                    "country": {"type": "string"},
+                    "country code": {"type": "string"},
+                    "city": {"type": "string"},
+                    "longitude": {"type": "number"},
+                    "latitude": {"type": "number"}
+                },
+                "required": [
+                    "name",
+                    "abbreviation",
+                    "country",
+                    "country code",
+                    "city",
+                    "longitude",
+                    "latitude"
+                ],
+                "additionalProperties": False
+            },
+            "router": {
+                "type": "object",
+                "properties": {
+                    "equipment name": {"type": "string"},
+                    "type": {
+                        "type": "string",
+                        "enum": ["INTERNAL", "CORE"]
+                    },
+                    "pop": {"$ref": "#/definitions/pop-info"}
+                },
+                "required": ["equipment name", "type", "pop"],
+                "additionalProperties": False
+            }
+        },
+
+        "type": "array",
+        "items": {"$ref": "#/definitions/router"}
+    }
+    ```
+
 
 ### Testing utilities