[App Config] Add ApiVersion in the Options Bag (#31648)

### Packages impacted by this PR @azure/app-configuration
Azure · Nov 6, 2024 · 0995dcd · 0995dcd
1 parent 24d7b78
commit 0995dcd
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 12 deletions.
diff --git a/sdk/appconfiguration/app-configuration/CHANGELOG.md b/sdk/appconfiguration/app-configuration/CHANGELOG.md
@@ -1,14 +1,10 @@
 # Release History
 
-## 1.7.1 (Unreleased)
+## 1.8.0 (2024-11-05)
 
 ### Features Added
 
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
+- Add `apiVersion` in `AppConfigurationClientOptions` so that customers can specify the API version instead of using the default.
 
 ## 1.7.0 (2024-08-06)
 

diff --git a/sdk/appconfiguration/app-configuration/package.json b/sdk/appconfiguration/app-configuration/package.json
@@ -2,7 +2,7 @@
   "name": "@azure/app-configuration",
   "author": "Microsoft Corporation",
   "description": "An isomorphic client library for the Azure App Configuration service.",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "sdk-type": "client",
   "keywords": [
     "node",

diff --git a/sdk/appconfiguration/app-configuration/review/app-configuration.api.md b/sdk/appconfiguration/app-configuration/review/app-configuration.api.md
@@ -47,6 +47,7 @@ export class AppConfigurationClient {
 
 // @public
 export interface AppConfigurationClientOptions extends CommonClientOptions {
+    apiVersion?: string;
 }
 
 // @public

diff --git a/sdk/appconfiguration/app-configuration/src/appConfigurationClient.ts b/sdk/appconfiguration/app-configuration/src/appConfigurationClient.ts
@@ -189,7 +189,7 @@ export class AppConfigurationClient {
     this._syncTokens = appConfigOptions.syncTokens || new SyncTokens();
     this.client = new AppConfiguration(
       appConfigEndpoint,
-      appConfigurationApiVersion,
+      options?.apiVersion ?? appConfigurationApiVersion,
       internalClientPipelineOptions,
     );
     this.client.pipeline.addPolicy(authPolicy, { phase: "Sign" });

diff --git a/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts b/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts
diff --git a/sdk/appconfiguration/app-configuration/src/internal/constants.ts b/sdk/appconfiguration/app-configuration/src/internal/constants.ts
@@ -4,7 +4,7 @@
 /**
  * @internal
  */
-export const packageVersion = "1.7.1";
+export const packageVersion = "1.8.0";
 
 /**
  * @internal

diff --git a/sdk/appconfiguration/app-configuration/src/models.ts b/sdk/appconfiguration/app-configuration/src/models.ts
@@ -16,7 +16,13 @@ import type {
 /**
  * Provides configuration options for AppConfigurationClient.
  */
-export interface AppConfigurationClientOptions extends CommonClientOptions {}
+export interface AppConfigurationClientOptions extends CommonClientOptions {
+  /**
+   * The API version to use when interacting with the service. The default value is `2023-11-01`.
+   * Note that overriding this default value may result in unsupported behavior.
+   */
+  apiVersion?: string;
+}
 
 /**
  * Fields that uniquely identify a configuration setting

diff --git a/sdk/appconfiguration/app-configuration/swagger/swagger.md b/sdk/appconfiguration/app-configuration/swagger/swagger.md
@@ -4,7 +4,7 @@
 
 ```yaml
 package-name: app-configuration
-package-version: "1.7.1"
+package-version: "1.8.0"
 title: AppConfiguration
 description: App Configuration client
 enable-xml: true