no-order-by

Full name

@azure-tools/typespec-azure-core/no-order-by

List operations with an orderBy parameter are uncommon. Support should only be added after large collection sorting performance concerns are considered.

Note

This rule specifically targets Azure.Core.ResourceList operations. Standard operations using orderBy are not affected.

❌ Incorrect

Using OrderByQueryParameter in a ResourceList:

alias MyTraits = Azure.Core.Traits.QueryParametersTrait<OrderByQueryParameter>;

op list is Azure.Core.ResourceList<TestModel, MyTraits>;

Inline orderBy query parameter in a ResourceList:

alias MyTraits = Azure.Core.Traits.QueryParametersTrait<{
  @query orderBy: string;
}>;

op list is Azure.Core.ResourceList<TestModel, MyTraits>;

✅ Correct

ResourceList without orderBy:

op list is Azure.Core.ResourceList<TestModel>;