update swagger doc

synapsecns · May 1, 2024 · d390ea0 · d390ea0
1 parent 652b099
commit d390ea0
Show file tree

Hide file tree

Showing 4 changed files with 115 additions and 0 deletions.
diff --git a/contrib/screener-api/docs/docs.go b/contrib/screener-api/docs/docs.go
@@ -60,11 +60,54 @@ const docTemplate = `{
                         "name": "signature",
                         "in": "header",
                         "required": true
+                    },
+                    {
+                        "description": "Blacklist request",
+                        "name": "request",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/db.BlacklistedAddress"
+                        }
                     }
                 ],
                 "responses": {}
             }
         }
+    },
+    "definitions": {
+        "db.BlacklistedAddress": {
+            "type": "object",
+            "properties": {
+                "address": {
+                    "type": "string"
+                },
+                "createdAt": {
+                    "type": "string"
+                },
+                "data": {
+                    "type": "string"
+                },
+                "id": {
+                    "type": "string"
+                },
+                "network": {
+                    "type": "string"
+                },
+                "remark": {
+                    "type": "string"
+                },
+                "tag": {
+                    "type": "string"
+                },
+                "typereq": {
+                    "type": "string"
+                },
+                "updatedAt": {
+                    "type": "string"
+                }
+            }
+        }
     }
 }`
 

diff --git a/contrib/screener-api/docs/swagger.json b/contrib/screener-api/docs/swagger.json
@@ -49,10 +49,53 @@
                         "name": "signature",
                         "in": "header",
                         "required": true
+                    },
+                    {
+                        "description": "Blacklist request",
+                        "name": "request",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/db.BlacklistedAddress"
+                        }
                     }
                 ],
                 "responses": {}
             }
         }
+    },
+    "definitions": {
+        "db.BlacklistedAddress": {
+            "type": "object",
+            "properties": {
+                "address": {
+                    "type": "string"
+                },
+                "createdAt": {
+                    "type": "string"
+                },
+                "data": {
+                    "type": "string"
+                },
+                "id": {
+                    "type": "string"
+                },
+                "network": {
+                    "type": "string"
+                },
+                "remark": {
+                    "type": "string"
+                },
+                "tag": {
+                    "type": "string"
+                },
+                "typereq": {
+                    "type": "string"
+                },
+                "updatedAt": {
+                    "type": "string"
+                }
+            }
+        }
     }
 }
diff --git a/contrib/screener-api/docs/swagger.yaml b/contrib/screener-api/docs/swagger.yaml
@@ -1,3 +1,25 @@
+definitions:
+  db.BlacklistedAddress:
+    properties:
+      address:
+        type: string
+      createdAt:
+        type: string
+      data:
+        type: string
+      id:
+        type: string
+      network:
+        type: string
+      remark:
+        type: string
+      tag:
+        type: string
+      typereq:
+        type: string
+      updatedAt:
+        type: string
+    type: object
 info:
   contact: {}
 paths:
@@ -32,6 +54,12 @@ paths:
         name: signature
         required: true
         type: string
+      - description: Blacklist request
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/db.BlacklistedAddress'
       produces:
       - application/json
       responses: {}

diff --git a/contrib/screener-api/screener/screener.go b/contrib/screener-api/screener/screener.go
@@ -139,6 +139,7 @@ func (s *screenerImpl) fetchBlacklist(ctx context.Context) {
 // @Param nonce header string true "A unique nonce for the request"
 // @Param queryString header string true "Query string parameters included in the request"
 // @Param signature header string true "Signature for request validation"
+// @Param request body db.BlacklistedAddress true "Blacklist request"
 // @Accept json
 // @Produce json
 // @Router /api/data/sync [post].