@typespec/http-client-python 0.23.1 → 0.24.1

package/emitter/src/http.ts

@@ -60,10 +60,18 @@ export function emitBasicHttpMethod(
   rootClient: SdkClientType<SdkHttpOperation>,
   method: SdkBasicServiceMethod<SdkHttpOperation>,
   operationGroupName: string,
+  serviceApiVersions: string[],
 ): Record<string, any>[] {
   return [
     {
-      ...emitHttpOperation(context, rootClient, operationGroupName, method.operation, method),
+      ...emitHttpOperation(
+        context,
+        rootClient,
+        operationGroupName,
+        method.operation,
+        method,
+        serviceApiVersions,
+      ),
       abstract: isAbstract(method),
       name: camelToSnakeCase(method.name),
       description: method.doc ?? "",
@@ -77,9 +85,17 @@ function emitInitialLroHttpMethod(
   rootClient: SdkClientType<SdkHttpOperation>,
   method: SdkLroServiceMethod<SdkHttpOperation> | SdkLroPagingServiceMethod<SdkHttpOperation>,
   operationGroupName: string,
+  serviceApiVersions: string[],
 ): Record<string, any> {
   return {
-    ...emitHttpOperation(context, rootClient, operationGroupName, method.operation, method),
+    ...emitHttpOperation(
+      context,
+      rootClient,
+      operationGroupName,
+      method.operation,
+      method,
+      serviceApiVersions,
+    ),
     name: `_${camelToSnakeCase(method.name)}_initial`,
     isLroInitialOperation: true,
     wantTracing: false,
@@ -94,12 +110,26 @@ function addLroInformation(
   rootClient: SdkClientType<SdkHttpOperation>,
   method: SdkLroServiceMethod<SdkHttpOperation> | SdkLroPagingServiceMethod<SdkHttpOperation>,
   operationGroupName: string,
+  serviceApiVersions: string[],
 ) {
   return {
-    ...emitHttpOperation(context, rootClient, operationGroupName, method.operation, method),
+    ...emitHttpOperation(
+      context,
+      rootClient,
+      operationGroupName,
+      method.operation,
+      method,
+      serviceApiVersions,
+    ),
     name: camelToSnakeCase(method.name),
     discriminator: "lro",
-    initialOperation: emitInitialLroHttpMethod(context, rootClient, method, operationGroupName),
+    initialOperation: emitInitialLroHttpMethod(
+      context,
+      rootClient,
+      method,
+      operationGroupName,
+      serviceApiVersions,
+    ),
     exposeStreamKeyword: false,
     description: method.doc ?? "",
     summary: method.summary,
@@ -195,6 +225,7 @@ function addPagingInformation(
   rootClient: SdkClientType<SdkHttpOperation>,
   method: SdkPagingServiceMethod<SdkHttpOperation> | SdkLroPagingServiceMethod<SdkHttpOperation>,
   operationGroupName: string,
+  serviceApiVersions: string[],
 ) {
   for (const response of method.operation.responses) {
     if (response.type) {
@@ -206,7 +237,14 @@ function addPagingInformation(
     }
   }
   const itemType = getType(context, method.response.type!);
-  const base = emitHttpOperation(context, rootClient, operationGroupName, method.operation, method);
+  const base = emitHttpOperation(
+    context,
+    rootClient,
+    operationGroupName,
+    method.operation,
+    method,
+    serviceApiVersions,
+  );
   const itemName = getWireNameWithDiagnostics(
     context,
     method.response.resultSegments,
@@ -228,7 +266,9 @@ function addPagingInformation(
       if (param.kind === "method") {
         for (const parameter of method.operation.parameters) {
           if (parameter.kind === "query" && parameter.correspondingMethodParams.includes(param)) {
-            nextLinkReInjectedParameters.push(emitHttpQueryParameter(context, parameter, method));
+            nextLinkReInjectedParameters.push(
+              emitHttpQueryParameter(context, rootClient, parameter, method, serviceApiVersions),
+            );
           }
         }
       }
@@ -257,8 +297,15 @@ export function emitLroHttpMethod(
   rootClient: SdkClientType<SdkHttpOperation>,
   method: SdkLroServiceMethod<SdkHttpOperation>,
   operationGroupName: string,
+  serviceApiVersions: string[],
 ): Record<string, any>[] {
-  const lroMethod = addLroInformation(context, rootClient, method, operationGroupName);
+  const lroMethod = addLroInformation(
+    context,
+    rootClient,
+    method,
+    operationGroupName,
+    serviceApiVersions,
+  );
   return [lroMethod.initialOperation, lroMethod];
 }
 
@@ -267,8 +314,15 @@ export function emitPagingHttpMethod(
   rootClient: SdkClientType<SdkHttpOperation>,
   method: SdkPagingServiceMethod<SdkHttpOperation>,
   operationGroupName: string,
+  serviceApiVersions: string[],
 ): Record<string, any>[] {
-  const pagingMethod = addPagingInformation(context, rootClient, method, operationGroupName);
+  const pagingMethod = addPagingInformation(
+    context,
+    rootClient,
+    method,
+    operationGroupName,
+    serviceApiVersions,
+  );
   return [pagingMethod];
 }
 
@@ -277,10 +331,27 @@ export function emitLroPagingHttpMethod(
   rootClient: SdkClientType<SdkHttpOperation>,
   method: SdkLroPagingServiceMethod<SdkHttpOperation>,
   operationGroupName: string,
+  serviceApiVersions: string[],
 ): Record<string, any>[] {
-  const pagingMethod = addPagingInformation(context, rootClient, method, operationGroupName);
-  const lroMethod = addLroInformation(context, rootClient, method, operationGroupName);
-  return [lroMethod.initialOperation, pagingMethod, lroMethod];
+  const pagingMethod = addPagingInformation(
+    context,
+    rootClient,
+    method,
+    operationGroupName,
+    serviceApiVersions,
+  );
+  const lroMethod = addLroInformation(
+    context,
+    rootClient,
+    method,
+    operationGroupName,
+    serviceApiVersions,
+  );
+
+  // merge paging method and lro method into lropaging method
+  const lroPagingMethod = { ...lroMethod, ...pagingMethod, discriminator: "lropaging" };
+
+  return [lroMethod.initialOperation, lroPagingMethod];
 }
 
 function emitHttpOperation(
@@ -289,6 +360,7 @@ function emitHttpOperation(
   operationGroupName: string,
   operation: SdkHttpOperation,
   method: SdkServiceMethod<SdkHttpOperation>,
+  serviceApiVersions: string[],
 ): Record<string, any> {
   const responses: Record<string, any>[] = [];
   const exceptions: Record<string, any>[] = [];
@@ -301,12 +373,12 @@ function emitHttpOperation(
   const result = {
     url: operation.path,
     method: operation.verb.toUpperCase(),
-    parameters: emitHttpParameters(context, rootClient, operation, method),
-    bodyParameter: emitHttpBodyParameter(context, operation.bodyParam),
+    parameters: emitHttpParameters(context, rootClient, operation, method, serviceApiVersions),
+    bodyParameter: emitHttpBodyParameter(context, operation.bodyParam, serviceApiVersions),
     responses,
     exceptions,
     groupName: operationGroupName,
-    addedOn: method ? getAddedOn(context, method) : "",
+    addedOn: method ? getAddedOn(context, method, serviceApiVersions) : "",
     discriminator: "basic",
     isOverload: false,
     overloads: [],
@@ -373,8 +445,9 @@ function emitHttpPathParameter(
   context: PythonSdkContext,
   parameter: SdkPathParameter,
   operation: SdkHttpOperation,
+  serviceApiVersions: string[],
 ): Record<string, any> {
-  const base = emitParamBase(context, parameter);
+  const base = emitParamBase(context, parameter, undefined, serviceApiVersions);
   if (parameter.optional && operation.path.includes(`/{${parameter.serializedName}}`)) {
     operation.path = operation.path.replace(
       `/{${parameter.serializedName}}`,
@@ -390,12 +463,14 @@ function emitHttpPathParameter(
     skipUrlEncoding: parameter.allowReserved,
   };
 }
+
 function emitHttpHeaderParameter(
   context: PythonSdkContext,
   parameter: SdkHeaderParameter,
   method: SdkServiceMethod<SdkHttpOperation>,
+  serviceApiVersions: string[],
 ): Record<string, any> {
-  const base = emitParamBase(context, parameter, method);
+  const base = emitParamBase(context, parameter, method, serviceApiVersions);
   const [delimiter, explode] = getDelimiterAndExplode(parameter);
   let clientDefaultValue = parameter.clientDefaultValue;
   if (isContentTypeParameter(parameter)) {
@@ -418,16 +493,22 @@ function emitHttpHeaderParameter(
 
 function emitHttpQueryParameter(
   context: PythonSdkContext,
+  rootClient: SdkClientType<SdkHttpOperation>,
   parameter: SdkQueryParameter,
   method: SdkServiceMethod<SdkHttpOperation>,
+  serviceApiVersions: string[],
 ): Record<string, any> {
-  const base = emitParamBase(context, parameter, method);
+  const base = emitParamBase(context, parameter, method, serviceApiVersions);
   const [delimiter, explode] = getDelimiterAndExplode(parameter);
   return {
     ...base,
     wireName: parameter.serializedName,
     location: parameter.kind,
-    implementation: getImplementation(context, parameter),
+    implementation: parameter.isApiVersionParam
+      ? rootClient.apiVersions.length > 0 && parameter.onClient
+        ? "Client"
+        : "Method"
+      : getImplementation(context, parameter),
     delimiter,
     explode,
     clientDefaultValue: parameter.clientDefaultValue,
@@ -439,6 +520,7 @@ function emitHttpParameters(
   rootClient: SdkClientType<SdkHttpOperation>,
   operation: SdkHttpOperation,
   method: SdkServiceMethod<SdkHttpOperation>,
+  serviceApiVersions: string[],
 ): Record<string, any>[] {
   const parameters: Record<string, any>[] = [...context.__endpointPathParameters];
 
@@ -478,13 +560,15 @@ function emitHttpParameters(
   for (const parameter of httpParameters) {
     switch (parameter.kind) {
       case "header":
-        parameters.push(emitHttpHeaderParameter(context, parameter, method));
+        parameters.push(emitHttpHeaderParameter(context, parameter, method, serviceApiVersions));
         break;
       case "query":
-        parameters.push(emitHttpQueryParameter(context, parameter, method));
+        parameters.push(
+          emitHttpQueryParameter(context, rootClient, parameter, method, serviceApiVersions),
+        );
         break;
       case "path":
-        parameters.push(emitHttpPathParameter(context, parameter, operation));
+        parameters.push(emitHttpPathParameter(context, parameter, operation, serviceApiVersions));
         break;
     }
   }
@@ -495,10 +579,11 @@ function emitHttpParameters(
 function emitHttpBodyParameter(
   context: PythonSdkContext,
   bodyParam?: SdkBodyParameter,
+  serviceApiVersions: string[] = [],
 ): Record<string, any> | undefined {
   if (bodyParam === undefined) return undefined;
   return {
-    ...emitParamBase(context, bodyParam),
+    ...emitParamBase(context, bodyParam, undefined, serviceApiVersions),
     contentTypes: bodyParam.contentTypes,
     location: bodyParam.kind,
     clientName: bodyParam.isGeneratedName ? "body" : camelToSnakeCase(bodyParam.name),

package/emitter/src/types.ts

@@ -514,10 +514,11 @@ export const KnownTypes = {
 export function emitEndpointType(
   context: PythonSdkContext,
   type: SdkEndpointType,
+  serviceApiVersions: string[],
 ): Record<string, any>[] {
   const params: Record<string, any>[] = [];
   for (const param of type.templateArguments) {
-    const paramBase = emitParamBase(context, param);
+    const paramBase = emitParamBase(context, param, undefined, serviceApiVersions);
     paramBase.clientName = context.arm ? "base_url" : paramBase.clientName;
     params.push({
       ...paramBase,

package/emitter/src/utils.ts

@@ -162,16 +162,17 @@ export function getAddedOn<TServiceOperation extends SdkServiceOperation>(
     | SdkMethodParameter
     | SdkHttpParameter
     | SdkMethod<TServiceOperation>,
+  serviceApiVersions: string[] = [],
 ): string | undefined {
-  // since we do not support multi-service for now, we can just check the root client's api version
   // if type is added in the first version of the client, we do not need to add the versioning info
-  if (
-    type.apiVersions[0] ===
-    context.sdkPackage.clients.find(
-      (c) => c.clientInitialization.initializedBy | InitializedByFlags.Individually,
-    )?.apiVersions[0]
-  )
-    return undefined;
+  const apiVersions =
+    serviceApiVersions.length > 0
+      ? serviceApiVersions
+      : (context.sdkPackage.clients.find(
+          (c) => c.clientInitialization.initializedBy | InitializedByFlags.Individually,
+        )?.apiVersions ?? []);
+
+  if (type.apiVersions[0] === apiVersions[0]) return undefined;
   return type.apiVersions[0];
 }
 
@@ -207,6 +208,7 @@ export function emitParamBase<TServiceOperation extends SdkServiceOperation>(
   context: PythonSdkContext,
   parameter: SdkEndpointParameter | SdkCredentialParameter | SdkMethodParameter | SdkHttpParameter,
   method?: SdkServiceMethod<TServiceOperation>,
+  serviceApiVersions: string[] = [],
 ): ParamBase {
   let type = getType(context, parameter.type);
   if (parameter.isApiVersionParam) {
@@ -231,7 +233,7 @@ export function emitParamBase<TServiceOperation extends SdkServiceOperation>(
   return {
     optional: parameter.optional,
     description: (parameter.summary ? parameter.summary : parameter.doc) ?? "",
-    addedOn: getAddedOn(context, parameter),
+    addedOn: getAddedOn(context, parameter, serviceApiVersions),
     clientName,
     inOverload: false,
     isApiVersion: parameter.isApiVersionParam,