@typespec/http-specs 0.1.0-alpha.10-dev.1 → 0.1.0-alpha.10-dev.3

package/dist/specs/payload/pageable/mockapi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mockapi.d.ts","sourceRoot":"","sources":["../../../../specs/payload/pageable/mockapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoC,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEvF,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAM,CAAC"}
+{"version":3,"file":"mockapi.d.ts","sourceRoot":"","sources":["../../../../specs/payload/pageable/mockapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,eAAe,EAEhB,MAAM,oBAAoB,CAAC;AAE5B,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAM,CAAC"}

package/dist/specs/payload/pageable/mockapi.js

@@ -1,5 +1,73 @@
-import { json, passOnSuccess } from "@typespec/spec-api";
+import { json, passOnSuccess, ValidationError, } from "@typespec/spec-api";
 export const Scenarios = {};
+const FirstPage = [
+    { id: "1", name: "dog" },
+    { id: "2", name: "cat" },
+];
+const SecondPage = [
+    { id: "3", name: "bird" },
+    { id: "4", name: "fish" },
+];
+const FirstResponseTokenInBody = {
+    status: 200,
+    body: json({
+        pets: FirstPage,
+        nextToken: "page2",
+    }),
+};
+const SecondResponse = {
+    status: 200,
+    body: json({
+        pets: SecondPage,
+    }),
+};
+const FirstResponseTokenInHeader = {
+    status: 200,
+    body: json({
+        pets: FirstPage,
+    }),
+    headers: {
+        "next-token": "page2",
+    },
+};
+const RequestTokenInQuery = {
+    params: { token: "page2" },
+};
+const RequestTokenInHeader = { headers: { token: "page2" } };
+function createTests(reqInfo, resInfo) {
+    const uri = `/payload/pageable/server-driven-pagination/continuationtoken/request-${reqInfo}-response-${resInfo}`;
+    function createHandler() {
+        return (req) => {
+            const token = reqInfo === "header" ? req.headers?.token : req.query?.token;
+            switch (token) {
+                case undefined:
+                    return resInfo === "header" ? FirstResponseTokenInHeader : FirstResponseTokenInBody;
+                case "page2":
+                    return SecondResponse;
+                default:
+                    throw new ValidationError("Unsupported continuation token", `"undefined" | "page2"`, token);
+            }
+        };
+    }
+    return passOnSuccess([
+        {
+            uri: uri,
+            method: "get",
+            request: {},
+            response: resInfo === "header" ? FirstResponseTokenInHeader : FirstResponseTokenInBody,
+            handler: createHandler(),
+            kind: "MockApiDefinition",
+        },
+        {
+            uri: uri,
+            method: "get",
+            request: reqInfo === "header" ? RequestTokenInHeader : RequestTokenInQuery,
+            response: SecondResponse,
+            handler: createHandler(),
+            kind: "MockApiDefinition",
+        },
+    ]);
+}
 Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
     {
         uri: "/payload/pageable/server-driven-pagination/link",
@@ -8,10 +76,7 @@ Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
         response: {
             status: 200,
             body: json({
-                pets: [
-                    { id: "1", name: "dog" },
-                    { id: "2", name: "cat" },
-                ],
+                pets: FirstPage,
                 next: "/payload/pageable/server-driven-pagination/link/nextPage",
             }),
         },
@@ -19,10 +84,7 @@ Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
             return {
                 status: 200,
                 body: json({
-                    pets: [
-                        { id: "1", name: "dog" },
-                        { id: "2", name: "cat" },
-                    ],
+                    pets: FirstPage,
                     next: `${req.baseUrl}/payload/pageable/server-driven-pagination/link/nextPage`,
                 }),
             };
@@ -33,16 +95,16 @@ Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
         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" },
-                ],
-            }),
-        },
+        response: SecondResponse,
         kind: "MockApiDefinition",
     },
 ]);
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestQueryResponseBody =
+    createTests("query", "body");
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestHeaderResponseBody =
+    createTests("header", "body");
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestQueryResponseHeader =
+    createTests("query", "header");
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestHeaderResponseHeader =
+    createTests("header", "header");
 //# sourceMappingURL=mockapi.js.map

package/dist/specs/payload/pageable/mockapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"mockapi.js","sourceRoot":"","sources":["../../../../specs/payload/pageable/mockapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAe,aAAa,EAAmB,MAAM,oBAAoB,CAAC;AAEvF,MAAM,CAAC,MAAM,SAAS,GAAoC,EAAE,CAAC;AAE7D,SAAS,CAAC,4CAA4C,GAAG,aAAa,CAAC;IACrE;QACE,GAAG,EAAE,iDAAiD;QACtD,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE;YACR,MAAM,EAAE,GAAG;YACX,IAAI,EAAE,IAAI,CAAC;gBACT,IAAI,EAAE;oBACJ,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;oBACxB,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;iBACzB;gBACD,IAAI,EAAE,0DAA0D;aACjE,CAAC;SACH;QACD,OAAO,EAAE,CAAC,GAAgB,EAAE,EAAE;YAC5B,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,IAAI,CAAC;oBACT,IAAI,EAAE;wBACJ,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;wBACxB,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;qBACzB;oBACD,IAAI,EAAE,GAAG,GAAG,CAAC,OAAO,0DAA0D;iBAC/E,CAAC;aACH,CAAC;QACJ,CAAC;QACD,IAAI,EAAE,mBAAmB;KAC1B;IACD;QACE,GAAG,EAAE,0DAA0D;QAC/D,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE;YACR,MAAM,EAAE,GAAG;YACX,IAAI,EAAE,IAAI,CAAC;gBACT,IAAI,EAAE;oBACJ,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE;oBACzB,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE;iBAC1B;aACF,CAAC;SACH;QACD,IAAI,EAAE,mBAAmB;KAC1B;CACF,CAAC,CAAC"}
+{"version":3,"file":"mockapi.js","sourceRoot":"","sources":["../../../../specs/payload/pageable/mockapi.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EAEJ,aAAa,EAEb,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAE5B,MAAM,CAAC,MAAM,SAAS,GAAoC,EAAE,CAAC;AAE7D,MAAM,SAAS,GAAG;IAChB,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;IACxB,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;CACzB,CAAC;AAEF,MAAM,UAAU,GAAG;IACjB,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE;IACzB,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE;CAC1B,CAAC;AAEF,MAAM,wBAAwB,GAAG;IAC/B,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,IAAI,CAAC;QACT,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,OAAO;KACnB,CAAC;CACH,CAAC;AAEF,MAAM,cAAc,GAAG;IACrB,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,IAAI,CAAC;QACT,IAAI,EAAE,UAAU;KACjB,CAAC;CACH,CAAC;AAEF,MAAM,0BAA0B,GAAG;IACjC,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,IAAI,CAAC;QACT,IAAI,EAAE,SAAS;KAChB,CAAC;IACF,OAAO,EAAE;QACP,YAAY,EAAE,OAAO;KACtB;CACF,CAAC;AAEF,MAAM,mBAAmB,GAAG;IAC1B,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;CAC3B,CAAC;AAEF,MAAM,oBAAoB,GAAG,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC;AAE7D,SAAS,WAAW,CAAC,OAA2B,EAAE,OAA0B;IAC1E,MAAM,GAAG,GAAG,wEAAwE,OAAO,aAAa,OAAO,EAAE,CAAC;IAClH,SAAS,aAAa;QACpB,OAAO,CAAC,GAAgB,EAAE,EAAE;YAC1B,MAAM,KAAK,GAAG,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC;YAC3E,QAAQ,KAAK,EAAE,CAAC;gBACd,KAAK,SAAS;oBACZ,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,wBAAwB,CAAC;gBACtF,KAAK,OAAO;oBACV,OAAO,cAAc,CAAC;gBACxB;oBACE,MAAM,IAAI,eAAe,CACvB,gCAAgC,EAChC,uBAAuB,EACvB,KAAK,CACN,CAAC;YACN,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,aAAa,CAAC;QACnB;YACE,GAAG,EAAE,GAAG;YACR,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,wBAAwB;YACtF,OAAO,EAAE,aAAa,EAAE;YACxB,IAAI,EAAE,mBAAmB;SAC1B;QACD;YACE,GAAG,EAAE,GAAG;YACR,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,mBAAmB;YAC1E,QAAQ,EAAE,cAAc;YACxB,OAAO,EAAE,aAAa,EAAE;YACxB,IAAI,EAAE,mBAAmB;SAC1B;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAS,CAAC,4CAA4C,GAAG,aAAa,CAAC;IACrE;QACE,GAAG,EAAE,iDAAiD;QACtD,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE;YACR,MAAM,EAAE,GAAG;YACX,IAAI,EAAE,IAAI,CAAC;gBACT,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,0DAA0D;aACjE,CAAC;SACH;QACD,OAAO,EAAE,CAAC,GAAgB,EAAE,EAAE;YAC5B,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,IAAI,CAAC;oBACT,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,GAAG,GAAG,CAAC,OAAO,0DAA0D;iBAC/E,CAAC;aACH,CAAC;QACJ,CAAC;QACD,IAAI,EAAE,mBAAmB;KAC1B;IACD;QACE,GAAG,EAAE,0DAA0D;QAC/D,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,cAAc;QACxB,IAAI,EAAE,mBAAmB;KAC1B;CACF,CAAC,CAAC;AAEH,SAAS,CAAC,kFAAkF;IAC1F,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAE/B,SAAS,CAAC,mFAAmF;IAC3F,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AAEhC,SAAS,CAAC,oFAAoF;IAC5F,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACjC,SAAS,CAAC,qFAAqF;IAC7F,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-specs",
-  "version": "0.1.0-alpha.10-dev.1",
+  "version": "0.1.0-alpha.10-dev.3",
   "description": "Spec scenarios and mock apis",
   "main": "dist/index.js",
   "type": "module",
@@ -42,6 +42,7 @@
     "build": "tsc -p ./tsconfig.build.json",
     "clean": "rimraf dist/ temp/",
     "test:e2e": "pnpm validate-scenarios  && pnpm validate-mock-apis && pnpm validate-client-server",
+    "validate:all": "pnpm build && pnpm regen-docs && pnpm test:e2e",
     "validate-scenarios": "tsp-spector validate-scenarios ./specs",
     "generate-scenarios-summary": "tsp-spector generate-scenarios-summary ./specs",
     "regen-docs": "pnpm generate-scenarios-summary",

package/spec-summary.md

@@ -1661,6 +1661,160 @@ Content-Type: application/octet-stream
 --abcde12345--
 ```
 
+### Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestHeaderResponseBody
+
+- Endpoint: `get /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-body`
+
+Test case for using continuation token as pagination. Continuation token is passed in the request header and response body.
+
+Two requests need to be tested.
+
+1. Initial request:
+   Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-body
+
+Expected response body:
+
+```json
+{
+  "pets": [
+    { "id": "1", "name": "dog" },
+    { "id": "2", "name": "cat" }
+  ],
+  "nextToken": "page2"
+}
+```
+
+2. Next page request:
+   Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-body
+
+Expected header:
+token=page2
+
+Expected response body:
+
+```json
+{
+  "pets": [
+    { "id": "3", "name": "bird" },
+    { "id": "4", "name": "fish" }
+  ]
+}
+```
+
+### Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestHeaderResponseHeader
+
+- Endpoint: `get /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-header`
+
+Test case for using continuation token as pagination. Continuation token is passed in the request header and response header.
+
+Two requests need to be tested.
+
+1. Initial request:
+   Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-header
+   Expected response body:
+
+```json
+{
+  "pets": [
+    { "id": "1", "name": "dog" },
+    { "id": "2", "name": "cat" }
+  ]
+}
+```
+
+Expected response header:
+next-token=page2
+
+2. Next page request:
+   Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-header
+
+Expected request header:
+token=page2
+
+Expected response body:
+
+```json
+{
+  "pets": [
+    { "id": "3", "name": "bird" },
+    { "id": "4", "name": "fish" }
+  ]
+}
+```
+
+### Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestQueryResponseBody
+
+- Endpoint: `get /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-body`
+
+Test case for using continuation token as pagination. Continuation token is passed in the request query and response body.
+
+Two requests need to be tested.
+
+1. Initial request:
+   Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-body
+   Expected response body:
+
+```json
+{
+  "pets": [
+    { "id": "1", "name": "dog" },
+    { "id": "2", "name": "cat" }
+  ],
+  "nextToken": "page2"
+}
+```
+
+2. Next page request:
+   Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-body?token=page2
+
+Expected response body:
+
+```json
+{
+  "pets": [
+    { "id": "3", "name": "bird" },
+    { "id": "4", "name": "fish" }
+  ]
+}
+```
+
+### Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestQueryResponseHeader
+
+- Endpoint: `get /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-header`
+
+Test case for using continuation token as pagination. Continuation token is passed in the request query and response header.
+
+Two requests need to be tested.
+
+1. Initial request:
+   Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-header
+   Expected response body:
+
+```json
+{
+  "pets": [
+    { "id": "1", "name": "dog" },
+    { "id": "2", "name": "cat" }
+  ]
+}
+```
+
+Expected response header:
+next-token=page2
+
+2. Next page request:
+   Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-header?token=page2
+   Expected response body:
+
+```json
+{
+  "pets": [
+    { "id": "3", "name": "bird" },
+    { "id": "4", "name": "fish" }
+  ]
+}
+```
+
 ### Payload_Pageable_ServerDrivenPagination_link
 
 - Endpoint: `get /payload/pageable/server-driven-pagination/link`
@@ -2200,7 +2354,7 @@ Expected path: /routes/path/label/standard/record.a,1,b,2
 
 Test matrix expansion with explode: true when passed an array value.
 Param value: ["a","b"]
-Expected path: /routes/path/matrix/explode/array;a.b
+Expected path: /routes/path/matrix/explode/array;param=a;param=b
 
 ### Routes_PathParameters_MatrixExpansion_Explode_primitive
 
@@ -2208,7 +2362,7 @@ Expected path: /routes/path/matrix/explode/array;a.b
 
 Test matrix expansion with explode: true when passed a primitive value.
 Param value: "a"
-Expected path: /routes/path/matrix/explode/primitive;a
+Expected path: /routes/path/matrix/explode/primitive;param=a
 
 ### Routes_PathParameters_MatrixExpansion_Explode_record
 
@@ -2224,7 +2378,7 @@ Expected path: /routes/path/matrix/explode/record;a=1;b=2
 
 Test matrix expansion with explode: false when passed an array value.
 Param value: ["a","b"]
-Expected path: /routes/path/matrix/standard/array;a,b
+Expected path: /routes/path/matrix/standard/array;param=a;param=b
 
 ### Routes_PathParameters_MatrixExpansion_Standard_primitive
 
@@ -2232,7 +2386,7 @@ Expected path: /routes/path/matrix/standard/array;a,b
 
 Test matrix expansion with explode: false when passed a primitive value.
 Param value: "a"
-Expected path: /routes/path/matrix/standard/primitive;a
+Expected path: /routes/path/matrix/standard/primitive;param=a
 
 ### Routes_PathParameters_MatrixExpansion_Standard_record
 
@@ -2240,7 +2394,7 @@ Expected path: /routes/path/matrix/standard/primitive;a
 
 Test matrix expansion with explode: false when passed a record value.
 Param value: {a: 1, b: 2}
-Expected path: /routes/path/matrix/standard/record;a,1,b,2
+Expected path: /routes/path/matrix/standard/record;a=1;b=2
 
 ### Routes_PathParameters_PathExpansion_Explode_array
 

package/specs/payload/pageable/main.tsp

@@ -52,4 +52,168 @@ namespace ServerDrivenPagination {
 
     @nextLink next?: url;
   };
+
+  @route("/continuationtoken")
+  namespace ContinuationToken {
+    @scenario
+    @scenarioDoc("""
+      Test case for using continuation token as pagination. Continuation token is passed in the request query and response body.
+      
+      Two requests need to be tested.
+      1. Initial request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-body
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "1", "name": "dog" },
+          { "id": "2", "name": "cat" }
+        ],
+        "nextToken": "page2"
+      }
+      ```
+      
+      2. Next page request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-body?token=page2
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "3", "name": "bird" },
+          { "id": "4", "name": "fish" }
+        ]
+      }
+      ```
+      """)
+    @route("/request-query-response-body")
+    @list
+    op requestQueryResponseBody(@continuationToken @query token?: string): {
+      @pageItems
+      pets: Pet[];
+
+      @continuationToken nextToken?: string;
+    };
+
+    @scenario
+    @scenarioDoc("""
+      Test case for using continuation token as pagination. Continuation token is passed in the request header and response body.
+      
+      Two requests need to be tested.
+      1. Initial request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-body      
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "1", "name": "dog" },
+          { "id": "2", "name": "cat" }
+        ],
+        "nextToken": "page2"
+      }
+      ```
+      2. Next page request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-body
+      
+      Expected header:
+      token=page2
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "3", "name": "bird" },
+          { "id": "4", "name": "fish" }
+        ]
+      }
+      ```
+      """)
+    @route("/request-header-response-body")
+    @list
+    op requestHeaderResponseBody(@continuationToken @header token?: string): {
+      @pageItems
+      pets: Pet[];
+
+      @continuationToken nextToken?: string;
+    };
+
+    @scenario
+    @scenarioDoc("""
+      Test case for using continuation token as pagination. Continuation token is passed in the request query and response header.
+      
+      Two requests need to be tested.
+      1. Initial request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-header
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "1", "name": "dog" },
+          { "id": "2", "name": "cat" }
+        ]
+      }
+      ```
+      
+      Expected response header:
+      next-token=page2
+      
+      2. Next page request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-header?token=page2
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "3", "name": "bird" },
+          { "id": "4", "name": "fish" }
+        ]
+      }
+      ```
+      """)
+    @route("/request-query-response-header")
+    @list
+    op requestQueryResponseHeader(@continuationToken @query token?: string): {
+      @pageItems
+      pets: Pet[];
+
+      @continuationToken @header nextToken?: string;
+    };
+
+    @scenario
+    @scenarioDoc("""
+      Test case for using continuation token as pagination. Continuation token is passed in the request header and response header.
+      
+      Two requests need to be tested.
+      1. Initial request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-header
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "1", "name": "dog" },
+          { "id": "2", "name": "cat" }
+        ]
+      }
+      ```
+      
+      Expected response header:
+      next-token=page2
+      
+      2. Next page request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-header
+      
+      Expected request header:
+      token=page2
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "3", "name": "bird" },
+          { "id": "4", "name": "fish" }
+        ]
+      }
+      ```
+      """)
+    @route("/request-header-response-header")
+    @list
+    op requestHeaderResponseHeader(@continuationToken @header token?: string): {
+      @pageItems
+      pets: Pet[];
+
+      @continuationToken @header nextToken?: string;
+    };
+  }
 }

package/specs/payload/pageable/mockapi.ts

@@ -1,7 +1,94 @@
-import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+import {
+  json,
+  MockRequest,
+  passOnSuccess,
+  ScenarioMockApi,
+  ValidationError,
+} from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
+const FirstPage = [
+  { id: "1", name: "dog" },
+  { id: "2", name: "cat" },
+];
+
+const SecondPage = [
+  { id: "3", name: "bird" },
+  { id: "4", name: "fish" },
+];
+
+const FirstResponseTokenInBody = {
+  status: 200,
+  body: json({
+    pets: FirstPage,
+    nextToken: "page2",
+  }),
+};
+
+const SecondResponse = {
+  status: 200,
+  body: json({
+    pets: SecondPage,
+  }),
+};
+
+const FirstResponseTokenInHeader = {
+  status: 200,
+  body: json({
+    pets: FirstPage,
+  }),
+  headers: {
+    "next-token": "page2",
+  },
+};
+
+const RequestTokenInQuery = {
+  params: { token: "page2" },
+};
+
+const RequestTokenInHeader = { headers: { token: "page2" } };
+
+function createTests(reqInfo: "query" | "header", resInfo: "body" | "header") {
+  const uri = `/payload/pageable/server-driven-pagination/continuationtoken/request-${reqInfo}-response-${resInfo}`;
+  function createHandler() {
+    return (req: MockRequest) => {
+      const token = reqInfo === "header" ? req.headers?.token : req.query?.token;
+      switch (token) {
+        case undefined:
+          return resInfo === "header" ? FirstResponseTokenInHeader : FirstResponseTokenInBody;
+        case "page2":
+          return SecondResponse;
+        default:
+          throw new ValidationError(
+            "Unsupported continuation token",
+            `"undefined" | "page2"`,
+            token,
+          );
+      }
+    };
+  }
+
+  return passOnSuccess([
+    {
+      uri: uri,
+      method: "get",
+      request: {},
+      response: resInfo === "header" ? FirstResponseTokenInHeader : FirstResponseTokenInBody,
+      handler: createHandler(),
+      kind: "MockApiDefinition",
+    },
+    {
+      uri: uri,
+      method: "get",
+      request: reqInfo === "header" ? RequestTokenInHeader : RequestTokenInQuery,
+      response: SecondResponse,
+      handler: createHandler(),
+      kind: "MockApiDefinition",
+    },
+  ]);
+}
+
 Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
   {
     uri: "/payload/pageable/server-driven-pagination/link",
@@ -10,10 +97,7 @@ Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
     response: {
       status: 200,
       body: json({
-        pets: [
-          { id: "1", name: "dog" },
-          { id: "2", name: "cat" },
-        ],
+        pets: FirstPage,
         next: "/payload/pageable/server-driven-pagination/link/nextPage",
       }),
     },
@@ -21,10 +105,7 @@ Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
       return {
         status: 200,
         body: json({
-          pets: [
-            { id: "1", name: "dog" },
-            { id: "2", name: "cat" },
-          ],
+          pets: FirstPage,
           next: `${req.baseUrl}/payload/pageable/server-driven-pagination/link/nextPage`,
         }),
       };
@@ -35,15 +116,18 @@ Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
     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" },
-        ],
-      }),
-    },
+    response: SecondResponse,
     kind: "MockApiDefinition",
   },
 ]);
+
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestQueryResponseBody =
+  createTests("query", "body");
+
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestHeaderResponseBody =
+  createTests("header", "body");
+
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestQueryResponseHeader =
+  createTests("query", "header");
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestHeaderResponseHeader =
+  createTests("header", "header");

package/specs/type/property/additional-properties/main.tsp

@@ -463,6 +463,7 @@ interface SpreadRecordUnion
     > {}
 
 // ****************** spread record of discriminated unions **************************
+#suppress "deprecated" "Legacy to replace with @discriminated(#{envelope: none})"
 @discriminator("kind")
 union WidgetData {
   kind0: WidgetData0,