chore(swagger): use testnet contract for all examples in swagger

ar-io · Nov 16, 2023 · 4707894 · 4707894
1 parent 7fb6966
commit 4707894
Showing 1 changed file with 23 additions and 23 deletions.
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
@@ -92,7 +92,7 @@ paths:
           description: Transaction ID of the contract.
           schema:
             type: string
-            example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+            example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
       responses:
         '200':
           description: OK
@@ -103,7 +103,7 @@ paths:
                 properties:
                   contractTxId:
                     type: string
-                    example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+                    example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
                   state:
                     $ref: '#/components/schemas/ArNsContractState'
                   sortKey:
@@ -116,19 +116,19 @@ paths:
         '503':
           description: Internal server error.
 
-  /contract/{contractTxId}/read:
+  /contract/{contractTxId}/read/{functionName}:
     get:
       summary: Get the result of a contract read interaction with input parameters
-      description: Retrieves the result for a specific contract read interaction with given parameters.
+      description: Retrieves the result for a specific contract read interaction with given parameters. Use query params for input parameters.
       parameters:
         - in: path
           name: contractTxId
           required: true
           schema:
             type: string
-            example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+            example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
           description: Unique identifier of the contract.
-        - in: query
+        - in: path
           name: functionName
           required: true
           schema:
@@ -145,7 +145,7 @@ paths:
                 properties:
                   contractTxId:
                     type: string
-                    example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+                    example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
                   result:
                     type: object
                     description: The returned result of the read interaction from the Smartweave contract
@@ -167,7 +167,7 @@ paths:
           required: true
           schema:
             type: string
-            example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+            example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
           description: Unique identifier of the contract.
         - in: query
           name: interactionName
@@ -206,7 +206,7 @@ paths:
                 properties:
                   contractTxId:
                     type: string
-                    example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+                    example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
                   result:
                     type: object
                     description: The returned result of the read interaction from the Smartweave contract
@@ -242,7 +242,7 @@ paths:
           description: Transaction ID of the contract.
           schema:
             type: string
-            example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+            example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
         - in: path
           name: field
           required: true
@@ -260,7 +260,7 @@ paths:
                 properties:
                   contractTxId:
                     type: string
-                    example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+                    example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
                   field:
                     type: any
                     example: {}
@@ -281,7 +281,7 @@ paths:
           description: ID of the root contract.
           schema:
             type: string
-            example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+            example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
         - in: query
           name: contractTxId
           required: true
@@ -299,7 +299,7 @@ paths:
                 properties:
                   contractTxId:
                     type: string
-                    example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+                    example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
                   records:
                     type: array
                     example:
@@ -338,7 +338,7 @@ paths:
           description: Transaction ID of the contract.
           schema:
             type: string
-            example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+            example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
         - in: path
           name: name
           required: true
@@ -356,7 +356,7 @@ paths:
                 properties:
                   contractTxId:
                     type: string
-                    example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+                    example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
                   name:
                     type: string
                     example: 'ario'
@@ -398,7 +398,7 @@ paths:
           description: Transaction ID of the contract.
           schema:
             type: string
-            example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+            example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
         - in: path
           name: walletAddress
           required: true
@@ -416,7 +416,7 @@ paths:
                 properties:
                   contractTxId:
                     type: string
-                    example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+                    example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
                   address:
                     type: string
                     example: 'QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ'
@@ -441,7 +441,7 @@ paths:
           description: Transaction ID of the contract.
           schema:
             type: string
-            example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+            example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
       responses:
         '200':
           description: OK
@@ -452,7 +452,7 @@ paths:
                 properties:
                   contractTxId:
                     type: string
-                    example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+                    example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
                   interactions:
                     $ref: '#/components/schemas/ContractInteraction'
                   evaluationOptions:
@@ -472,7 +472,7 @@ paths:
           description: Transaction ID of the contract.
           schema:
             type: string
-            example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+            example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
         - in: path
           name: walletAddress
           required: true
@@ -490,7 +490,7 @@ paths:
                 properties:
                   contractTxId:
                     type: string
-                    example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+                    example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
                   address:
                     type: string
                     example: 'QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ'
@@ -585,7 +585,7 @@ paths:
           description: Transaction ID of the contract.
           schema:
             type: string
-            example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+            example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
       responses:
         '200':
           description: OK
@@ -599,7 +599,7 @@ paths:
                     example: 'QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ'
                   contractTxId:
                     type: string
-                    example: '3aX8Ck5_IRLA3L9o4BJLOWxJDrmLLIPoUGZxqOfmHDI'
+                    example: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U'
                   interactions:
                     type: array
                     example: