Merge pull request #69 from open-traffic-generator/bgpv4-metrics-request

added column filter for BGPv4 metrics request
open-traffic-generator · Feb 10, 2021 · 37ea0c2 · 37ea0c2
2 parents d562fd2 + 3a3bb38
commit 37ea0c2
Showing 1 changed file with 23 additions and 7 deletions.
diff --git a/result/bgpv4.yaml b/result/bgpv4.yaml
@@ -1,34 +1,50 @@
 openapi: 3.1.0
 
 info:
-  title: BGP results models
+  title: BGPv4 results models
   version: ^0.0.0
 
 components:
   schemas:
     Bgpv4.Metrics.Request:
       description: >-
-        The request to retrieve BGP Router statistics and learned routing information
+        The request to retrieve BGPv4 Router statistics and learned routing information
       type: object
       properties:
-        names:
+        device_names:
           description: >-
-            The names of BGP objects to return results for.
-            An empty list will return results for all BGP.
+            The names of BGPv4 device to return results for.
+            An empty list will return results for all BGPv4 devices.
           type: array
           items:
             type: string
             x-constraint:
               - "/components/schemas/Device.Bgpv4/properties/name"
+        column_names:
+          description: >-
+            The list of column names that the returned result set will contain.
+            If the list is empty then all columns will be returned except for
+            any result_groups.
+            The name of the BGPv4 device cannot be excluded.
+          type: array
+          items:
+            type: string
+            enum:
+              - sessions_total
+              - sessions_up
+              - sessions_down
+              - sessions_not_started
+              - routes_advertised
+              - routes_withdrawn
 
     Bgpv4.Metric:
       description: >-
-        BGP Router statistics and learned routing information
+        BGPv4 Router statistics and learned routing information
       type: object
       properties:
         name:
           description: >-
-            The name of a configured BGPv4 Object.
+            The name of a configured BGPv4 device.
           type: string
         sessions_total:
           description: >-