Update CollectionWithNextLink to support pagination (#5685)

Fixes #5491 --------- Co-authored-by: Christopher Radek <[email protected]> Co-authored-by: Timothee Guerin <[email protected]>
microsoft · Jan 21, 2025 · 38ccfe1 · 38ccfe1
1 parent 55481b8
commit 38ccfe1
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/.chronus/changes/collection-is-pageable-2025-0-21-10-53-1.md b/.chronus/changes/collection-is-pageable-2025-0-21-10-53-1.md
@@ -0,0 +1,7 @@
+---
+changeKind: feature
+packages:
+  - "@typespec/rest"
+---
+
+Updates `CollectionWithNextLink` to support pagination
diff --git a/packages/rest/lib/resource.tsp b/packages/rest/lib/resource.tsp
@@ -224,18 +224,17 @@ interface ResourceDelete<Resource extends {}, Error> {
 /**
  * Structure for a paging response using `value` and `nextLink` to represent pagination.
  *
- * This only provides the model structure and not actual pagination support. See
- * https://github.com/microsoft/typespec/issues/705 for general paging support.
- *
  * @template Resource The resource type of the collection.
  */
 @doc("Paged response of {name} items", Resource)
 @friendlyName("{name}CollectionWithNextLink", Resource)
 model CollectionWithNextLink<Resource extends {}> {
   @doc("The items on this page")
+  @pageItems
   value: Resource[];
 
   @doc("The link to the next page of items")
+  @nextLink
   nextLink?: ResourceLocation<Resource>;
 }
 

diff --git a/website/src/content/docs/docs/libraries/rest/reference/data-types.md b/website/src/content/docs/docs/libraries/rest/reference/data-types.md
@@ -18,9 +18,6 @@ scalar TypeSpec.Rest.ResourceLocation
 
 Structure for a paging response using `value` and `nextLink` to represent pagination.
 
-This only provides the model structure and not actual pagination support. See
-https://github.com/microsoft/typespec/issues/705 for general paging support.
-
 ```typespec
 model TypeSpec.Rest.Resource.CollectionWithNextLink<Resource>
 ```