[http-spec] add link case of server driven pagination test (#5211)

only cover next link scenario for pagination. more complex case could be
added later.

.chronus/changes/list_operation_test-2024-10-27-18-41-40.md

@@ -0,0 +1,7 @@
+---
+changeKind: feature
+packages:
+  - "@typespec/http-specs"
+---
+
+add link case of server driven pagination test

packages/http-specs/spec-summary.md

@@ -1661,6 +1661,43 @@ Content-Type: application/octet-stream
 --abcde12345--
 ```
 
+### Payload_Pageable_ServerDrivenPagination_link
+
+- Endpoint: `get /payload/pageable/server-driven-pagination/link`
+
+Test case for using link as pagination.
+
+Two requests need to be tested.
+
+1. Initial request:
+   Expected route: /payload/pageable/server-driven-pagination/link
+   Expected response body:
+
+```json
+{
+  "pets": [
+    { "id": "1", "name": "dog" },
+    { "id": "2", "name": "cat" }
+  ],
+  "links": {
+    "next": "http://[host]:[port]/payload/pageable/server-driven-pagination/link/nextPage"
+  }
+}
+```
+
+2. Next page request:
+   Expected route: /payload/pageable/server-driven-pagination/link/nextPage
+   Expected response body:
+
+```json
+{
+  "pets": [
+    { "id": "3", "name": "bird" },
+    { "id": "4", "name": "fish" }
+  ]
+}
+```
+
 ### Payload_Xml_ModelWithArrayOfModelValue_get
 
 - Endpoint: `get /payload/xml/modelWithArrayOfModel`

packages/http-specs/specs/payload/pageable/main.tsp

@@ -0,0 +1,61 @@
+import "@typespec/http";
+import "@typespec/spector";
+
+using Http;
+using Spector;
+
+/**
+ * Test for pageable payload.
+ */
+@scenarioService("/payload/pageable")
+namespace Payload.Pageable;
+
+model Pet {
+  id: string;
+  name: string;
+}
+
+@route("/server-driven-pagination")
+namespace ServerDrivenPagination {
+  @scenario
+  @scenarioDoc("""
+    Test case for using link as pagination. 
+    
+    Two requests need to be tested.
+    1. Initial request:
+    Expected route: /payload/pageable/server-driven-pagination/link
+    Expected response body:
+    ```json
+    { "pets": [
+        { "id": "1", "name": "dog" },
+        { "id": "2", "name": "cat" }
+      ],
+      "links": {
+        "next": "http://[host]:[port]/payload/pageable/server-driven-pagination/link/nextPage"
+      }
+    }
+    ```
+    2. Next page request:
+    Expected route: /payload/pageable/server-driven-pagination/link/nextPage
+    Expected response body:
+    ```json
+    { "pets": [
+        { "id": "3", "name": "bird" },
+        { "id": "4", "name": "fish" }
+      ]
+    }
+    ```
+    """)
+  @route("/link")
+  op link(): {
+    @pageItems
+    pets: Pet[];
+
+    links: {
+      @nextLink next?: url;
+      @prevLink prev?: url;
+      @firstLink first?: url;
+      @lastLink last?: url;
+    };
+  };
+}

packages/http-specs/specs/payload/pageable/mockapi.ts

@@ -0,0 +1,53 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
+  {
+    uri: "/payload/pageable/server-driven-pagination/link",
+    method: "get",
+    request: {},
+    response: {
+      status: 200,
+      body: json({
+        pets: [
+          { id: "1", name: "dog" },
+          { id: "2", name: "cat" },
+        ],
+        links: {
+          next: "/payload/pageable/server-driven-pagination/link/nextPage",
+        },
+      }),
+    },
+    handler: (req: MockRequest) => {
+      return {
+        status: 200,
+        body: json({
+          pets: [
+            { id: "1", name: "dog" },
+            { id: "2", name: "cat" },
+          ],
+          links: {
+            next: `${req.baseUrl}/payload/pageable/server-driven-pagination/link/nextPage`,
+          },
+        }),
+      };
+    },
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/payload/pageable/server-driven-pagination/link/nextPage",
+    method: "get",
+    request: {},
+    response: {
+      status: 200,
+      body: json({
+        pets: [
+          { id: "3", name: "bird" },
+          { id: "4", name: "fish" },
+        ],
+      }),
+    },
+    kind: "MockApiDefinition",
+  },
+]);