Add API version and custom headers

codegen/build-oas.sh

@@ -1,13 +1,20 @@
 #!/bin/bash
 
+version=$1
+
+if [ -z "$version" ]; then
+	echo "Version is required"
+	exit 1
+fi
+
 pushd codegen/apis
 	just build
 popd
 
 outdir="openapi"
 
 docker run --rm -v $(pwd):/workspace openapitools/openapi-generator-cli:v7.6.0 generate \
-	--input-spec /workspace/codegen/apis/_build/2024-07/control_2024-07.oas.yaml \
+	--input-spec /workspace/codegen/apis/_build/$version/control_$version.oas.yaml \
 	--generator-name rust \
 	--output /workspace/$outdir \
 	--additional-properties "packageVersion=0.0.1"

codegen/build-proto.sh

@@ -1,14 +1,21 @@
 #!/bin/bash
 
+version=$1
+
 SCRIPT_DIR=$(dirname "$(realpath "$0")")
 outdir="protos"
 
+if [ -z "$version" ]; then
+	echo "Version is required"
+	exit 1
+fi
+
 OUT_DIR=$SCRIPT_DIR/../$outdir
 
 pushd $SCRIPT_DIR/apis
 	just build
 popd
 
 pushd $SCRIPT_DIR/proto_build
-	cargo run -- $OUT_DIR
+	cargo run -- $OUT_DIR $version
 popd

codegen/proto_build/src/main.rs

@@ -5,14 +5,18 @@ fn main() -> Result<(), Box<dyn Error>> {
     let args: Vec<String> = std::env::args().collect();
 
     let out_dir: &str;
-    if args.len() > 1 {
+    let version: &str;
+    if args.len() == 3 {
         out_dir = &args[1];
+        version = &args[2];
         println!("OUT_DIR: {:?}", out_dir);
+        println!("version: {:?}", version);
     } else {
-        return Err("missing out_dir argument".into());
+        return Err("Required 2 arguments: out_dir, version".into());
     }
 
-    let proto_path: &Path = "../apis/_build/2024-07/data_2024-07.proto".as_ref();
+    let proto_path = format!("../apis/_build/{version}/data_{version}.proto");
+    let proto_path: &Path = proto_path.as_ref();
 
     // directory the main .proto file resides in
     let proto_dir = proto_path

justfile

@@ -1,6 +1,22 @@
-build-openapi:
-  ./codegen/build-oas.sh
-  cargo build -p openapi
+api_version := "2024-07"
 
-build-proto:
-  ./codegen/build-proto.sh
+# Generate version file
+generate-version:
+  echo "/// Pinecone API version\npub const API_VERSION: &str = \"{{api_version}}\";" > pinecone_sdk/src/version.rs
+
+# Build the OpenAPI and Protobuf definitions in `codegen/apis`
+build-apis:
+  cd codegen/apis && just build
+
+# Generate the control plane OpenAPI code based on the yaml files in `codegen/apis/_build`
+build-openapi: build-apis generate-version
+  ./codegen/build-oas.sh {{api_version}}
+
+# Generate the data plane protobuf code based on the yaml files in `codegen/apis/_build`
+build-proto: build-apis generate-version
+  ./codegen/build-proto.sh {{api_version}}
+
+# Generate all OpenAPI and protobuf code
+build-client: build-apis generate-version
+  ./codegen/build-oas.sh {{api_version}}
+  ./codegen/build-proto.sh {{api_version}}

pinecone_sdk/src/lib.rs

@@ -6,11 +6,11 @@
 
 #![warn(missing_docs)]
 
-/// Defines configurations for the Pinecone SDK.
-pub mod config;
-
 /// Defines the main entrypoint of the Pinecone SDK.
 pub mod pinecone;
 
 /// Utility modules.
 pub mod utils;
+
+/// Version information.
+pub mod version;

pinecone_sdk/src/pinecone/control.rs

@@ -91,7 +91,7 @@ impl PineconeClient {
         };
 
         // make openAPI call
-        let res = manage_indexes_api::create_index(&self.openapi_config(), create_index_request)
+        let res = manage_indexes_api::create_index(&self.openapi_config, create_index_request)
             .await
             .map_err(|e| PineconeError::from(e))?;
 
@@ -191,7 +191,7 @@ impl PineconeClient {
         };
 
         // make openAPI call
-        let res = manage_indexes_api::create_index(&self.openapi_config(), create_index_request)
+        let res = manage_indexes_api::create_index(&self.openapi_config, create_index_request)
             .await
             .map_err(|e| PineconeError::from(e))?;
 
@@ -244,7 +244,7 @@ impl PineconeClient {
 
     // Gets ready status of an index
     async fn is_ready(&self, name: &str) -> bool {
-        let res = manage_indexes_api::describe_index(&self.openapi_config(), name).await;
+        let res = manage_indexes_api::describe_index(&self.openapi_config, name).await;
         match res {
             Ok(index) => index.status.ready,
             Err(_) => false,
@@ -275,7 +275,7 @@ impl PineconeClient {
     /// ```
     pub async fn describe_index(&self, name: &str) -> Result<IndexModel, PineconeError> {
         // make openAPI call
-        let res = manage_indexes_api::describe_index(&self.openapi_config(), name)
+        let res = manage_indexes_api::describe_index(&self.openapi_config, name)
             .await
             .map_err(|e| PineconeError::from(e))?;
 
@@ -306,7 +306,7 @@ impl PineconeClient {
     /// ```
     pub async fn list_indexes(&self) -> Result<IndexList, PineconeError> {
         // make openAPI call
-        let res = manage_indexes_api::list_indexes(&self.openapi_config())
+        let res = manage_indexes_api::list_indexes(&self.openapi_config)
             .await
             .map_err(|e| PineconeError::from(e))?;
 
@@ -356,7 +356,7 @@ impl PineconeClient {
 
         // make openAPI call
         let res = manage_indexes_api::configure_index(
-            &self.openapi_config(),
+            &self.openapi_config,
             name,
             configure_index_request,
         )
@@ -390,7 +390,7 @@ impl PineconeClient {
     /// ```
     pub async fn delete_index(&self, name: &str) -> Result<(), PineconeError> {
         // make openAPI call
-        let res = manage_indexes_api::delete_index(&self.openapi_config(), name)
+        let res = manage_indexes_api::delete_index(&self.openapi_config, name)
             .await
             .map_err(|e| PineconeError::from(e))?;
 
@@ -431,12 +431,10 @@ impl PineconeClient {
         };
 
         // make openAPI call
-        let res = manage_indexes_api::create_collection(
-            &self.openapi_config(),
-            create_collection_request,
-        )
-        .await
-        .map_err(|e| PineconeError::from(e))?;
+        let res =
+            manage_indexes_api::create_collection(&self.openapi_config, create_collection_request)
+                .await
+                .map_err(|e| PineconeError::from(e))?;
 
         Ok(res)
     }
@@ -464,7 +462,7 @@ impl PineconeClient {
     /// # }
     /// ```
     pub async fn describe_collection(&self, name: &str) -> Result<CollectionModel, PineconeError> {
-        let res = manage_indexes_api::describe_collection(&self.openapi_config(), name)
+        let res = manage_indexes_api::describe_collection(&self.openapi_config, name)
             .await
             .map_err(|e| PineconeError::from(e))?;
 
@@ -494,7 +492,7 @@ impl PineconeClient {
     /// ```
     pub async fn list_collections(&self) -> Result<CollectionList, PineconeError> {
         // make openAPI call
-        let res = manage_indexes_api::list_collections(&self.openapi_config())
+        let res = manage_indexes_api::list_collections(&self.openapi_config)
             .await
             .map_err(|e| PineconeError::from(e))?;
 
@@ -525,7 +523,7 @@ impl PineconeClient {
     /// ```
     pub async fn delete_collection(&self, name: &str) -> Result<(), PineconeError> {
         // make openAPI call
-        let res = manage_indexes_api::delete_collection(&self.openapi_config(), name)
+        let res = manage_indexes_api::delete_collection(&self.openapi_config, name)
             .await
             .map_err(|e| PineconeError::from(e))?;
 

pinecone_sdk/src/utils/user_agent.rs

@@ -1,4 +1,3 @@
-use crate::config::Config;
 use regex::Regex;
 
 /// Normalizes the source tag.
@@ -20,10 +19,13 @@ fn build_source_tag(source_tag: &String) -> String {
 }
 
 /// Gets the user-agent string.
-pub fn get_user_agent(config: &Config) -> String {
+pub fn get_user_agent(source_tag: Option<&str>) -> String {
     let mut user_agent = format!("lang=rust; pinecone-rust-client={}", "0.1.0");
-    if let Some(source_tag) = &config.source_tag {
-        user_agent.push_str(&format!("; source_tag={}", build_source_tag(source_tag)));
+    if let Some(st) = source_tag {
+        user_agent.push_str(&format!(
+            "; source_tag={}",
+            build_source_tag(&st.to_string())
+        ));
     }
     return user_agent;
 }
@@ -47,18 +49,16 @@ mod tests {
 
     #[tokio::test]
     async fn test_no_source_tag() {
-        let config = Config::new("api".to_string(), None);
         assert_eq!(
-            get_user_agent(&config),
+            get_user_agent(None),
             "lang=rust; pinecone-rust-client=0.1.0"
         );
     }
 
     #[tokio::test]
     async fn test_with_source_tag() {
-        let config = Config::new("api".to_string(), Some("Tag".to_string()));
         assert_eq!(
-            get_user_agent(&config),
+            get_user_agent(Some("tag")),
             "lang=rust; pinecone-rust-client=0.1.0; source_tag=tag"
         );
     }

pinecone_sdk/src/version.rs

@@ -0,0 +1,2 @@
+/// Pinecone API version
+pub const API_VERSION: &str = "2024-07";

pinecone_sdk/tests/integration_test.rs

@@ -5,7 +5,7 @@ use pinecone_sdk::pinecone::data::{Kind, Metadata, Namespace, SparseValues, Valu
 use pinecone_sdk::pinecone::PineconeClient;
 use pinecone_sdk::utils::errors::PineconeError;
 use rand::Rng;
-use std::collections::BTreeMap;
+use std::collections::{BTreeMap, HashMap};
 use std::time::Duration;
 use std::vec;
 
@@ -435,7 +435,7 @@ async fn test_list_collections() -> Result<(), PineconeError> {
 }
 
 #[tokio::test]
-async fn test_delete_collection_err() -> Result<(), PineconeError> {
+async fn test_delete_collection_invalid_collection() -> Result<(), PineconeError> {
     let pinecone =
         PineconeClient::new(None, None, None, None).expect("Failed to create Pinecone instance");
 
@@ -447,6 +447,27 @@ async fn test_delete_collection_err() -> Result<(), PineconeError> {
     Ok(())
 }
 
+#[tokio::test]
+async fn test_list_collections_invalid_api_version() -> Result<(), PineconeError> {
+    let headers: HashMap<String, String> = [(
+        pinecone_sdk::pinecone::PINECONE_API_VERSION_KEY.to_string(),
+        "invalid".to_string(),
+    )]
+    .iter()
+    .cloned()
+    .collect();
+
+    let pinecone = PineconeClient::new(None, None, Some(headers), None)
+        .expect("Failed to create Pinecone instance");
+
+    let _ = pinecone
+        .list_collections()
+        .await
+        .expect_err("Expected to fail listing collections due to invalid api version");
+
+    Ok(())
+}
+
 #[tokio::test]
 async fn test_index() -> Result<(), PineconeError> {
     let pinecone = PineconeClient::new(None, None, None, None).unwrap();
@@ -982,10 +1003,7 @@ async fn test_fetch_vectors() -> Result<(), PineconeError> {
     std::thread::sleep(std::time::Duration::from_secs(5));
 
     let fetch_response = index
-        .fetch(
-            &["1", "2"],
-            namespace,
-        )
+        .fetch(&["1", "2"], namespace)
         .await
         .expect("Failed to fetch vectors");