Deploying to gh-pages from @ 0634d5e 🚀

rarimo · Jun 10, 2024 · 301054b · 301054b
1 parent bbd04ee
commit 301054b
Show file tree

Hide file tree

Showing 2 changed files with 176 additions and 19 deletions.
diff --git a/openapi.json b/openapi.json
@@ -462,6 +462,39 @@
         }
       }
     },
+    "/integrations/rarime-points-svc/v1/public/countries_config": {
+      "get": {
+        "tags": [
+          "Countries"
+        ],
+        "summary": "Get countries configuration",
+        "description": "List countries and their properties: whether it is allowed to reserve and withdraw tokens\n",
+        "operationId": "getCountriesConfig",
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "data"
+                  ],
+                  "properties": {
+                    "data": {
+                      "$ref": "#/components/schemas/CountriesConfig"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "500": {
+            "$ref": "#/components/responses/internalError"
+          }
+        }
+      }
+    },
     "/integrations/rarime-points-svc/v1/public/events": {
       "get": {
         "tags": [
@@ -857,6 +890,67 @@
           }
         }
       },
+      "CountriesConfig": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CountriesConfigKey"
+          },
+          {
+            "type": "object",
+            "required": [
+              "attributes"
+            ],
+            "properties": {
+              "attributes": {
+                "type": "object",
+                "required": [
+                  "countries"
+                ],
+                "properties": {
+                  "countries": {
+                    "type": "object",
+                    "description": "Map from country codes to their properties.\nEach code is ISO 3166-1 alpha-3 code (3-letter uppercase).\n",
+                    "additionalProperties": {
+                      "$ref": "#/components/schemas/CountryProperties"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        ]
+      },
+      "CountriesConfigKey": {
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "countries_config"
+            ]
+          }
+        }
+      },
+      "CountryProperties": {
+        "type": "object",
+        "required": [
+          "reserve_allowed",
+          "withdrawal_allowed"
+        ],
+        "properties": {
+          "reserve_allowed": {
+            "type": "boolean",
+            "description": "Whether the users of country are allowed to reserve (claim) tokens"
+          },
+          "withdrawal_allowed": {
+            "type": "boolean",
+            "description": "Whether the users of country are allowed to withdraw tokens"
+          }
+        }
+      },
       "CreateBalance": {
         "allOf": [
           {
@@ -1145,23 +1239,23 @@
               "attributes"
             ],
             "properties": {
-              "type": {
-                "type": "string",
-                "enum": [
-                  "point_price"
-                ]
-              },
               "attributes": {
                 "type": "object",
                 "required": [
-                  "urmo"
+                  "urmo",
+                  "withdrawal_allowed"
                 ],
                 "properties": {
                   "urmo": {
                     "type": "integer",
                     "format": "int64",
                     "description": "Amount of `urmo` tokens for one point",
                     "example": 1000
+                  },
+                  "withdrawal_allowed": {
+                    "type": "bool",
+                    "description": "Specify if user can withdraw points",
+                    "example": true
                   }
                 }
               }
@@ -1203,8 +1297,8 @@
                 "properties": {
                   "proof": {
                     "type": "object",
-                    "format": "json.RawMessage",
-                    "description": "JSON encoded ZK passport verification proof."
+                    "format": "types.ZKProof",
+                    "description": "Iden3 ZK passport verification proof."
                   }
                 }
               }
@@ -1266,8 +1360,8 @@
                   },
                   "proof": {
                     "type": "object",
-                    "format": "json.RawMessage",
-                    "description": "JSON encoded ZK passport verification proof."
+                    "format": "types.ZKProof",
+                    "description": "Iden3 ZK passport verification proof."
                   }
                 }
               }

diff --git a/openapi.yaml b/openapi.yaml
@@ -297,6 +297,28 @@ paths:
           $ref: '#/components/responses/invalidAuth'
         '500':
           $ref: '#/components/responses/internalError'
+  /integrations/rarime-points-svc/v1/public/countries_config:
+    get:
+      tags:
+        - Countries
+      summary: Get countries configuration
+      description: |
+        List countries and their properties: whether it is allowed to reserve and withdraw tokens
+      operationId: getCountriesConfig
+      responses:
+        '200':
+          description: Success
+          content:
+            application/vnd.api+json:
+              schema:
+                type: object
+                required:
+                  - data
+                properties:
+                  data:
+                    $ref: '#/components/schemas/CountriesConfig'
+        '500':
+          $ref: '#/components/responses/internalError'
   /integrations/rarime-points-svc/v1/public/events:
     get:
       tags:
@@ -569,6 +591,46 @@ components:
           type: string
           enum:
             - claim_event
+    CountriesConfig:
+      allOf:
+        - $ref: '#/components/schemas/CountriesConfigKey'
+        - type: object
+          required:
+            - attributes
+          properties:
+            attributes:
+              type: object
+              required:
+                - countries
+              properties:
+                countries:
+                  type: object
+                  description: |
+                    Map from country codes to their properties.
+                    Each code is ISO 3166-1 alpha-3 code (3-letter uppercase).
+                  additionalProperties:
+                    $ref: '#/components/schemas/CountryProperties'
+    CountriesConfigKey:
+      type: object
+      required:
+        - type
+      properties:
+        type:
+          type: string
+          enum:
+            - countries_config
+    CountryProperties:
+      type: object
+      required:
+        - reserve_allowed
+        - withdrawal_allowed
+      properties:
+        reserve_allowed:
+          type: boolean
+          description: Whether the users of country are allowed to reserve (claim) tokens
+        withdrawal_allowed:
+          type: boolean
+          description: Whether the users of country are allowed to withdraw tokens
     CreateBalance:
       allOf:
         - $ref: '#/components/schemas/CreateBalanceKey'
@@ -781,20 +843,21 @@ components:
           required:
             - attributes
           properties:
-            type:
-              type: string
-              enum:
-                - point_price
             attributes:
               type: object
               required:
                 - urmo
+                - withdrawal_allowed
               properties:
                 urmo:
                   type: integer
                   format: int64
                   description: Amount of `urmo` tokens for one point
                   example: 1000
+                withdrawal_allowed:
+                  type: bool
+                  description: Specify if user can withdraw points
+                  example: true
     PointPriceKey:
       type: object
       required:
@@ -819,8 +882,8 @@ components:
               properties:
                 proof:
                   type: object
-                  format: json.RawMessage
-                  description: JSON encoded ZK passport verification proof.
+                  format: types.ZKProof
+                  description: Iden3 ZK passport verification proof.
     VerifyPassportKey:
       type: object
       required:
@@ -862,8 +925,8 @@ components:
                   example: rarimo15hcd6tv7pe8hk2re7hu0zg0aphqdm2dtjrs0ds
                 proof:
                   type: object
-                  format: json.RawMessage
-                  description: JSON encoded ZK passport verification proof.
+                  format: types.ZKProof
+                  description: Iden3 ZK passport verification proof.
     Withdrawal:
       allOf:
         - $ref: '#/components/schemas/WithdrawalKey'