Deploying to gh-pages from @ ba95827 🚀

rarimo · Feb 6, 2024 · 8990de8 · 8990de8
1 parent 30b5eb4
commit 8990de8
Show file tree

Hide file tree

Showing 2 changed files with 168 additions and 2 deletions.
diff --git a/openapi.json b/openapi.json
@@ -227,7 +227,7 @@
           "Points balance"
         ],
         "summary": "Withdraw points",
-        "description": "Convert points to RMO by exchange rate and withdraw to user wallet",
+        "description": "Convert points to RMO by exchange rate and withdraw to user wallet.\nUpdated balance with new rank is returned.\n",
         "operationId": "withdrawPoints",
         "parameters": [
           {
@@ -476,6 +476,39 @@
           }
         }
       }
+    },
+    "/integrations/rarime-points-svc/v1/point_price": {
+      "get": {
+        "tags": [
+          "Points balance"
+        ],
+        "summary": "Get point price",
+        "description": "How many `urmo` tokens cost one point.",
+        "operationId": "getPointPrice",
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "data"
+                  ],
+                  "properties": {
+                    "data": {
+                      "$ref": "#/components/schemas/PointPrice"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "500": {
+            "$ref": "#/components/responses/internalError"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -794,6 +827,54 @@
           }
         }
       },
+      "PointPrice": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PointPriceKey"
+          },
+          {
+            "type": "object",
+            "required": [
+              "attributes"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "point_price"
+                ]
+              },
+              "attributes": {
+                "type": "object",
+                "required": [
+                  "urmo"
+                ],
+                "properties": {
+                  "urmo": {
+                    "type": "integer",
+                    "description": "Amount of `urmo` tokens for one point",
+                    "example": 1000
+                  }
+                }
+              }
+            }
+          }
+        ]
+      },
+      "PointPriceKey": {
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "point_price"
+            ]
+          }
+        }
+      },
       "Withdraw": {
         "allOf": [
           {
@@ -864,6 +945,26 @@
                     "example": 1706531218
                   }
                 }
+              },
+              "relationships": {
+                "type": "object",
+                "required": [
+                  "balance"
+                ],
+                "properties": {
+                  "balance": {
+                    "type": "object",
+                    "description": null,
+                    "required": [
+                      "data"
+                    ],
+                    "properties": {
+                      "data": {
+                        "$ref": "#/components/schemas/BalanceKey"
+                      }
+                    }
+                  }
+                }
               }
             }
           }

diff --git a/openapi.yaml b/openapi.yaml
@@ -142,7 +142,9 @@ paths:
       tags:
         - Points balance
       summary: Withdraw points
-      description: Convert points to RMO by exchange rate and withdraw to user wallet
+      description: |
+        Convert points to RMO by exchange rate and withdraw to user wallet.
+        Updated balance with new rank is returned.
       operationId: withdrawPoints
       parameters:
         - $ref: '#/components/parameters/pathDID'
@@ -305,6 +307,27 @@ paths:
           $ref: '#/components/responses/notFound'
         '500':
           $ref: '#/components/responses/internalError'
+  /integrations/rarime-points-svc/v1/point_price:
+    get:
+      tags:
+        - Points balance
+      summary: Get point price
+      description: How many `urmo` tokens cost one point.
+      operationId: getPointPrice
+      responses:
+        '200':
+          description: Success
+          content:
+            application/vnd.api+json:
+              schema:
+                type: object
+                required:
+                  - data
+                properties:
+                  data:
+                    $ref: '#/components/schemas/PointPrice'
+        '500':
+          $ref: '#/components/responses/internalError'
 components:
   schemas:
     Balance:
@@ -539,6 +562,35 @@ components:
           format: time.Time
           description: General event expiration date (UTC RFC3339)
           example: 2020-01-01T00:00:00.000Z
+    PointPrice:
+      allOf:
+        - $ref: '#/components/schemas/PointPriceKey'
+        - type: object
+          required:
+            - attributes
+          properties:
+            type:
+              type: string
+              enum:
+                - point_price
+            attributes:
+              type: object
+              required:
+                - urmo
+              properties:
+                urmo:
+                  type: integer
+                  description: Amount of `urmo` tokens for one point
+                  example: 1000
+    PointPriceKey:
+      type: object
+      required:
+        - type
+      properties:
+        type:
+          type: string
+          enum:
+            - point_price
     Withdraw:
       allOf:
         - $ref: '#/components/schemas/WithdrawKey'
@@ -587,6 +639,19 @@ components:
                   type: integer
                   description: Unix timestamp of withdrawal creation
                   example: 1706531218
+            relationships:
+              type: object
+              required:
+                - balance
+              properties:
+                balance:
+                  type: object
+                  description: null
+                  required:
+                    - data
+                  properties:
+                    data:
+                      $ref: '#/components/schemas/BalanceKey'
     WithdrawalKey:
       type: object
       required: