Improve generated paging methods when next operation is not specified (…

…#1661)
Azure · Nov 29, 2022 · 3a74a90 · 3a74a90
1 parent cd004be
commit 3a74a90
Show file tree

Hide file tree

Showing 366 changed files with 237 additions and 1,933 deletions.
diff --git a/packages/autorest.typescript/src/pagingHelper.ts b/packages/autorest.typescript/src/pagingHelper.ts
@@ -5,11 +5,11 @@ export interface PageInfo {
 const pageMap = new WeakMap<object, PageInfo>();
 
 /**
- * Given a result page from a pageable operation, returns a
- * continuation token that can be used to begin paging from
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
  * that point later.
- * @param page A result object from calling .byPage() on a paged operation.
- * @returns The continuation token that can be passed into byPage().
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
  */
 export function getContinuationToken(page: unknown): string | undefined {
   if (typeof page !== "object" || page === null) {

diff --git a/packages/autorest.typescript/src/transforms/extensions.ts b/packages/autorest.typescript/src/transforms/extensions.ts
@@ -204,9 +204,22 @@ function addPageableMethods(codeModel: CodeModel) {
         }
       );
 
+      // Filter out query parameters from the original operation.
+      if (nextLinkMethod.parameters) {
+        nextLinkMethod.parameters = nextLinkMethod.parameters.filter(
+          param => param.protocol.http?.in !== ParameterLocation.Query
+        );
+        if (nextLinkMethod.signatureParameters) {
+          nextLinkMethod.updateSignatureParameters();
+        }
+      }
+
       // Ensure all overloads support the nextLink parameter.
       for (const request of nextLinkMethod.requests ?? []) {
-        const parameters = request.parameters ?? [];
+        let parameters = request.parameters ?? [];
+        parameters = parameters.filter(param => {
+          return param.protocol.http?.in !== ParameterLocation.Query;
+        });
         parameters.push(nextLinkParameter);
         request.parameters = parameters;
       }

diff --git a/...rest.typescript/test/integration/generated/appconfiguration/src/appConfigurationClient.ts b/...rest.typescript/test/integration/generated/appconfiguration/src/appConfigurationClient.ts
@@ -905,7 +905,6 @@ const getKeysNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [Parameters.name, Parameters.apiVersion, Parameters.after],
   urlParameters: [Parameters.endpoint, Parameters.nextLink],
   headerParameters: [
     Parameters.accept,
@@ -926,13 +925,6 @@ const getKeyValuesNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [
-    Parameters.apiVersion,
-    Parameters.after,
-    Parameters.key,
-    Parameters.label,
-    Parameters.select
-  ],
   urlParameters: [Parameters.endpoint, Parameters.nextLink],
   headerParameters: [
     Parameters.syncToken,
@@ -953,12 +945,6 @@ const getLabelsNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [
-    Parameters.name,
-    Parameters.apiVersion,
-    Parameters.after,
-    Parameters.select4
-  ],
   urlParameters: [Parameters.endpoint, Parameters.nextLink],
   headerParameters: [
     Parameters.syncToken,
@@ -979,13 +965,6 @@ const getRevisionsNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [
-    Parameters.apiVersion,
-    Parameters.after,
-    Parameters.key,
-    Parameters.label,
-    Parameters.select5
-  ],
   urlParameters: [Parameters.endpoint, Parameters.nextLink],
   headerParameters: [
     Parameters.syncToken,

diff --git a/packages/autorest.typescript/test/integration/generated/appconfiguration/src/models/index.ts b/packages/autorest.typescript/test/integration/generated/appconfiguration/src/models/index.ts
@@ -634,10 +634,6 @@ export type CheckRevisionsResponse = AppConfigurationClientCheckRevisionsHeaders
 
 /** Optional parameters. */
 export interface GetKeysNextOptionalParams extends coreClient.OperationOptions {
-  /** A filter for the name of the returned keys. */
-  name?: string;
-  /** Instructs the server to return elements that appear after the element referred to by the specified token. */
-  after?: string;
   /** Requests the server to respond with the state of the resource at the specified time. */
   acceptDatetime?: string;
 }
@@ -649,16 +645,8 @@ export type GetKeysNextResponse = AppConfigurationClientGetKeysNextHeaders &
 /** Optional parameters. */
 export interface GetKeyValuesNextOptionalParams
   extends coreClient.OperationOptions {
-  /** Instructs the server to return elements that appear after the element referred to by the specified token. */
-  after?: string;
   /** Requests the server to respond with the state of the resource at the specified time. */
   acceptDatetime?: string;
-  /** A filter used to match keys. */
-  key?: string;
-  /** A filter used to match labels */
-  label?: string;
-  /** Used to select what fields are present in the returned resource(s). */
-  select?: Get6ItemsItem[];
 }
 
 /** Contains response data for the getKeyValuesNext operation. */
@@ -668,14 +656,8 @@ export type GetKeyValuesNextResponse = AppConfigurationClientGetKeyValuesNextHea
 /** Optional parameters. */
 export interface GetLabelsNextOptionalParams
   extends coreClient.OperationOptions {
-  /** A filter for the name of the returned labels. */
-  name?: string;
-  /** Instructs the server to return elements that appear after the element referred to by the specified token. */
-  after?: string;
   /** Requests the server to respond with the state of the resource at the specified time. */
   acceptDatetime?: string;
-  /** Used to select what fields are present in the returned resource(s). */
-  select?: string[];
 }
 
 /** Contains response data for the getLabelsNext operation. */
@@ -685,16 +667,8 @@ export type GetLabelsNextResponse = AppConfigurationClientGetLabelsNextHeaders &
 /** Optional parameters. */
 export interface GetRevisionsNextOptionalParams
   extends coreClient.OperationOptions {
-  /** Instructs the server to return elements that appear after the element referred to by the specified token. */
-  after?: string;
   /** Requests the server to respond with the state of the resource at the specified time. */
   acceptDatetime?: string;
-  /** A filter used to match keys. */
-  key?: string;
-  /** A filter used to match labels */
-  label?: string;
-  /** Used to select what fields are present in the returned resource(s). */
-  select?: Enum4[];
 }
 
 /** Contains response data for the getRevisionsNext operation. */

diff --git a/packages/autorest.typescript/test/integration/generated/appconfiguration/src/pagingHelper.ts b/packages/autorest.typescript/test/integration/generated/appconfiguration/src/pagingHelper.ts
@@ -13,11 +13,11 @@ export interface PageInfo {
 const pageMap = new WeakMap<object, PageInfo>();
 
 /**
- * Given a result page from a pageable operation, returns a
- * continuation token that can be used to begin paging from
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
  * that point later.
- * @param page A result object from calling .byPage() on a paged operation.
- * @returns The continuation token that can be passed into byPage().
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
  */
 export function getContinuationToken(page: unknown): string | undefined {
   if (typeof page !== "object" || page === null) {

diff --git a/...ypescript/test/integration/generated/appconfigurationexport/src/appConfigurationClient.ts b/...ypescript/test/integration/generated/appconfigurationexport/src/appConfigurationClient.ts
@@ -906,7 +906,6 @@ const getKeysNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [Parameters.name, Parameters.apiVersion, Parameters.after],
   urlParameters: [Parameters.endpoint, Parameters.nextLink],
   headerParameters: [
     Parameters.accept,
@@ -927,13 +926,6 @@ const getKeyValuesNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [
-    Parameters.apiVersion,
-    Parameters.after,
-    Parameters.key,
-    Parameters.label,
-    Parameters.select
-  ],
   urlParameters: [Parameters.endpoint, Parameters.nextLink],
   headerParameters: [
     Parameters.syncToken,
@@ -954,12 +946,6 @@ const getLabelsNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [
-    Parameters.name,
-    Parameters.apiVersion,
-    Parameters.after,
-    Parameters.select4
-  ],
   urlParameters: [Parameters.endpoint, Parameters.nextLink],
   headerParameters: [
     Parameters.syncToken,
@@ -980,13 +966,6 @@ const getRevisionsNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorModel
     }
   },
-  queryParameters: [
-    Parameters.apiVersion,
-    Parameters.after,
-    Parameters.key,
-    Parameters.label,
-    Parameters.select5
-  ],
   urlParameters: [Parameters.endpoint, Parameters.nextLink],
   headerParameters: [
     Parameters.syncToken,

diff --git a/...autorest.typescript/test/integration/generated/appconfigurationexport/src/models/index.ts b/...autorest.typescript/test/integration/generated/appconfigurationexport/src/models/index.ts
@@ -634,10 +634,6 @@ export type CheckRevisionsResponse = AppConfigurationClientCheckRevisionsHeaders
 
 /** Optional parameters. */
 export interface GetKeysNextOptionalParams extends coreClient.OperationOptions {
-  /** A filter for the name of the returned keys. */
-  name?: string;
-  /** Instructs the server to return elements that appear after the element referred to by the specified token. */
-  after?: string;
   /** Requests the server to respond with the state of the resource at the specified time. */
   acceptDatetime?: string;
 }
@@ -649,16 +645,8 @@ export type GetKeysNextResponse = AppConfigurationClientGetKeysNextHeaders &
 /** Optional parameters. */
 export interface GetKeyValuesNextOptionalParams
   extends coreClient.OperationOptions {
-  /** Instructs the server to return elements that appear after the element referred to by the specified token. */
-  after?: string;
   /** Requests the server to respond with the state of the resource at the specified time. */
   acceptDatetime?: string;
-  /** A filter used to match keys. */
-  key?: string;
-  /** A filter used to match labels */
-  label?: string;
-  /** Used to select what fields are present in the returned resource(s). */
-  select?: Get6ItemsItem[];
 }
 
 /** Contains response data for the getKeyValuesNext operation. */
@@ -668,14 +656,8 @@ export type GetKeyValuesNextResponse = AppConfigurationClientGetKeyValuesNextHea
 /** Optional parameters. */
 export interface GetLabelsNextOptionalParams
   extends coreClient.OperationOptions {
-  /** A filter for the name of the returned labels. */
-  name?: string;
-  /** Instructs the server to return elements that appear after the element referred to by the specified token. */
-  after?: string;
   /** Requests the server to respond with the state of the resource at the specified time. */
   acceptDatetime?: string;
-  /** Used to select what fields are present in the returned resource(s). */
-  select?: string[];
 }
 
 /** Contains response data for the getLabelsNext operation. */
@@ -685,16 +667,8 @@ export type GetLabelsNextResponse = AppConfigurationClientGetLabelsNextHeaders &
 /** Optional parameters. */
 export interface GetRevisionsNextOptionalParams
   extends coreClient.OperationOptions {
-  /** Instructs the server to return elements that appear after the element referred to by the specified token. */
-  after?: string;
   /** Requests the server to respond with the state of the resource at the specified time. */
   acceptDatetime?: string;
-  /** A filter used to match keys. */
-  key?: string;
-  /** A filter used to match labels */
-  label?: string;
-  /** Used to select what fields are present in the returned resource(s). */
-  select?: Enum4[];
 }
 
 /** Contains response data for the getRevisionsNext operation. */

diff --git a/...autorest.typescript/test/integration/generated/appconfigurationexport/src/pagingHelper.ts b/...autorest.typescript/test/integration/generated/appconfigurationexport/src/pagingHelper.ts
@@ -13,11 +13,11 @@ export interface PageInfo {
 const pageMap = new WeakMap<object, PageInfo>();
 
 /**
- * Given a result page from a pageable operation, returns a
- * continuation token that can be used to begin paging from
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
  * that point later.
- * @param page A result object from calling .byPage() on a paged operation.
- * @returns The continuation token that can be passed into byPage().
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
  */
 export function getContinuationToken(page: unknown): string | undefined {
   if (typeof page !== "object" || page === null) {

diff --git a/packages/autorest.typescript/test/integration/generated/customUrlPaging/src/pagingHelper.ts b/packages/autorest.typescript/test/integration/generated/customUrlPaging/src/pagingHelper.ts
@@ -13,11 +13,11 @@ export interface PageInfo {
 const pageMap = new WeakMap<object, PageInfo>();
 
 /**
- * Given a result page from a pageable operation, returns a
- * continuation token that can be used to begin paging from
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
  * that point later.
- * @param page A result object from calling .byPage() on a paged operation.
- * @returns The continuation token that can be passed into byPage().
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
  */
 export function getContinuationToken(page: unknown): string | undefined {
   if (typeof page !== "object" || page === null) {

diff --git a/....typescript/test/integration/generated/datafactory/src/operations/dataFlowDebugSession.ts b/....typescript/test/integration/generated/datafactory/src/operations/dataFlowDebugSession.ts
@@ -529,7 +529,6 @@ const queryByFactoryNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.nextLink,

diff --git a/...es/autorest.typescript/test/integration/generated/datafactory/src/operations/dataFlows.ts b/...es/autorest.typescript/test/integration/generated/datafactory/src/operations/dataFlows.ts
@@ -320,7 +320,6 @@ const listByFactoryNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.nextLink,

diff --git a/...ges/autorest.typescript/test/integration/generated/datafactory/src/operations/datasets.ts b/...ges/autorest.typescript/test/integration/generated/datafactory/src/operations/datasets.ts
@@ -321,7 +321,6 @@ const listByFactoryNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.nextLink,

diff --git a/...es/autorest.typescript/test/integration/generated/datafactory/src/operations/factories.ts b/...es/autorest.typescript/test/integration/generated/datafactory/src/operations/factories.ts
@@ -573,7 +573,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.nextLink,
@@ -593,7 +592,6 @@ const listByResourceGroupNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.nextLink,

diff --git a/...t.typescript/test/integration/generated/datafactory/src/operations/integrationRuntimes.ts b/...t.typescript/test/integration/generated/datafactory/src/operations/integrationRuntimes.ts
@@ -1096,7 +1096,6 @@ const listByFactoryNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.nextLink,

diff --git a/...torest.typescript/test/integration/generated/datafactory/src/operations/linkedServices.ts b/...torest.typescript/test/integration/generated/datafactory/src/operations/linkedServices.ts
@@ -327,7 +327,6 @@ const listByFactoryNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.nextLink,

diff --git a/...pescript/test/integration/generated/datafactory/src/operations/managedPrivateEndpoints.ts b/...pescript/test/integration/generated/datafactory/src/operations/managedPrivateEndpoints.ts
@@ -368,7 +368,6 @@ const listByFactoryNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.nextLink,

diff --git a/...ypescript/test/integration/generated/datafactory/src/operations/managedVirtualNetworks.ts b/...ypescript/test/integration/generated/datafactory/src/operations/managedVirtualNetworks.ts
@@ -284,7 +284,6 @@ const listByFactoryNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.nextLink,

diff --git a/...s/autorest.typescript/test/integration/generated/datafactory/src/operations/operations.ts b/...s/autorest.typescript/test/integration/generated/datafactory/src/operations/operations.ts
@@ -135,7 +135,6 @@ const listNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [Parameters.$host, Parameters.nextLink],
   headerParameters: [Parameters.accept],
   serializer

diff --git a/...es/autorest.typescript/test/integration/generated/datafactory/src/operations/pipelines.ts b/...es/autorest.typescript/test/integration/generated/datafactory/src/operations/pipelines.ts
@@ -373,7 +373,6 @@ const listByFactoryNextOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.CloudError
     }
   },
-  queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
     Parameters.nextLink,