@azure/search-documents 11.3.0-alpha.20211109.3 → 11.3.0-alpha.20211213.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release History
 
+## 11.3.0-beta.6 (Unreleased)
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
+
+- Deprecated `SearchClientOptions.apiVersion` in favor of `SearchClientOptions.serviceVersion`.
+  - `apiVersion` will continue to be supported in version 11.x; however, customers are encouraged to migrate to `serviceVersion` instead which is more consistent with the rest of our client libraries.
+
 ## 11.3.0-beta.5 (2021-11-09)
 
 ### Features Added

package/dist/index.js

@@ -3243,9 +3243,9 @@ class SearchClient$1 {
         /// Maintenance note: when updating supported API versions,
         /// the ContinuationToken logic will need to be updated below.
         /**
-         * The API version to use when communicating with the service.
+         *  The service version to use when communicating with the service.
          */
-        this.apiVersion = "2020-06-30-Preview";
+        this.serviceVersion = "2020-06-30-Preview";
         this.endpoint = endpoint;
         this.indexName = indexName;
         const libInfo = `azsdk-js-search-documents/${SDK_VERSION}`;
@@ -3271,14 +3271,19 @@ class SearchClient$1 {
                 ]
             }
         });
-        let apiVersion = this.apiVersion;
         if (options.apiVersion) {
             if (!["2020-06-30", "2021-04-30-Preview"].includes(options.apiVersion)) {
                 throw new Error(`Invalid Api Version: ${options.apiVersion}`);
             }
-            apiVersion = options.apiVersion;
+            this.serviceVersion = options.apiVersion;
         }
-        this.client = new SearchClient(this.endpoint, this.indexName, apiVersion, internalClientPipelineOptions);
+        if (options.serviceVersion) {
+            if (!["2020-06-30", "2021-04-30-Preview"].includes(options.serviceVersion)) {
+                throw new Error(`Invalid Service Version: ${options.serviceVersion}`);
+            }
+            this.serviceVersion = options.serviceVersion;
+        }
+        this.client = new SearchClient(this.endpoint, this.indexName, this.serviceVersion, internalClientPipelineOptions);
         if (coreAuth.isTokenCredential(credential)) {
             this.client.pipeline.addPolicy(coreRestPipeline.bearerTokenAuthenticationPolicy({ credential, scopes: DEFAULT_SEARCH_SCOPE }));
         }
@@ -3287,6 +3292,13 @@ class SearchClient$1 {
         }
         this.client.pipeline.addPolicy(createOdataMetadataPolicy("none"));
     }
+    /**
+     * The API version to use when communicating with the service.
+     * @deprecated use {@Link serviceVersion} instead
+     */
+    get apiVersion() {
+        return this.serviceVersion;
+    }
     /**
      * Retrieves the number of documents in the index.
      * @param options - Options to the count operation.