Update vocdoni-api docs by commit b9beb0f

vocdoni · Jan 9, 2024 · 7d7dfcf · 7d7dfcf
1 parent 2a8a2d2
commit 7d7dfcf
Showing 1 changed file with 109 additions and 87 deletions.
diff --git a/swaggers/vocdoni-api.yaml b/swaggers/vocdoni-api.yaml
@@ -174,7 +174,30 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/api.Account'
+                $ref: '#/components/schemas/api.AccountMetadata'
+          description: OK
+      tags:
+        - Accounts
+      description: >-
+        Get account information by its address or public key. The `infoURI` parameter contain where account metadata is uploaded (like avatar, name...). It return also an already parsed "metadata" object from this infoUri.
+
+        The `meta` object inside the `metadata` property is left to the user to add random information about the account.
+      summary: Get account
+  '/accounts/{address}/metadata':
+    get:
+      parameters:
+        - description: Account address
+          in: path
+          name: address
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/api.AccountMetadata'
           description: OK
       tags:
         - Accounts
@@ -1783,15 +1806,15 @@ components:
     api.Block:
       properties:
         data:
-          $ref: '#/components/schemas/github_com_cometbft_cometbft_types.Data'
+          $ref: '#/components/schemas/types.Data'
         evidence:
           $ref: '#/components/schemas/types.EvidenceData'
         hash:
           type: string
         header:
           $ref: '#/components/schemas/github_com_cometbft_cometbft_types.Header'
         last_commit:
-          $ref: '#/components/schemas/github_com_cometbft_cometbft_types.Commit'
+          $ref: '#/components/schemas/types.Commit'
       type: object
     api.CensusParticipant:
       properties:
@@ -2504,77 +2527,6 @@ components:
         Tx_SetSik:
           type: integer
       type: object
-    github_com_cometbft_cometbft_types.BlockID:
-      properties:
-        hash:
-          items:
-            type: integer
-          type: array
-        parts:
-          $ref: >-
-            #/components/schemas/github_com_cometbft_cometbft_types.PartSetHeader
-      type: object
-    github_com_cometbft_cometbft_types.BlockIDFlag:
-      enum:
-        - 1
-        - 2
-        - 3
-      type: integer
-      x-enum-varnames:
-        - BlockIDFlagAbsent
-        - BlockIDFlagCommit
-        - BlockIDFlagNil
-    github_com_cometbft_cometbft_types.Commit:
-      properties:
-        block_id:
-          $ref: '#/components/schemas/github_com_cometbft_cometbft_types.BlockID'
-        height:
-          description: >-
-            NOTE: The signatures are in order of address to preserve the bonded
-
-            ValidatorSet order.
-
-            Any peer with a block can gossip signatures by index with a peer without
-
-            recalculating the active ValidatorSet.
-          type: integer
-        round:
-          type: integer
-        signatures:
-          items:
-            $ref: '#/components/schemas/github_com_cometbft_cometbft_types.CommitSig'
-          type: array
-      type: object
-    github_com_cometbft_cometbft_types.CommitSig:
-      properties:
-        block_id_flag:
-          $ref: '#/components/schemas/github_com_cometbft_cometbft_types.BlockIDFlag'
-        signature:
-          items:
-            type: integer
-          type: array
-        timestamp:
-          type: string
-        validator_address:
-          items:
-            type: integer
-          type: array
-      type: object
-    github_com_cometbft_cometbft_types.Data:
-      properties:
-        txs:
-          description: >-
-            Txs that will be applied by state @ block.Height+1.
-
-            NOTE: not all txs here are valid.  We're just agreeing on the order first.
-
-            This means that block.AppHash does not include these txs.
-          items:
-            items:
-              type: integer
-            type: array
-          type: array
-      type: object
     github_com_cometbft_cometbft_types.Header:
       properties:
         app_hash:
@@ -2603,7 +2555,7 @@ components:
           type: integer
         last_block_id:
           allOf:
-            - $ref: '#/components/schemas/github_com_cometbft_cometbft_types.BlockID'
+            - $ref: '#/components/schemas/types.BlockID'
           description: prev block info
         last_commit_hash:
           description: hashes of block data
@@ -2614,7 +2566,7 @@ components:
           description: >-
             root hash of all results from the txs from the previous block
 
-            see `deterministicExecTxResult` to understand which parts of a tx is hashed into here
+            see `DeterministicExecTxResult` to understand which parts of a tx is hashed into here
           items:
             type: integer
           type: array
@@ -2637,18 +2589,9 @@ components:
           type: array
         version:
           allOf:
-            - $ref: '#/components/schemas/version.Consensus'
+            - $ref: '#/components/schemas/v1.Consensus'
           description: basic block info
       type: object
-    github_com_cometbft_cometbft_types.PartSetHeader:
-      properties:
-        hash:
-          items:
-            type: integer
-          type: array
-        total:
-          type: integer
-      type: object
     indexertypes.Account:
       properties:
         address:
@@ -3362,13 +3305,92 @@ components:
       type: object
     types.BigInt:
       type: object
+    types.BlockID:
+      properties:
+        hash:
+          items:
+            type: integer
+          type: array
+        parts:
+          $ref: '#/components/schemas/types.PartSetHeader'
+      type: object
+    types.BlockIDFlag:
+      enum:
+        - 1
+        - 2
+        - 3
+      type: integer
+      x-enum-varnames:
+        - BlockIDFlagAbsent
+        - BlockIDFlagCommit
+        - BlockIDFlagNil
+    types.Commit:
+      properties:
+        block_id:
+          $ref: '#/components/schemas/types.BlockID'
+        height:
+          description: >-
+            NOTE: The signatures are in order of address to preserve the bonded
+
+            ValidatorSet order.
+
+            Any peer with a block can gossip signatures by index with a peer without
+
+            recalculating the active ValidatorSet.
+          type: integer
+        round:
+          type: integer
+        signatures:
+          items:
+            $ref: '#/components/schemas/types.CommitSig'
+          type: array
+      type: object
+    types.CommitSig:
+      properties:
+        block_id_flag:
+          $ref: '#/components/schemas/types.BlockIDFlag'
+        signature:
+          items:
+            type: integer
+          type: array
+        timestamp:
+          type: string
+        validator_address:
+          items:
+            type: integer
+          type: array
+      type: object
+    types.Data:
+      properties:
+        txs:
+          description: >-
+            Txs that will be applied by state @ block.Height+1.
+
+            NOTE: not all txs here are valid.  We're just agreeing on the order first.
+
+            This means that block.AppHash does not include these txs.
+          items:
+            items:
+              type: integer
+            type: array
+          type: array
+      type: object
     types.EvidenceData:
       properties:
         evidence:
           items: {}
           type: array
       type: object
-    version.Consensus:
+    types.PartSetHeader:
+      properties:
+        hash:
+          items:
+            type: integer
+          type: array
+        total:
+          type: integer
+      type: object
+    v1.Consensus:
       properties:
         app:
           type: integer