update documentation

provenance-io · Aug 30, 2023 · 7429bc3 · 7429bc3
1 parent 624d29a
commit 7429bc3
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 7 deletions.
diff --git a/client/docs/statik/statik.go b/client/docs/statik/statik.go
diff --git a/client/docs/swagger-ui/swagger.yaml b/client/docs/swagger-ui/swagger.yaml
@@ -36182,7 +36182,9 @@ paths:
                     volume:
                       type: string
                       format: uint64
-                      title: volume is the volume of the assets
+                      title: >-
+                        volume is the total quantity of the marker associated
+                        with the price
                     updated_block_height:
                       type: string
                       format: uint64
@@ -83303,7 +83305,7 @@ definitions:
       volume:
         type: string
         format: uint64
-        title: volume is the volume of the assets
+        title: volume is the total quantity of the marker associated with the price
       updated_block_height:
         type: string
         format: uint64
@@ -83924,7 +83926,9 @@ definitions:
             volume:
               type: string
               format: uint64
-              title: volume is the volume of the assets
+              title: >-
+                volume is the total quantity of the marker associated with the
+                price
             updated_block_height:
               type: string
               format: uint64

diff --git a/docs/proto-docs.md b/docs/proto-docs.md
@@ -1709,7 +1709,7 @@ NetAssetValue defines a marker's net asset value
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `price` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) |  | price is the complete value of the asset's volume |
-| `volume` | [uint64](#uint64) |  | volume is the volume of the assets |
+| `volume` | [uint64](#uint64) |  | volume is the total quantity of the marker associated with the price |
 | `updated_block_height` | [uint64](#uint64) |  | updated_block_height is the block height of last update |
 
 

diff --git a/proto/provenance/marker/v1/marker.proto b/proto/provenance/marker/v1/marker.proto
@@ -97,7 +97,7 @@ enum MarkerStatus {
 message NetAssetValue {
   // price is the complete value of the asset's volume
   cosmos.base.v1beta1.Coin price = 1 [(gogoproto.nullable) = false];
-  // volume is the volume of the assets
+  // volume is the total quantity of the marker associated with the price
   uint64 volume = 2;
   // updated_block_height is the block height of last update
   uint64 updated_block_height = 3;

diff --git a/x/marker/types/marker.pb.go b/x/marker/types/marker.pb.go