Deploying to gh-pages from @ 05695bd 🚀

rarimo · Jun 19, 2024 · a5d7ad8 · a5d7ad8
1 parent 2d5f7b9
commit a5d7ad8
Show file tree

Hide file tree

Showing 2 changed files with 136 additions and 0 deletions.
diff --git a/openapi.json b/openapi.json
@@ -210,6 +210,41 @@
         }
       }
     },
+    "/token/details": {
+      "get": {
+        "tags": [
+          "Tokens"
+        ],
+        "summary": "Get details",
+        "description": "Get service token's details",
+        "operationId": "GetDetails",
+        "responses": {
+          "200": {
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "data"
+                  ],
+                  "properties": {
+                    "data": {
+                      "$ref": "#/components/schemas/TokenDetails"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/invalidParameter"
+          },
+          "500": {
+            "$ref": "#/components/responses/internalError"
+          }
+        }
+      }
+    },
     "/transfer": {
       "post": {
         "tags": [
@@ -782,6 +817,53 @@
           }
         ]
       },
+      "TokenDetails": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/TokenKey"
+          },
+          {
+            "type": "object",
+            "required": [
+              "attributes"
+            ],
+            "properties": {
+              "attributes": {
+                "type": "object",
+                "required": [
+                  "name",
+                  "symbol",
+                  "decimals",
+                  "image"
+                ],
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "ERC20 token name",
+                    "example": "USD Dollar"
+                  },
+                  "symbol": {
+                    "type": "string",
+                    "description": "ERC20 token symbol",
+                    "example": "USDD"
+                  },
+                  "decimals": {
+                    "type": "integer",
+                    "format": "uint8",
+                    "description": "ERC20 token decimals",
+                    "example": 12
+                  },
+                  "image": {
+                    "type": "string",
+                    "description": "ERC20 token symbol image",
+                    "example": "https://image_link/usdd.png"
+                  }
+                }
+              }
+            }
+          }
+        ]
+      },
       "TokenKey": {
         "type": "object",
         "required": [

diff --git a/openapi.yaml b/openapi.yaml
@@ -131,6 +131,28 @@ paths:
           $ref: '#/components/responses/invalidParameter'
         '500':
           $ref: '#/components/responses/internalError'
+  /token/details:
+    get:
+      tags:
+        - Tokens
+      summary: Get details
+      description: Get service token's details
+      operationId: GetDetails
+      responses:
+        '200':
+          content:
+            application/vnd.api+json:
+              schema:
+                type: object
+                required:
+                  - data
+                properties:
+                  data:
+                    $ref: '#/components/schemas/TokenDetails'
+        '400':
+          $ref: '#/components/responses/invalidParameter'
+        '500':
+          $ref: '#/components/responses/internalError'
   /transfer:
     post:
       tags:
@@ -509,6 +531,38 @@ components:
                   type: string
                   description: Permit message hash built by ERC-2612 standard that has to be signed by token owner.
                   example: '0x3f77218a74501051ac9f069e73523519e6a6cf34783811515da5a178e86634ca'
+    TokenDetails:
+      allOf:
+        - $ref: '#/components/schemas/TokenKey'
+        - type: object
+          required:
+            - attributes
+          properties:
+            attributes:
+              type: object
+              required:
+                - name
+                - symbol
+                - decimals
+                - image
+              properties:
+                name:
+                  type: string
+                  description: ERC20 token name
+                  example: USD Dollar
+                symbol:
+                  type: string
+                  description: ERC20 token symbol
+                  example: USDD
+                decimals:
+                  type: integer
+                  format: uint8
+                  description: ERC20 token decimals
+                  example: 12
+                image:
+                  type: string
+                  description: ERC20 token symbol image
+                  example: 'https://image_link/usdd.png'
     TokenKey:
       type: object
       required: