Add examples to the openapi spec.

formancehq · Jun 13, 2022 · 9fab781 · 9fab781
1 parent d3663d1
commit 9fab781
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/pkg/api/controllers/swagger.yaml b/pkg/api/controllers/swagger.yaml
@@ -880,14 +880,38 @@ components:
       required:
       - input
       - output
+      example:
+        input: 100
+        output: 20
+        balance: 80
     Volumes:
       type: object
       additionalProperties:
         $ref: '#/components/schemas/Volume'
+      example:
+        USD:
+          input: 100
+          output: 10
+          balance: 90
+        EUR:
+          input: 100
+          output: 10
+          balance: 90
     AggregatedVolumes:
       type: object
       additionalProperties:
         $ref: '#/components/schemas/Volumes'
+      example:
+        "orders:1":
+          "USD":
+            input: 100
+            output: 10
+            balance: 90
+        "orders:2":
+          "USD":
+            input: 100
+            output: 10
+            balance: 90
     ErrorCode:
       type: string
       enum: