Update swagger

Layr-Labs · Oct 16, 2024 · 3dfbef9 · 3dfbef9
1 parent 9f13bb9
commit 3dfbef9
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/disperser/dataapi/docs/docs.go b/disperser/dataapi/docs/docs.go
@@ -528,15 +528,15 @@ const docTemplate = `{
                 }
             }
         },
-        "/operators-info/ejected-operators": {
+        "/operators-info/operator-ejections": {
             "get": {
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "OperatorsInfo"
                 ],
-                "summary": "Fetch list of operators that have been ejected over lookback days interval.",
+                "summary": "Fetch list of operator ejections over last N days.",
                 "parameters": [
                     {
                         "type": "integer",
@@ -546,7 +546,7 @@ const docTemplate = `{
                     },
                     {
                         "type": "string",
-                        "description": "Operator ID",
+                        "description": "Operator ID filter",
                         "name": "operator_id",
                         "in": "query"
                     }

diff --git a/disperser/dataapi/docs/swagger.json b/disperser/dataapi/docs/swagger.json
@@ -524,15 +524,15 @@
                 }
             }
         },
-        "/operators-info/ejected-operators": {
+        "/operators-info/operator-ejections": {
             "get": {
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "OperatorsInfo"
                 ],
-                "summary": "Fetch list of operators that have been ejected over lookback days interval.",
+                "summary": "Fetch list of operator ejections over last N days.",
                 "parameters": [
                     {
                         "type": "integer",
@@ -542,7 +542,7 @@
                     },
                     {
                         "type": "string",
-                        "description": "Operator ID",
+                        "description": "Operator ID filter",
                         "name": "operator_id",
                         "in": "query"
                     }

diff --git a/disperser/dataapi/docs/swagger.yaml b/disperser/dataapi/docs/swagger.yaml
@@ -625,14 +625,14 @@ paths:
         is a query parameter with a default value of 14 and max value of 30.
       tags:
       - OperatorsInfo
-  /operators-info/ejected-operators:
+  /operators-info/operator-ejections:
     get:
       parameters:
       - description: 'Lookback in days [default: 1]'
         in: query
         name: days
         type: integer
-      - description: Operator ID
+      - description: Operator ID filter
         in: query
         name: operator_id
         type: string
@@ -655,7 +655,7 @@ paths:
           description: 'error: Server error'
           schema:
             $ref: '#/definitions/dataapi.ErrorResponse'
-      summary: Fetch list of operators that have been ejected over lookback days interval.
+      summary: Fetch list of operator ejections over last N days.
       tags:
       - OperatorsInfo
   /operators-info/operators-stake:

diff --git a/disperser/dataapi/server.go b/disperser/dataapi/server.go
@@ -883,7 +883,7 @@ func (s *server) FetchRegisteredOperators(c *gin.Context) {
 //	@Failure	400			{object}	ErrorResponse	"error: Bad request"
 //	@Failure	404			{object}	ErrorResponse	"error: Not found"
 //	@Failure	500			{object}	ErrorResponse	"error: Server error"
-//	@Router		/operators-info/ejected-operators [get]
+//	@Router		/operators-info/operator-ejections [get]
 func (s *server) FetchOperatorEjections(c *gin.Context) {
 	timer := prometheus.NewTimer(prometheus.ObserverFunc(func(f float64) {
 		s.metrics.ObserveLatency("FetchOperatorEjections", f*1000) // make milliseconds