fix(apps/hermes): fix encoding description (#1640)

cctdaniel · web-flow · commit 5309b92ee39a · 2024-06-01T11:05:44.000+09:00
* update encoding desc

* revert version

* bump version
diff --git a/apps/hermes/Cargo.lock b/apps/hermes/Cargo.lock
diff --git a/apps/hermes/Cargo.toml b/apps/hermes/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name        = "hermes"
-version     = "0.5.9"
+version     = "0.5.10"
 description = "Hermes is an agent that provides Verified Prices from the Pythnet Pyth Oracle."
 edition     = "2021"
 
diff --git a/apps/hermes/src/api/rest/v2/latest_price_updates.rs b/apps/hermes/src/api/rest/v2/latest_price_updates.rs
@@ -50,7 +50,7 @@ pub struct LatestPriceUpdatesQueryParams {
     #[param(example = "e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43")]
     ids: Vec<PriceIdInput>,
 
-    /// If true, include the parsed price update in the `parsed` field of each returned feed. Default is `hex`.
+    /// Optional encoding type. If true, return the price update in the encoding specified by the encoding parameter. Default is `hex`.
     #[serde(default)]
     encoding: EncodingType,
 
diff --git a/apps/hermes/src/api/rest/v2/sse.rs b/apps/hermes/src/api/rest/v2/sse.rs
@@ -58,7 +58,7 @@ pub struct StreamPriceUpdatesQueryParams {
     #[param(example = "e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43")]
     ids: Vec<PriceIdInput>,
 
-    /// If true, include the parsed price update in the `parsed` field of each returned feed. Default is `hex`.
+    /// Optional encoding type. If true, return the price update in the encoding specified by the encoding parameter. Default is `hex`.
     #[serde(default)]
     encoding: EncodingType,
 
diff --git a/apps/hermes/src/api/rest/v2/timestamp_price_updates.rs b/apps/hermes/src/api/rest/v2/timestamp_price_updates.rs
@@ -60,7 +60,7 @@ pub struct TimestampPriceUpdatesQueryParams {
     #[param(example = "e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43")]
     ids: Vec<PriceIdInput>,
 
-    /// If true, include the parsed price update in the `parsed` field of each returned feed. Default is `hex`.
+    /// Optional encoding type. If true, return the price update in the encoding specified by the encoding parameter. Default is `hex`.
     #[serde(default)]
     encoding: EncodingType,
 
