Update auto-generated docs (#247)

helius-labs · Nov 11, 2024 · a2ec595 · a2ec595
1 parent 0011995
commit a2ec595
Show file tree

Hide file tree

Showing 26 changed files with 126 additions and 124 deletions.
diff --git a/src/common/typedefs/hash.rs b/src/common/typedefs/hash.rs
@@ -47,7 +47,9 @@ impl<'__s> ToSchema<'__s> for Hash {
                 .schema_type(SchemaType::String)
                 .description(Some("A 32-byte hash represented as a base58 string."))
                 .example(Some(serde_json::Value::String(
-                    Hash::new_unique().to_base58(),
+                    Hash::try_from("11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP")
+                        .unwrap()
+                        .to_base58(),
                 )))
                 .build(),
         );

diff --git a/src/openapi/mod.rs b/src/openapi/mod.rs
@@ -323,7 +323,7 @@ pub fn update_docs(is_test: bool) {
         path_item.summary = Some(spec.name.clone());
         doc.paths.paths.insert("/".to_string(), path_item);
         doc.servers = Some(vec![ServerBuilder::new()
-            .url("https://devnet.helius-rpc.com?api-key=<api_key>".to_string())
+            .url("https://mainnet.helius-rpc.com?api-key=<api_key>".to_string())
             .build()]);
 
         let yaml = doc.to_yaml().unwrap();

diff --git a/src/openapi/specs/getCompressedAccount.yaml b/src/openapi/specs/getCompressedAccount.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api_key>:
+  /:
     summary: getCompressedAccount
     post:
       requestBody:
@@ -55,7 +55,7 @@ paths:
                   additionalProperties: false
                   example:
                     address: null
-                    hash: '11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP'
+                    hash: '11111111111111111111111111111111'
         required: true
       responses:
         '200':

diff --git a/src/openapi/specs/getCompressedAccountBalance.yaml b/src/openapi/specs/getCompressedAccountBalance.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api_key>:
+  /:
     summary: getCompressedAccountBalance
     post:
       requestBody:
@@ -105,12 +105,12 @@ components:
     Hash:
       type: string
       description: A 32-byte hash represented as a base58 string.
-      example: 11111113R2cuenjG5nFubqX9Wzuukdin2YfGQVzu5
+      example: 11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 111111131h1vYVSYuKP6AhS86fbRdMw9XHiZAvAaj
-      example: 111111131h1vYVSYuKP6AhS86fbRdMw9XHiZAvAaj
+      default: 11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP
+      example: 11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP
     UnsignedInteger:
       type: integer
       default: 100

diff --git a/src/openapi/specs/getCompressedAccountProof.yaml b/src/openapi/specs/getCompressedAccountProof.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api-key>:
+  /:
     summary: getCompressedAccountProof
     post:
       requestBody:
@@ -93,7 +93,7 @@ components:
     Hash:
       type: string
       description: A 32-byte hash represented as a base58 string.
-      example: 1111111BTngbpkVTh3nGGdFdufHcG5TN7hXV6AfDy
+      example: 11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP
     MerkleProofWithContext:
       type: object
       required:
@@ -126,5 +126,5 @@ components:
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 1111111B4T5ciTCkWauSqVAcVKy88ofjcSamrapud
-      example: 1111111B4T5ciTCkWauSqVAcVKy88ofjcSamrapud
+      default: 11111116djSnXB2wXVGT4xDLsfTnkp1p4cCxHAfRq
+      example: 11111116djSnXB2wXVGT4xDLsfTnkp1p4cCxHAfRq
diff --git a/src/openapi/specs/getCompressedAccountsByOwner.yaml b/src/openapi/specs/getCompressedAccountsByOwner.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api_key>:
+  /:
     summary: getCompressedAccountsByOwner
     post:
       requestBody:
@@ -181,7 +181,7 @@ components:
     Hash:
       type: string
       description: A 32-byte hash represented as a base58 string.
-      example: 11111116djSnXB2wXVGT4xDLsfTnkp1p4cCxHAfRq
+      example: 11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP
     Limit:
       type: integer
       format: int64
@@ -212,8 +212,8 @@ components:
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 11111116EPqoQskEM2Pddp8KTL9JdYEBZMGF3aq7V
-      example: 11111116EPqoQskEM2Pddp8KTL9JdYEBZMGF3aq7V
+      default: 11111114DhpssPJgSi1YU7hCMfYt1BJ334YgsffXm
+      example: 11111114DhpssPJgSi1YU7hCMfYt1BJ334YgsffXm
     UnsignedInteger:
       type: integer
       default: 100

diff --git a/src/openapi/specs/getCompressedBalanceByOwner.yaml b/src/openapi/specs/getCompressedBalanceByOwner.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api_key>:
+  /:
     summary: getCompressedBalanceByOwner
     post:
       requestBody:
@@ -93,8 +93,8 @@ components:
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 11111114d3RrygbPdAtMuFnDmzsN8T5fYKVQ7FVr7
-      example: 11111114d3RrygbPdAtMuFnDmzsN8T5fYKVQ7FVr7
+      default: 11111113R2cuenjG5nFubqX9Wzuukdin2YfGQVzu5
+      example: 11111113R2cuenjG5nFubqX9Wzuukdin2YfGQVzu5
     UnsignedInteger:
       type: integer
       default: 100

diff --git a/src/openapi/specs/getCompressedMintTokenHolders.yaml b/src/openapi/specs/getCompressedMintTokenHolders.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api-key>:
+  /:
     summary: getCompressedMintTokenHolders
     post:
       requestBody:
@@ -132,8 +132,8 @@ components:
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 11111117353mdUKehx9GW6JNHznGt5oSZs9fWkVkB
-      example: 11111117353mdUKehx9GW6JNHznGt5oSZs9fWkVkB
+      default: 11111114d3RrygbPdAtMuFnDmzsN8T5fYKVQ7FVr7
+      example: 11111114d3RrygbPdAtMuFnDmzsN8T5fYKVQ7FVr7
     UnsignedInteger:
       type: integer
       default: 100

diff --git a/src/openapi/specs/getCompressedTokenAccountBalance.yaml b/src/openapi/specs/getCompressedTokenAccountBalance.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api_key>:
+  /:
     summary: getCompressedTokenAccountBalance
     post:
       requestBody:
@@ -105,12 +105,12 @@ components:
     Hash:
       type: string
       description: A 32-byte hash represented as a base58 string.
-      example: 11111114DhpssPJgSi1YU7hCMfYt1BJ334YgsffXm
+      example: 11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 11111113pNDtm61yGF8j2ycAwLEPsuWQXobye5qDR
-      example: 11111113pNDtm61yGF8j2ycAwLEPsuWQXobye5qDR
+      default: 111111131h1vYVSYuKP6AhS86fbRdMw9XHiZAvAaj
+      example: 111111131h1vYVSYuKP6AhS86fbRdMw9XHiZAvAaj
     TokenAccountBalance:
       type: object
       required:

diff --git a/src/openapi/specs/getCompressedTokenAccountsByDelegate.yaml b/src/openapi/specs/getCompressedTokenAccountsByDelegate.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api_key>:
+  /:
     summary: getCompressedTokenAccountsByDelegate
     post:
       requestBody:
@@ -165,16 +165,16 @@ components:
     Hash:
       type: string
       description: A 32-byte hash represented as a base58 string.
-      example: 11111119rSGfPZLcyCGzY4uYEL1fkzJr6fke9qKxb
+      example: 11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP
     Limit:
       type: integer
       format: int64
       minimum: 0
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF
-      example: 11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF
+      default: 11111115q4EpJaTXAZWpCg3J2zppWGSZ46KXozzo9
+      example: 11111115q4EpJaTXAZWpCg3J2zppWGSZ46KXozzo9
     TokenAcccount:
       type: object
       required:

diff --git a/src/openapi/specs/getCompressedTokenAccountsByOwner.yaml b/src/openapi/specs/getCompressedTokenAccountsByOwner.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api_key>:
+  /:
     summary: getCompressedTokenAccountsByOwner
     post:
       requestBody:
@@ -165,16 +165,16 @@ components:
     Hash:
       type: string
       description: A 32-byte hash represented as a base58 string.
-      example: 111111193m4hAxmCcGXMfnjVPfNhWSjb69sDgffKu
+      example: 11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP
     Limit:
       type: integer
       format: int64
       minimum: 0
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 11111118eRTi4fUVRoeYEeeTyL4DPAwxatvWT5q1Z
-      example: 11111118eRTi4fUVRoeYEeeTyL4DPAwxatvWT5q1Z
+      default: 11111115RidqCHAoz6dzmXxGcfWLNzevYqNpaRAUo
+      example: 11111115RidqCHAoz6dzmXxGcfWLNzevYqNpaRAUo
     TokenAcccount:
       type: object
       required:

diff --git a/src/openapi/specs/getCompressedTokenBalancesByOwner.yaml b/src/openapi/specs/getCompressedTokenBalancesByOwner.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api_key>:
+  /:
     summary: getCompressedTokenBalancesByOwner
     post:
       requestBody:
@@ -115,8 +115,8 @@ components:
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 11111115RidqCHAoz6dzmXxGcfWLNzevYqNpaRAUo
-      example: 11111115RidqCHAoz6dzmXxGcfWLNzevYqNpaRAUo
+      default: 11111113pNDtm61yGF8j2ycAwLEPsuWQXobye5qDR
+      example: 11111113pNDtm61yGF8j2ycAwLEPsuWQXobye5qDR
     TokenBalance:
       type: object
       required:

diff --git a/src/openapi/specs/getCompressionSignaturesForAccount.yaml b/src/openapi/specs/getCompressionSignaturesForAccount.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api-key>:
+  /:
     summary: getCompressionSignaturesForAccount
     post:
       requestBody:
@@ -93,7 +93,7 @@ components:
     Hash:
       type: string
       description: A 32-byte hash represented as a base58 string.
-      example: 1111111FVAiSujNZVgYSc27t6zUTWoKfAGxbRzzPR
+      example: 11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP
     SerializableSignature:
       type: string
       description: A Solana transaction signature.

diff --git a/src/openapi/specs/getCompressionSignaturesForAddress.yaml b/src/openapi/specs/getCompressionSignaturesForAddress.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api-key>:
+  /:
     summary: getCompressionSignaturesForAddress
     post:
       requestBody:
@@ -117,8 +117,8 @@ components:
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 1111111FtWKS22fGg9RG3ACuXKnwe57HfXuJfaphm
-      example: 1111111FtWKS22fGg9RG3ACuXKnwe57HfXuJfaphm
+      default: 111111193m4hAxmCcGXMfnjVPfNhWSjb69sDgffKu
+      example: 111111193m4hAxmCcGXMfnjVPfNhWSjb69sDgffKu
     SerializableSignature:
       type: string
       description: A Solana transaction signature.

diff --git a/src/openapi/specs/getCompressionSignaturesForOwner.yaml b/src/openapi/specs/getCompressionSignaturesForOwner.yaml
@@ -4,11 +4,11 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.45.0
+  version: 0.47.0
 servers:
-- url: https://mainnet.helius-rpc.com
+- url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
-  /?api-key=<api-key>:
+  /:
     summary: getCompressionSignaturesForOwner
     post:
       requestBody:
@@ -117,8 +117,8 @@ components:
     SerializablePubkey:
       type: string
       description: A Solana public key represented as a base58 string.
-      default: 1111111GhBXQEdEh35AtuSNxMzRutcgYg3nj8kVLT
-      example: 1111111GhBXQEdEh35AtuSNxMzRutcgYg3nj8kVLT
+      default: 11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF
+      example: 11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF
     SerializableSignature:
       type: string
       description: A Solana transaction signature.