Add api version in ClientOptions and policy inside generated client (#…

…2561) * remove-api-version-from-options-and-add-policy-inside-client * generate api version in client side * to not use delete * fix ci error * fix autorest ci * fix ci * api version support * fix ci * fix ci * fix autorest codegen ci * add use options for documentation * resolve comments * fix ci * merge main * fix docs * fix ci * fix ci error * fix ci * fix unit test --------- Co-authored-by: Jiao Di (MSFT) <[email protected]>
Azure · Jun 26, 2024 · b0853b2 · b0853b2
1 parent 773418d
commit b0853b2
Show file tree

Hide file tree

Showing 253 changed files with 1,847 additions and 962 deletions.
diff --git a/packages/autorest.typescript/src/restLevelClient/transforms/transform.ts b/packages/autorest.typescript/src/restLevelClient/transforms/transform.ts
@@ -73,7 +73,12 @@ function transformApiVersion(
   const queryVersionDetail = getOperationQueryApiVersion(model);
   const pathVersionDetail = extractPathApiVersion(urlInfo);
   const isCrossedVersion =
-    pathVersionDetail?.isCrossedVersion || queryVersionDetail?.isCrossedVersion;
+    queryVersionDetail || pathVersionDetail
+      ? Boolean(
+          pathVersionDetail?.isCrossedVersion ||
+            queryVersionDetail?.isCrossedVersion
+        )
+      : undefined;
   let defaultValue =
     pathVersionDetail?.defaultValue ?? queryVersionDetail?.defaultValue;
 
@@ -88,7 +93,8 @@ function transformApiVersion(
       pathVersionDetail
     ),
     isCrossedVersion,
-    defaultValue
+    defaultValue,
+    required: pathVersionDetail?.required ?? queryVersionDetail?.required
   };
 }
 
@@ -112,9 +118,10 @@ function getOperationQueryApiVersion(
 
   if (apiVersionParam && isConstantSchema(apiVersionParam.schema)) {
     return {
-      definedPosition: "path",
+      definedPosition: "query",
       isCrossedVersion: false,
-      defaultValue: apiVersionParam.schema.value.value.toString()
+      defaultValue: apiVersionParam.schema.value.value.toString(),
+      required: apiVersionParam.required
     };
   }
 

diff --git a/...est.typescript/test/rlcIntegration/generated/bodyComplexRest/src/bodyComplexRestClient.ts b/...est.typescript/test/rlcIntegration/generated/bodyComplexRest/src/bodyComplexRestClient.ts
@@ -5,13 +5,20 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { BodyComplexRestClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface BodyComplexRestClientOptions extends ClientOptions {
+  /** The api version option of the client */
+  apiVersion?: string;
+}
+
 /**
  * Initialize a new instance of `BodyComplexRestClient`
  * @param options - the parameter for all optional parameters
  */
-export default function createClient(
-  options: ClientOptions = {},
-): BodyComplexRestClient {
+export default function createClient({
+  apiVersion = "2016-02-29",
+  ...options
+}: BodyComplexRestClientOptions = {}): BodyComplexRestClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://localhost:3000`;
   const userAgentInfo = `azsdk-js-body-complex-rest/1.0.0-preview1`;
@@ -28,15 +35,23 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(endpointUrl, options) as BodyComplexRestClient;
 
   client.pipeline.removePolicy({ name: "ApiVersionPolicy" });
-  if (options.apiVersion) {
-    logger.warning(
-      "This client does not support client api-version, please change it at the operation level",
-    );
-  }
+  client.pipeline.addPolicy({
+    name: "ClientApiVersionPolicy",
+    sendRequest: (req, next) => {
+      // Use the apiVersion defined in request url directly
+      // Append one if there is no apiVersion and we have one at client options
+      const url = new URL(req.url);
+      if (!url.searchParams.get("api-version") && apiVersion) {
+        req.url = `${req.url}${
+          Array.from(url.searchParams.keys()).length > 0 ? "&" : "?"
+        }api-version=${apiVersion}`;
+      }
 
+      return next(req);
+    },
+  });
   return client;
 }
diff --git a/packages/autorest.typescript/test/rlcIntegration/generated/bodyFileRest/src/bodyFile.ts b/packages/autorest.typescript/test/rlcIntegration/generated/bodyFileRest/src/bodyFile.ts
@@ -5,12 +5,15 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { BodyFileClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface BodyFileClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `BodyFileClient`
  * @param options - the parameter for all optional parameters
  */
 export default function createClient(
-  options: ClientOptions = {},
+  options: BodyFileClientOptions = {},
 ): BodyFileClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://localhost:3000`;
@@ -28,7 +31,6 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(endpointUrl, options) as BodyFileClient;
 
   client.pipeline.removePolicy({ name: "ApiVersionPolicy" });

diff --git a/...es/autorest.typescript/test/rlcIntegration/generated/bodyFormDataRest/src/bodyFormData.ts b/...es/autorest.typescript/test/rlcIntegration/generated/bodyFormDataRest/src/bodyFormData.ts
@@ -5,12 +5,15 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { BodyFormDataClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface BodyFormDataClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `BodyFormDataClient`
  * @param options - the parameter for all optional parameters
  */
 export default function createClient(
-  options: ClientOptions = {},
+  options: BodyFormDataClientOptions = {},
 ): BodyFormDataClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://localhost:3000`;
@@ -28,7 +31,6 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(endpointUrl, options) as BodyFormDataClient;
 
   client.pipeline.removePolicy({ name: "ApiVersionPolicy" });

diff --git a/...es/autorest.typescript/test/rlcIntegration/generated/bodyStringRest/src/bodyStringRest.ts b/...es/autorest.typescript/test/rlcIntegration/generated/bodyStringRest/src/bodyStringRest.ts
@@ -5,12 +5,15 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { BodyStringRestClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface BodyStringRestClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `BodyStringRestClient`
  * @param options - the parameter for all optional parameters
  */
 export default function createClient(
-  options: ClientOptions = {},
+  options: BodyStringRestClientOptions = {},
 ): BodyStringRestClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://localhost:3000`;
@@ -28,7 +31,6 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(endpointUrl, options) as BodyStringRestClient;
 
   client.pipeline.removePolicy({ name: "ApiVersionPolicy" });

diff --git a/...utorest.typescript/test/rlcIntegration/generated/customUrlRest/src/customUrlRestClient.ts b/...utorest.typescript/test/rlcIntegration/generated/customUrlRest/src/customUrlRestClient.ts
@@ -5,14 +5,17 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { CustomUrlRestClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface CustomUrlRestClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `CustomUrlRestClient`
  * @param host - A string value that is used as a global part of the parameterized host
  * @param options - the parameter for all optional parameters
  */
 export default function createClient(
   host: string,
-  options: ClientOptions = {},
+  options: CustomUrlRestClientOptions = {},
 ): CustomUrlRestClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://{accountName}${host}`;
@@ -30,7 +33,6 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(endpointUrl, options) as CustomUrlRestClient;
 
   client.pipeline.removePolicy({ name: "ApiVersionPolicy" });

diff --git a/...t.typescript/test/rlcIntegration/generated/dpgCustomization/src/dPGCustomizationClient.ts b/...t.typescript/test/rlcIntegration/generated/dpgCustomization/src/dPGCustomizationClient.ts
@@ -5,12 +5,15 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { DPGCustomizationClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface DPGCustomizationClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `DPGCustomizationClient`
  * @param options - the parameter for all optional parameters
  */
 export default function createClient(
-  options: ClientOptions = {},
+  options: DPGCustomizationClientOptions = {},
 ): DPGCustomizationClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://localhost:3000`;
@@ -28,7 +31,6 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(endpointUrl, options) as DPGCustomizationClient;
 
   client.pipeline.removePolicy({ name: "ApiVersionPolicy" });

diff --git a/...ages/autorest.typescript/test/rlcIntegration/generated/headerRest/src/headerRestClient.ts b/...ages/autorest.typescript/test/rlcIntegration/generated/headerRest/src/headerRestClient.ts
@@ -5,12 +5,15 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { HeaderRestClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface HeaderRestClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `HeaderRestClient`
  * @param options - the parameter for all optional parameters
  */
 export default function createClient(
-  options: ClientOptions = {},
+  options: HeaderRestClientOptions = {},
 ): HeaderRestClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://localhost:3000`;
@@ -28,7 +31,6 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(endpointUrl, options) as HeaderRestClient;
 
   client.pipeline.removePolicy({ name: "ApiVersionPolicy" });

diff --git a/.../test/rlcIntegration/generated/httpInfrastructureRest/src/httpInfrastructureRestClient.ts b/.../test/rlcIntegration/generated/httpInfrastructureRest/src/httpInfrastructureRestClient.ts
@@ -5,12 +5,15 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { HttpInfrastructureRestClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface HttpInfrastructureRestClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `HttpInfrastructureRestClient`
  * @param options - the parameter for all optional parameters
  */
 export default function createClient(
-  options: ClientOptions = {},
+  options: HttpInfrastructureRestClientOptions = {},
 ): HttpInfrastructureRestClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://localhost:3000`;
@@ -28,7 +31,6 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(
     endpointUrl,
     options,

diff --git a/packages/autorest.typescript/test/rlcIntegration/generated/lroRest/src/lRORestClient.ts b/packages/autorest.typescript/test/rlcIntegration/generated/lroRest/src/lRORestClient.ts
@@ -5,12 +5,15 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { LRORestClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface LRORestClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `LRORestClient`
  * @param options - the parameter for all optional parameters
  */
 export default function createClient(
-  options: ClientOptions = {},
+  options: LRORestClientOptions = {},
 ): LRORestClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://localhost:3000`;
@@ -28,7 +31,6 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(endpointUrl, options) as LRORestClient;
 
   client.pipeline.removePolicy({ name: "ApiVersionPolicy" });

diff --git a/packages/autorest.typescript/test/rlcIntegration/generated/mediaTypesRest/src/mediaTypes.ts b/packages/autorest.typescript/test/rlcIntegration/generated/mediaTypesRest/src/mediaTypes.ts
@@ -5,12 +5,15 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { MediaTypesClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface MediaTypesClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `MediaTypesClient`
  * @param options - the parameter for all optional parameters
  */
 export default function createClient(
-  options: ClientOptions = {},
+  options: MediaTypesClientOptions = {},
 ): MediaTypesClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://localhost:3000`;
@@ -28,7 +31,6 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(endpointUrl, options) as MediaTypesClient;
 
   client.pipeline.removePolicy({ name: "ApiVersionPolicy" });

diff --git a/...est/rlcIntegration/generated/multipleInheritanceRest/src/multipleInheritanceRestClient.ts b/...est/rlcIntegration/generated/multipleInheritanceRest/src/multipleInheritanceRestClient.ts
@@ -5,12 +5,15 @@ import { getClient, ClientOptions } from "@azure-rest/core-client";
 import { logger } from "./logger";
 import { MultipleInheritanceRestClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface MultipleInheritanceRestClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `MultipleInheritanceRestClient`
  * @param options - the parameter for all optional parameters
  */
 export default function createClient(
-  options: ClientOptions = {},
+  options: MultipleInheritanceRestClientOptions = {},
 ): MultipleInheritanceRestClient {
   const endpointUrl =
     options.endpoint ?? options.baseUrl ?? `http://localhost:3000`;
@@ -28,7 +31,6 @@ export default function createClient(
       logger: options.loggingOptions?.logger ?? logger.info,
     },
   };
-
   const client = getClient(
     endpointUrl,
     options,

diff --git a/...test/rlcIntegration/generated/multipleUrlParameters/src/multipleUrlParameterRestClient.ts b/...test/rlcIntegration/generated/multipleUrlParameters/src/multipleUrlParameterRestClient.ts
@@ -6,6 +6,9 @@ import { logger } from "./logger";
 import { TokenCredential } from "@azure/core-auth";
 import { MultipleUrlParameterRestClient } from "./clientDefinitions";
 
+/** The optional parameters for the client */
+export interface MultipleUrlParameterRestClientOptions extends ClientOptions {}
+
 /**
  * Initialize a new instance of `MultipleUrlParameterRestClient`
  * @param endpoint - The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com
@@ -17,13 +20,12 @@ export default function createClient(
   endpoint: string,
   serviceVersion: "v2" | "v1",
   credentials: TokenCredential,
-  options: ClientOptions = {},
+  options: MultipleUrlParameterRestClientOptions = {},
 ): MultipleUrlParameterRestClient {
   const endpointUrl =
     options.endpoint ??
     options.baseUrl ??
     `${endpoint}/catalog/api/atlas/${serviceVersion}/{accountName}`;
-
   const userAgentInfo = `azsdk-js-multiple-url-parameter-rest/1.0.0-preview1`;
   const userAgentPrefix =
     options.userAgentOptions && options.userAgentOptions.userAgentPrefix
@@ -41,7 +43,6 @@ export default function createClient(
       scopes: options.credentials?.scopes ?? ["user_impersonation"],
     },
   };
-
   const client = getClient(
     endpointUrl,
     credentials,