From 84ceb2c02948dc3ed4851a92a7546f9048167434 Mon Sep 17 00:00:00 2001
From: Omar Abdulaziz <omarabdul3ziz@gmail.com>
Date: Tue, 17 Sep 2024 15:45:41 +0300
Subject: [PATCH] document the farms ips sorting params

---
 grid-proxy/docs/docs.go                | 22 +++++++++++++++++++++-
 grid-proxy/docs/swagger.json           | 22 +++++++++++++++++++++-
 grid-proxy/docs/swagger.yaml           | 16 +++++++++++++++-
 grid-proxy/internal/explorer/server.go |  2 +-
 4 files changed, 58 insertions(+), 4 deletions(-)

diff --git a/grid-proxy/docs/docs.go b/grid-proxy/docs/docs.go
index 8e677a89..e3c9f1e6 100644
--- a/grid-proxy/docs/docs.go
+++ b/grid-proxy/docs/docs.go
@@ -323,7 +323,9 @@ const docTemplate = `{
                             "name",
                             "farm_id",
                             "twin_id",
-                            "public_ips",
+                            "free_ips",
+                            "total_ips",
+                            "used_ips",
                             "dedicated"
                         ],
                         "type": "string",
@@ -1618,6 +1620,9 @@ const docTemplate = `{
                     "items": {
                         "$ref": "#/definitions/types.Processor"
                     }
+                },
+                "updatedAt": {
+                    "type": "integer"
                 }
             }
         },
@@ -1714,6 +1719,12 @@ const docTemplate = `{
                 "farmingPolicyId": {
                     "type": "integer"
                 },
+                "gpus": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/types.NodeGPU"
+                    }
+                },
                 "gridVersion": {
                     "type": "integer"
                 },
@@ -1903,6 +1914,12 @@ const docTemplate = `{
                 "farmingPolicyId": {
                     "type": "integer"
                 },
+                "gpus": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/types.NodeGPU"
+                    }
+                },
                 "gridVersion": {
                     "type": "integer"
                 },
@@ -2027,6 +2044,9 @@ const docTemplate = `{
                 "node_twin_id": {
                     "type": "integer"
                 },
+                "updatedAt": {
+                    "type": "integer"
+                },
                 "upload": {
                     "description": "in bit/sec",
                     "type": "number"
diff --git a/grid-proxy/docs/swagger.json b/grid-proxy/docs/swagger.json
index a1162849..94ca4355 100644
--- a/grid-proxy/docs/swagger.json
+++ b/grid-proxy/docs/swagger.json
@@ -315,7 +315,9 @@
                             "name",
                             "farm_id",
                             "twin_id",
-                            "public_ips",
+                            "free_ips",
+                            "total_ips",
+                            "used_ips",
                             "dedicated"
                         ],
                         "type": "string",
@@ -1610,6 +1612,9 @@
                     "items": {
                         "$ref": "#/definitions/types.Processor"
                     }
+                },
+                "updatedAt": {
+                    "type": "integer"
                 }
             }
         },
@@ -1706,6 +1711,12 @@
                 "farmingPolicyId": {
                     "type": "integer"
                 },
+                "gpus": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/types.NodeGPU"
+                    }
+                },
                 "gridVersion": {
                     "type": "integer"
                 },
@@ -1895,6 +1906,12 @@
                 "farmingPolicyId": {
                     "type": "integer"
                 },
+                "gpus": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/types.NodeGPU"
+                    }
+                },
                 "gridVersion": {
                     "type": "integer"
                 },
@@ -2019,6 +2036,9 @@
                 "node_twin_id": {
                     "type": "integer"
                 },
+                "updatedAt": {
+                    "type": "integer"
+                },
                 "upload": {
                     "description": "in bit/sec",
                     "type": "number"
diff --git a/grid-proxy/docs/swagger.yaml b/grid-proxy/docs/swagger.yaml
index 59b5b3e9..7c0ae2c9 100644
--- a/grid-proxy/docs/swagger.yaml
+++ b/grid-proxy/docs/swagger.yaml
@@ -91,6 +91,8 @@ definitions:
         items:
           $ref: '#/definitions/types.Processor'
         type: array
+      updatedAt:
+        type: integer
     type: object
   types.Farm:
     properties:
@@ -153,6 +155,10 @@ definitions:
         type: string
       farmingPolicyId:
         type: integer
+      gpus:
+        items:
+          $ref: '#/definitions/types.NodeGPU'
+        type: array
       gridVersion:
         type: integer
       healthy:
@@ -277,6 +283,10 @@ definitions:
         type: string
       farmingPolicyId:
         type: integer
+      gpus:
+        items:
+          $ref: '#/definitions/types.NodeGPU'
+        type: array
       gridVersion:
         type: integer
       healthy:
@@ -359,6 +369,8 @@ definitions:
         type: number
       node_twin_id:
         type: integer
+      updatedAt:
+        type: integer
       upload:
         description: in bit/sec
         type: number
@@ -629,7 +641,9 @@ paths:
         - name
         - farm_id
         - twin_id
-        - public_ips
+        - free_ips
+        - total_ips
+        - used_ips
         - dedicated
         in: query
         name: sort_by
diff --git a/grid-proxy/internal/explorer/server.go b/grid-proxy/internal/explorer/server.go
index 318eed11..ee8eff46 100644
--- a/grid-proxy/internal/explorer/server.go
+++ b/grid-proxy/internal/explorer/server.go
@@ -32,7 +32,7 @@ const (
 // @Param size query int false "Max result per page"
 // @Param ret_count query bool false "Set farms' count on headers based on filter"
 // @Param randomize query bool false "Get random patch of farms"
-// @Param sort_by query string false "Sort by specific farm field" Enums(name, farm_id, twin_id, public_ips, dedicated)
+// @Param sort_by query string false "Sort by specific farm field" Enums(name, farm_id, twin_id, free_ips, total_ips, used_ips, dedicated)
 // @Param sort_order query string false "The sorting order, default is 'asc'" Enums(desc, asc)
 // @Param free_ips query int false "Min number of free ips in the farm"
 // @Param total_ips query int false "Min number of total ips in the farm"