diff --git a/README.md b/README.md index 620bfbacb0e217540087d40d84454ceee5f4300a..24411b4897a1f3f9bc64308609db48f25d38df42 100644 --- a/README.md +++ b/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. @@ -771,16 +771,86 @@ Any non-empty responses are JSON formatted messages. "type": "array", "items": {"$ref": "#/definitions/circuit"} }, + "bundle": { + "type": "array", + "items": {"type": "string"} + }, + "bundle-parents": { + "type": "array", + "items": {"type": "string"} + }, "description": {"type": "string"}, "name": {"type": "string"}, "snmp-index": {"type": "integer"} }, - "required": ["circuits", "description", "name", "snmp-index"], + "required": [ + "circuits", + "bundle", + "bundle-parents", + "description", + "name", + "snmp-index"], "additionalProperties": False } } ``` +* /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 diff --git a/changelog b/changelog index 6245353b415637266f2c663ada16e03938c888a5..09db601f914851cedfae6b6ffc99312278e00e94 100644 --- a/changelog +++ b/changelog @@ -55,4 +55,5 @@ 0.35: POL1-135: added customer(user) info to service category api response 0.36: DBOARD3-218: added project name to circuit info 0.37: DBOARD3-220: make redis/sentinel socket timeouts configurable -0.38: DBOARD3-234/DBOARD3-232: standardized location data in classifier responses \ No newline at end of file +0.38: DBOARD3-234/DBOARD3-232: standardized location data in classifier responses +0.39: LGR-73: expose routers with pop info so LG doesn't need to connect to opsdb \ No newline at end of file