list-operation-missing-pageable

Id

@azure-tools/typespec-azure-resource-manager/list-operation-missing-pageable

ARM GET operations on list paths must define TypeSpec paging metadata.

ARM collection GET operations must use pageable response metadata. Authoring pagination up front keeps generated SDK list methods consistent and avoids a later breaking change when a service needs to add continuation links.

Use the standard ARM list operation templates when possible. Custom list operations can use @list, identify the returned items with @pageItems, and identify the continuation link with @nextLink.

❌ Incorrect

@route("/subscriptions/{subscriptionId}/providers/Microsoft.Contoso/widgets")
@get
@armResourceList(Widget)
op listWidgets(@path subscriptionId: string, ...ApiVersionParameter): Widget[];

✅ Correct

model WidgetPage {
  @pageItems
  value: Widget[];

  @nextLink
  nextLink?: url;
}

@route("/subscriptions/{subscriptionId}/providers/Microsoft.Contoso/widgets")
@get
@list
@armResourceList(Widget)
op listWidgets(@path subscriptionId: string, ...ApiVersionParameter): WidgetPage;

LintDiff Equivalent

This rule is equivalent to the Swagger validator rule XmsPageableForListCalls.