update create order examples

gardenfi · Dec 30, 2024 · 2437afc · 2437afc
1 parent ebad19c
commit 2437afc
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 15 deletions.
diff --git a/static/swagger/auctionhouse/components/schemas.json b/static/swagger/auctionhouse/components/schemas.json
@@ -201,7 +201,7 @@
                     "swap_id": {
                         "type": "string",
                         "description": "Unique identifier for the swap.",
-                        "example": "swap_123"
+                        "example": "0x5A4b7eD8c2a1F1e34C8e9...6A3C5D2B1f8E7A9C"
                     },
                     "chain": {
                         "type": "string",
@@ -246,22 +246,22 @@
                     "secret": {
                         "type": "string",
                         "description": "The revealed secret for the atomic swap.",
-                        "example": ""
+                        "example": "garden.fi"
                     },
                     "initiate_tx_hash": {
                         "type": "string",
                         "description": "Transaction hash of the initiation transaction.",
-                        "example": ""
+                        "example": "zib3b8d16e58cd30b8a0e9f504b1c7f9f24d1c70eaf2a3794b3c7e5bb7c90f5d"
                     },
                     "redeem_tx_hash": {
                         "type": "string",
                         "description": "Transaction hash of the redeem transaction.",
-                        "example": ""
+                        "example": "abr8b8d16e58cd30b8a0e9f504b1c7f9f24d1c70eaf2a3794b3c7e5bb7c91wxk"
                     },
                     "refund_tx_hash": {
                         "type": "string",
                         "description": "Transaction hash of the refund transaction, if any.",
-                        "example": ""
+                        "example": "abr8b8d16e58cd30b8a0e9f504b1c7f9f24d1c70eaf2a3794b3c7e5bb7c91wxk"
                     },
                     "initiate_block_number": {
                         "type": "string",

diff --git a/static/swagger/relayer/components/schemas.json b/static/swagger/relayer/components/schemas.json
@@ -0,0 +1,47 @@
+{
+    "components": {
+        "schemas": {
+            "AdditionalData": {
+                "type": "object",
+                "properties": {
+                    "strategy_id": {
+                        "type": "string",
+                        "description": "Provided by the quote server",
+                        "example": "bre112"
+                    },
+                    "input_token_price": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Provided by the quote server",
+                        "example": 97056.37479601552
+                    },
+                    "output_token_price": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Provided by the quote server",
+                        "example": 97056.37479601552
+                    },
+                    "deadline": {
+                        "type": "string",
+                        "description": "Validity till the current quote is valid"
+                    },
+                    "bitcoin_optional_recipient": {
+                        "type": "string",
+                        "description": "An optional Bitcoin address to receive the output token, if specified.",
+                        "example": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"
+                    },
+                    "sig": {
+                        "type": "string",
+                        "description": "",
+                        "example": "MEYCIQDYfLzU1MxP3RLlY5YXzkKcFvndv3tZyjGtHKqbrFqJ6QIhAMTytBYJ5Fb2+9NdXdHSTHz9BUEtwxE/n9VUwqP1X5fn"
+                    },
+                    "instant_refund_tx_bytes": {
+                        "type": "string",
+                        "description": "The signature used to derive the transaction hash for an instant refund in case of transaction failure.",
+                        "example": "90a36c9fc942109060165b9db0ada8f6499302288d9d3698c6b4fa9431b5bf22"
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/static/swagger/relayer/createOrder.json b/static/swagger/relayer/createOrder.json
@@ -88,24 +88,26 @@
                                         "description": "Provided by the quote server",
                                         "example": "bre112"
                                     },
-                                    "bitcoin_optional_recipient": {
-                                        "type": "string",
-                                        "description": "An optional Bitcoin address to receive the output token, if specified.",
-                                        "example": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"
-                                    },
                                     "input_token_price": {
                                         "type": "number",
-                                        "format": "float",
-                                        "description": "Provided by the quote server."
+                                        "format": "double",
+                                        "description": "Provided by the quote server",
+                                        "example": 97056.37479601552
                                     },
                                     "output_token_price": {
                                         "type": "number",
-                                        "format": "float",
-                                        "description": "Provided by the quote server."
+                                        "format": "double",
+                                        "description": "Provided by the quote server",
+                                        "example": 97056.37479601552
                                     },
                                     "deadline": {
                                         "type": "string",
-                                        "description": "Validity till the current quote is valid."
+                                        "description": "Validity till the current quote is valid"
+                                    },
+                                    "bitcoin_optional_recipient": {
+                                        "type": "string",
+                                        "description": "An optional Bitcoin address to receive the output token, if specified.",
+                                        "example": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"
                                     },
                                     "sig": {
                                         "type": "string",