docs: sync OpenAPI

Valecia2023 · Mar 4, 2024 · aaac9b7 · aaac9b7
1 parent 2c22204
commit aaac9b7
Showing 3 changed files with 110 additions and 93 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -15,39 +15,6 @@ const docTemplate = `{
     "host": "{{.Host}}",
     "basePath": "{{.BasePath}}",
     "paths": {
-        "/api/check_hash": {
-            "post": {
-                "consumes": [
-                    "application/json"
-                ],
-                "produces": [
-                    "application/json"
-                ],
-                "tags": [
-                    "search"
-                ],
-                "summary": "Check hash",
-                "parameters": [
-                    {
-                        "description": "param",
-                        "name": "param",
-                        "in": "body",
-                        "required": true,
-                        "schema": {
-                            "$ref": "#/definitions/internal_server_http.checkHashParam"
-                        }
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "OK",
-                        "schema": {
-                            "type": "object"
-                        }
-                    }
-                }
-            }
-        },
         "/api/now": {
             "get": {
                 "consumes": [
@@ -817,6 +784,39 @@ const docTemplate = `{
                 }
             }
         },
+        "/api/scan/check_hash": {
+            "post": {
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "search"
+                ],
+                "summary": "Check hash",
+                "parameters": [
+                    {
+                        "description": "param",
+                        "name": "param",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/internal_server_http.checkHashParam"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "object"
+                        }
+                    }
+                }
+            }
+        },
         "/api/scan/collator/info": {
             "post": {
                 "consumes": [
@@ -16074,6 +16074,9 @@ const docTemplate = `{
                 "to_account_display": {
                     "$ref": "#/definitions/subscan_internal_model.AccountDisplay"
                 },
+                "transfer_id": {
+                    "type": "integer"
+                },
                 "usd_amount": {
                     "type": "number"
                 }
@@ -16639,14 +16642,17 @@ const docTemplate = `{
             "type": "object",
             "properties": {
                 "code": {
-                    "type": "integer"
+                    "type": "integer",
+                    "example": 0
                 },
                 "data": {},
                 "generated_at": {
-                    "type": "integer"
+                    "type": "integer",
+                    "example": 1699600641
                 },
                 "message": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "Success"
                 }
             }
         },

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -4,39 +4,6 @@
         "contact": {}
     },
     "paths": {
-        "/api/check_hash": {
-            "post": {
-                "consumes": [
-                    "application/json"
-                ],
-                "produces": [
-                    "application/json"
-                ],
-                "tags": [
-                    "search"
-                ],
-                "summary": "Check hash",
-                "parameters": [
-                    {
-                        "description": "param",
-                        "name": "param",
-                        "in": "body",
-                        "required": true,
-                        "schema": {
-                            "$ref": "#/definitions/internal_server_http.checkHashParam"
-                        }
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "OK",
-                        "schema": {
-                            "type": "object"
-                        }
-                    }
-                }
-            }
-        },
         "/api/now": {
             "get": {
                 "consumes": [
@@ -806,6 +773,39 @@
                 }
             }
         },
+        "/api/scan/check_hash": {
+            "post": {
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "search"
+                ],
+                "summary": "Check hash",
+                "parameters": [
+                    {
+                        "description": "param",
+                        "name": "param",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/internal_server_http.checkHashParam"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "object"
+                        }
+                    }
+                }
+            }
+        },
         "/api/scan/collator/info": {
             "post": {
                 "consumes": [
@@ -16063,6 +16063,9 @@
                 "to_account_display": {
                     "$ref": "#/definitions/subscan_internal_model.AccountDisplay"
                 },
+                "transfer_id": {
+                    "type": "integer"
+                },
                 "usd_amount": {
                     "type": "number"
                 }
@@ -16628,14 +16631,17 @@
             "type": "object",
             "properties": {
                 "code": {
-                    "type": "integer"
+                    "type": "integer",
+                    "example": 0
                 },
                 "data": {},
                 "generated_at": {
-                    "type": "integer"
+                    "type": "integer",
+                    "example": 1699600641
                 },
                 "message": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "Success"
                 }
             }
         },

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -5145,6 +5145,8 @@ definitions:
         type: string
       to_account_display:
         $ref: '#/definitions/subscan_internal_model.AccountDisplay'
+      transfer_id:
+        type: integer
       usd_amount:
         type: number
     type: object
@@ -5526,11 +5528,14 @@ definitions:
   subscan_internal_plugin_share.J:
     properties:
       code:
+        example: 0
         type: integer
       data: {}
       generated_at:
+        example: 1699600641
         type: integer
       message:
+        example: Success
         type: string
     type: object
   subscan_internal_plugin_unique_unique_db.CollectionBalance:
@@ -6150,27 +6155,6 @@ definitions:
 info:
   contact: {}
 paths:
-  /api/check_hash:
-    post:
-      consumes:
-      - application/json
-      parameters:
-      - description: param
-        in: body
-        name: param
-        required: true
-        schema:
-          $ref: '#/definitions/internal_server_http.checkHashParam'
-      produces:
-      - application/json
-      responses:
-        "200":
-          description: OK
-          schema:
-            type: object
-      summary: Check hash
-      tags:
-      - search
   /api/now:
     get:
       consumes:
@@ -6634,6 +6618,27 @@ paths:
       summary: Bounty list
       tags:
       - governance
+  /api/scan/check_hash:
+    post:
+      consumes:
+      - application/json
+      parameters:
+      - description: param
+        in: body
+        name: param
+        required: true
+        schema:
+          $ref: '#/definitions/internal_server_http.checkHashParam'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            type: object
+      summary: Check hash
+      tags:
+      - search
   /api/scan/collator/info:
     post:
       consumes: