Merge branch 'release/v1.0.2'

nekofar · Oct 12, 2021 · 2efd137 · 2efd137
2 parents 7d3cc81 + 0243a63
commit 2efd137
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 23 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -13,12 +13,12 @@ jobs:
       release_body: ${{ steps.release.outputs.RELEASE_BODY }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v2.3.4
         with:
           fetch-depth: 0
 
       - name: Generate a changelog
-        uses: orhun/git-cliff-action@v1
+        uses: orhun/git-cliff-action@v1.1.5
         id: git-cliff
         with:
           config: cliff.toml

diff --git a/.github/workflows/tests.yaml → .github/workflows/tests.yml b/.github/workflows/tests.yaml → .github/workflows/tests.yml
@@ -10,12 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v2.3.4
 
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v2.4.1
         with:
           node-version: "16"
 
       - name: Lint OpenAPI
-        run: npx @redocly/openapi-cli lint src/openapi.yaml
+        run: npx @redocly/openapi-cli lint src/openapi.yaml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,28 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.0.2] - 2021-10-12
+
+### Bug Fixes
+
+- Add missing `execution` property for `market/orders/add` on `requestBody`
+
+### Refactor
+
+- Update `market/orders/add` examples
+
+## [1.0.1] - 2021-09-24
+
+### Documentation
+
+- Add the contributing file
+- Add link to the api docs to the readme
+
+### Miscellaneous Tasks
+
+- Add new script for test
+- Change version over main file to 1.0.1
+
 ## [1.0.0] - 2021-09-24
 
 ### Bug Fixes

diff --git a/src/resources/market/orders/add.yaml b/src/resources/market/orders/add.yaml
@@ -15,15 +15,22 @@ post:
           properties:
             type:
               type: string
+              example: "buy"
+            execution:
+              type: string
+              example: "market"
             srcCurrency:
               type: string
+              example: "btc"
             dstCurrency:
               type: string
+              example: "usdt"
             amount:
-              type: string
+              type: number
+              example: 0.0623
             price:
               type: number
-          example: { "type": "buy","srcCurrency": "btc","dstCurrency": "rls","amount": "0.6","price": 520000000 }
+              example: 1210000000
 
   responses:
     200:
@@ -41,48 +48,46 @@ post:
                 properties:
                   type:
                     type: string
+                    example: "sell"
                   srcCurrency:
                     type: string
+                    example: "Bitcoin"
                   dstCurrency:
                     type: string
+                    example: "ریال"
                   price:
                     type: string
+                    example: "520000000"
                   amount:
                     type: string
+                    example: "0.6"
                   totalPrice:
                     type: string
+                    example: "312000000.0"
                   matchedAmount:
                     type: number
+                    example: 0
                   unmatchedAmount:
                     type: string
+                    example: "0.6"
                   id:
                     type: number
+                    example: 25
                   status:
                     type: string
+                    example: "Active"
                   partial:
                     type: boolean
+                    example: false
                   fee:
                     type: number
+                    example: 0
                   user:
                     type: string
+                    example: "name@example.com"
                   created_at:
                     type: string
-                example: {
-                  "type": "sell",
-                  "srcCurrency": "Bitcoin",
-                  "dstCurrency": "ریال",
-                  "price": "520000000",
-                  "amount": "0.6",
-                  "totalPrice": "312000000.0",
-                  "matchedAmount": 0,
-                  "unmatchedAmount": "0.6",
-                  "id": 25,
-                  "status": "Active",
-                  "partial": false,
-                  "fee": 0,
-                  "user": "name@example.com",
-                  "created_at": "2018-11-28T11:36:13.592827+00:00"
-                }
+                    example: "2018-11-28T11:36:13.592827+00:00"
 
   security:
     - bearerAuth: [ ]