MEDIUM: Add info endpoint

Author: mjuraga

build/haproxy_spec.yaml

@@ -2388,9 +2388,6 @@ definitions:
       properties:
         haproxy:
           properties:
-            address:
-              description: The address of the replying server
-              type: string
             pid:
               description: Process id of the replying worker process
               type: integer
@@ -2403,10 +2400,6 @@ definitions:
               description: HAProxy version release date
               format: date
               type: string
-            time:
-              description: Current time in milliseconds since Epoch.
-              format: date-time
-              type: string
             uptime:
               description: HAProxy uptime in s
               type: integer
@@ -2443,6 +2436,54 @@ definitions:
     type: array
     items:
       $ref: "#/definitions/transaction"
+  info:
+      description: General API, OS and hardware information
+      properties:
+        api:
+          properties:
+            build_date:
+              description: HAProxy Dataplane API build date
+              format: date-time
+              type: string
+            version:
+              description: HAProxy Dataplane API version string
+              type: string
+          type: object
+        system:
+          properties:
+            cpu_info:
+              properties:
+                model:
+                  type: string
+                num_cpus:
+                  description: Number of logical CPUs
+                  type: integer
+              type: object
+            hostname:
+              description: Hostname where the HAProxy is running
+              type: string
+            mem_info:
+              properties:
+                dataplaneapi_memory:
+                  type: integer
+                free_memory:
+                  type: integer
+                total_memory:
+                  type: integer
+              type: object
+            os_string:
+              description: OS string
+              type: string
+            time:
+              description: Current time in milliseconds since Epoch.
+              type: integer
+            uptime:
+              description: System uptime
+              type: integer
+              x-nullable: true
+          type: object
+      title: Information
+      type: object
   reload:
       description: HAProxy reload
       example:
@@ -2740,6 +2781,22 @@ paths:
         summary: Data Plane API Specification
         tags:
         - Specification
+  /info:
+      get:
+        description: Return API, hardware and OS information
+        operationId: getInfo
+        produces:
+        - application/json
+        responses:
+          "200":
+            description: Success
+            schema:
+              $ref: '#/definitions/info'
+          default:
+            $ref: '#/responses/DefaultError'
+        summary: Return API, hardware and OS information
+        tags:
+        - Information
   /services:
       get:
         description: Returns a list of API managed services endpoints.

haproxy-spec.yaml

@@ -166,6 +166,8 @@ definitions:
     type: array
     items:
       $ref: "#/definitions/transaction"
+  info:
+    $ref: "models/general.yaml#/info"
   reload:
     $ref: "models/general.yaml#/reload"
   reloads:
@@ -317,6 +319,8 @@ paths:
     $ref: "paths/general.yaml#/root"
   /specification:
     $ref: "paths/general.yaml#/specification"
+  /info:
+    $ref: "paths/general.yaml#/info"
   /services:
     $ref: "paths/general.yaml#/services"
   /services/haproxy:

models/general.yaml

@@ -12,6 +12,70 @@ endpoint:
     description:
       type: string
       description: Endpoint description
+info:
+  title: Information
+  description: General API, OS and hardware information
+  type: object
+  properties:
+    api:
+      type: object
+      properties:
+        version:
+          type: string
+          description: HAProxy Dataplane API version string
+        build_date:
+          type: string
+          format: date-time
+          description: HAProxy Dataplane API build date
+    system:
+      type: object
+      properties:
+        hostname:
+          type: string
+          description: Hostname where the HAProxy is running
+        cpu_info:
+          type: object
+          properties:
+            model:
+              type: string
+            num_cpus:
+              type: integer
+              description: Number of logical CPUs
+        os_string:
+          type: string
+          description: OS string
+        mem_info:
+          type: object
+          properties:
+            total_memory:
+              type: integer
+            free_memory:
+              type: integer
+            dataplaneapi_memory:
+              type: integer
+        time:
+          type: integer
+          description: Current time in milliseconds since Epoch.
+        uptime:
+          type: integer
+          description: System uptime
+          x-nullable: true
+  example:
+    api:
+      build_date: "2019-08-21T17:31:56.000Z"
+      version: v1.2.1 45a3288.dev
+    system:
+      hostname: test
+      os_string: "Linux 4.15.0-58-generic #64-Ubuntu SMP Tue Aug 6 11:12:41 UTC 2019"
+      time: 1566401525
+      uptime: 87340
+      cpu_info:
+        model: Intel(R) Core(TM) i7-7500U CPU @ 2.70GHz
+        num_cpus: 4
+      mem_info:
+        total_memory: 16681517056
+        free_memory: 5790642176
+        dataplaneapi_memory: 44755536
 process_info:
   title: HAProxy Information
   description: General HAProxy process information
@@ -27,13 +91,6 @@ process_info:
           type: string
           format: date
           description: HAProxy version release date
-        address:
-          type: string
-          description: The address of the replying server
-        time:
-          type: string
-          format: date-time
-          description: Current time in milliseconds since Epoch.
         processes:
           type: integer
           description: Number of spawned processes

paths/general.yaml

@@ -78,6 +78,22 @@ configuration:
           $ref: '#/definitions/endpoints'
       'default':
         $ref: '#/responses/DefaultError'
+info:
+  get:
+    tags:
+      - Information
+    summary: Return API, hardware and OS information
+    description: Return API, hardware and OS information
+    operationId: getInfo
+    produces:
+      - application/json
+    responses:
+      '200':
+        description: Success
+        schema:
+          $ref: '#/definitions/info'
+      'default':
+        $ref: '#/responses/DefaultError'
 process_info:
   get:
     tags: