Update swagger docs

Lint
Layr-Labs · Apr 26, 2024 · 1063b0a · 1063b0a
1 parent 7a6ed91
commit 1063b0a
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 4 deletions.
diff --git a/disperser/dataapi/docs/docs.go b/disperser/dataapi/docs/docs.go
@@ -492,7 +492,7 @@ const docTemplate = `{
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/dataapi.ServiceAvailabilityResponse"
+                            "$ref": "#/definitions/dataapi.OperatorPortCheckResponse"
                         }
                     },
                     "400": {
@@ -720,6 +720,26 @@ const docTemplate = `{
                 }
             }
         },
+        "dataapi.OperatorPortCheckResponse": {
+            "type": "object",
+            "properties": {
+                "disperser_online": {
+                    "type": "boolean"
+                },
+                "disperser_socket": {
+                    "type": "string"
+                },
+                "operator_id": {
+                    "type": "string"
+                },
+                "retriever_online": {
+                    "type": "boolean"
+                },
+                "retriever_socket": {
+                    "type": "string"
+                }
+            }
+        },
         "dataapi.OperatorsNonsigningPercentage": {
             "type": "object",
             "properties": {

diff --git a/disperser/dataapi/docs/swagger.json b/disperser/dataapi/docs/swagger.json
@@ -488,7 +488,7 @@
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/dataapi.ServiceAvailabilityResponse"
+                            "$ref": "#/definitions/dataapi.OperatorPortCheckResponse"
                         }
                     },
                     "400": {
@@ -716,6 +716,26 @@
                 }
             }
         },
+        "dataapi.OperatorPortCheckResponse": {
+            "type": "object",
+            "properties": {
+                "disperser_online": {
+                    "type": "boolean"
+                },
+                "disperser_socket": {
+                    "type": "string"
+                },
+                "operator_id": {
+                    "type": "string"
+                },
+                "retriever_online": {
+                    "type": "boolean"
+                },
+                "retriever_socket": {
+                    "type": "string"
+                }
+            }
+        },
         "dataapi.OperatorsNonsigningPercentage": {
             "type": "object",
             "properties": {

diff --git a/disperser/dataapi/docs/swagger.yaml b/disperser/dataapi/docs/swagger.yaml
@@ -138,6 +138,19 @@ definitions:
       total_unsigned_batches:
         type: integer
     type: object
+  dataapi.OperatorPortCheckResponse:
+    properties:
+      disperser_online:
+        type: boolean
+      disperser_socket:
+        type: string
+      operator_id:
+        type: string
+      retriever_online:
+        type: boolean
+      retriever_socket:
+        type: string
+    type: object
   dataapi.OperatorsNonsigningPercentage:
     properties:
       data:
@@ -539,7 +552,7 @@ paths:
         "200":
           description: OK
           schema:
-            $ref: '#/definitions/dataapi.ServiceAvailabilityResponse'
+            $ref: '#/definitions/dataapi.OperatorPortCheckResponse'
         "400":
           description: 'error: Bad request'
           schema:

diff --git a/disperser/dataapi/metrics.go b/disperser/dataapi/metrics.go
@@ -167,6 +167,7 @@ func (g *Metrics) UpdateRequestedOperatorMetric(numOperatorsByQuorum map[uint8]i
 
 func (g *Metrics) UpdateEjectionGasUsed(gasUsed uint64) {
 	g.EjectionGasUsed.Set(float64(gasUsed))
+}
 
 // IncrementNotFoundRequestNum increments the number of not found requests
 func (g *Metrics) IncrementNotFoundRequestNum(method string) {

diff --git a/disperser/dataapi/server.go b/disperser/dataapi/server.go
@@ -676,7 +676,7 @@ func (s *server) FetchDeregisteredOperators(c *gin.Context) {
 //	@Tags		OperatorsInfo
 //	@Produce	json
 //	@Param		operator_id	query		string	true	"Operator ID"
-//	@Success	200			{object}	ServiceAvailabilityResponse
+//	@Success	200			{object}	OperatorPortCheckResponse
 //	@Failure	400			{object}	ErrorResponse	"error: Bad request"
 //	@Failure	404			{object}	ErrorResponse	"error: Not found"
 //	@Failure	500			{object}	ErrorResponse	"error: Server error"

diff --git a/disperser/dataapi/server_test.go b/disperser/dataapi/server_test.go
@@ -13,6 +13,7 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"testing"
+	"time"
 
 	"github.com/Layr-Labs/eigenda/core"
 	coremock "github.com/Layr-Labs/eigenda/core/mock"