Update vocdoni-api docs by commit 35a1ad4

vocdoni · Oct 9, 2023 · 9787f10 · 9787f10
1 parent 32d96e0
commit 9787f10
Showing 1 changed file with 143 additions and 2 deletions.
diff --git a/swaggers/vocdoni-api.yaml b/swaggers/vocdoni-api.yaml
@@ -49,6 +49,38 @@ paths:
       description: >-
         Get treasurer address. The treasurer is a new authority entity identified by its Ethereum address and is the only one that can Mint new tokens.
       summary: Get treasurer address
+  '/accounts/{accountID}/fees/page/{page}':
+    get:
+      parameters:
+        - description: Specific accountID
+          in: path
+          name: accountID
+          required: true
+          schema:
+            type: string
+        - description: Paginator page
+          in: path
+          name: page
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  fees:
+                    items:
+                      $ref: '#/components/schemas/indexertypes.TokenFeeMeta'
+                    type: array
+                type: object
+          description: OK
+      tags:
+        - Accounts
+      description: >-
+        Returns the token fees for an account. A spending is an amount of tokens burnt from one account for executing transactions.
+      summary: List account token fees
   '/accounts/{accountID}/transfers/page/{page}':
     get:
       parameters:
@@ -460,7 +492,7 @@ paths:
           description: 'Census type "weighted", "zkweighted", "csp'
       tags:
         - Censuses
-      description: Get the type of a census
+      description: Get the census type
       summary: Get type of census
   '/censuses/{censusID}/verify':
     post:
@@ -652,6 +684,96 @@ paths:
         - Chain
       description: Returns the estimated block height for the timestamp provided
       summary: Estimate date to block
+  '/chain/fees/page/{page}':
+    get:
+      parameters:
+        - description: Paginator page
+          in: path
+          name: page
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  fees:
+                    items:
+                      $ref: '#/components/schemas/indexertypes.TokenFeeMeta'
+                    type: array
+                type: object
+          description: OK
+      tags:
+        - Accounts
+      description: >-
+        Returns the token fees list ordered by date. A spending is an amount of tokens burnt from one account for executing transactions.
+      summary: List all token fees
+  '/chain/fees/reference/{reference}/page/{page}':
+    get:
+      parameters:
+        - description: Reference filter
+          in: path
+          name: reference
+          required: true
+          schema:
+            type: string
+        - description: Paginator page
+          in: path
+          name: page
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  fees:
+                    items:
+                      $ref: '#/components/schemas/indexertypes.TokenFeeMeta'
+                    type: array
+                type: object
+          description: OK
+      tags:
+        - Accounts
+      description: >-
+        Returns the token fees list filtered by reference and ordered by date. A spending is an amount of tokens burnt from one account for executing transactions.
+      summary: List all token fees by reference
+  '/chain/fees/type/{type}/page/{page}':
+    get:
+      parameters:
+        - description: Type filter
+          in: path
+          name: type
+          required: true
+          schema:
+            type: string
+        - description: Paginator page
+          in: path
+          name: page
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  fees:
+                    items:
+                      $ref: '#/components/schemas/indexertypes.TokenFeeMeta'
+                    type: array
+                type: object
+          description: OK
+      tags:
+        - Accounts
+      description: >-
+        Returns the token fees list filtered by type and ordered by date. A spending is an amount of tokens burnt from one account for executing transactions.
+      summary: List all token fees by type
   /chain/info:
     get:
       responses:
@@ -1409,7 +1531,7 @@ paths:
       tags:
         - Wallet
       description: >-
-        Add a new account to the local store. It return a token used to manage this account on the future.
+        Add a new account to the local store. It returns a token used to manage this account on the future.
       summary: Add account
   /wallet/bootstrap:
     get:
@@ -1722,6 +1844,8 @@ components:
           type: string
         streamUri:
           type: string
+        tempSIKs:
+          type: boolean
         title:
           $ref: '#/components/schemas/api.LanguageString'
         voteType:
@@ -2344,6 +2468,23 @@ components:
         total:
           type: integer
       type: object
+    indexertypes.TokenFeeMeta:
+      properties:
+        cost:
+          type: integer
+        from:
+          items:
+            type: integer
+          type: array
+        height:
+          type: integer
+        reference:
+          type: string
+        timestamp:
+          type: string
+        txType:
+          type: string
+      type: object
     indexertypes.TokenTransferMeta:
       properties:
         amount: