Remove newAddresses from documentation (helius-labs#256)

Lightprotocol · Dec 12, 2024 · 211513f · 211513f
1 parent 5ac2955
commit 211513f
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 6 deletions.
diff --git a/src/api/api.rs b/src/api/api.rs
@@ -5,6 +5,7 @@ use solana_client::nonblocking::rpc_client::RpcClient;
 use utoipa::openapi::{ObjectBuilder, RefOr, Schema, SchemaType};
 use utoipa::ToSchema;
 
+use crate::api::method::get_validity_proof::GetValidityProofRequestDocumentation;
 use crate::api::method::utils::GetNonPaginatedSignaturesResponse;
 use crate::common::typedefs::unsigned_integer::UnsignedInteger;
 
@@ -375,7 +376,7 @@ impl PhotonApi {
             },
             OpenApiSpec {
                 name: "getValidityProof".to_string(),
-                request: Some(GetValidityProofRequest::schema().1),
+                request: Some(GetValidityProofRequestDocumentation::schema().1),
                 response: GetValidityProofResponse::schema().1,
             },
             OpenApiSpec {

diff --git a/src/api/method/get_validity_proof.rs b/src/api/method/get_validity_proof.rs
@@ -258,6 +258,17 @@ pub struct GetValidityProofRequest {
     pub newAddressesWithTrees: Vec<AddressWithTree>,
 }
 
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
+#[serde(deny_unknown_fields, rename_all = "camelCase")]
+#[allow(non_snake_case)]
+// Create to hide the deprecated newAddresses field from the documentation
+pub struct GetValidityProofRequestDocumentation {
+    #[serde(default)]
+    pub hashes: Vec<Hash>,
+    #[serde(default)]
+    pub newAddressesWithTrees: Vec<AddressWithTree>,
+}
+
 #[derive(Serialize, Deserialize, ToSchema)]
 #[serde(deny_unknown_fields, rename_all = "camelCase")]
 pub struct GetValidityProofResponse {

diff --git a/src/openapi/specs/getValidityProof.yaml b/src/openapi/specs/getValidityProof.yaml
@@ -44,11 +44,6 @@ paths:
                       type: array
                       items:
                         $ref: '#/components/schemas/Hash'
-                    newAddresses:
-                      type: array
-                      items:
-                        $ref: '#/components/schemas/SerializablePubkey'
-                      deprecated: true
                     newAddressesWithTrees:
                       type: array
                       items: