@typespec/http-specs 0.1.0-alpha.2 → 0.1.0-alpha.20

package/specs/payload/pageable/main.tsp

@@ -0,0 +1,252 @@
+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;
+}
+
+alias HeaderAndQuery = {
+  @header foo?: string;
+  @query bar?: 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" }
+      ],
+      "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")
+  @list
+  op link(): {
+    @pageItems
+    pets: Pet[];
+
+    @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?bar=bar
+      
+      Expected request header:
+      foo=foo
+      
+      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?bar=bar&token=page2
+      
+      Expected request header:
+      foo=foo
+      
+      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, ...HeaderAndQuery): {
+      @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?bar=bar      
+      
+      Expected request header:
+      foo=foo
+      
+      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?bar=bar
+      
+      Expected request header:
+      token=page2
+      foo=foo
+      
+      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, ...HeaderAndQuery): {
+      @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?bar=bar
+      
+      Expected request header:
+      foo=foo
+      
+      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?bar=bar&token=page2
+      
+      Expected request header:
+      foo=foo
+      
+      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, ...HeaderAndQuery): {
+      @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?bar=bar
+      
+      Expected request header:
+      foo=foo
+      
+      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?bar=bar
+      
+      Expected request header:
+      token=page2
+      foo=foo
+      
+      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, ...HeaderAndQuery): {
+      @pageItems
+      pets: Pet[];
+
+      @continuationToken @header nextToken?: string;
+    };
+  }
+}

package/specs/payload/pageable/mockapi.ts

@@ -0,0 +1,138 @@
+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",
+    foo: "foo",
+  },
+};
+
+const RequestTokenInQuery = {
+  query: { token: "page2", bar: "bar" },
+  headers: { foo: "foo" },
+};
+
+const RequestTokenInHeader = { headers: { token: "page2", foo: "foo" }, query: { bar: "bar" } };
+
+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) => {
+      req.expect.containsHeader("foo", "foo");
+      req.expect.containsQueryParam("bar", "bar");
+      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: { headers: { foo: "foo" }, query: { bar: "bar" } },
+      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",
+    method: "get",
+    request: {},
+    response: {
+      status: 200,
+      // TODO: need better way to handle baseUrl
+      // body: json({
+      //   pets: FirstPage,
+      //   next: "/payload/pageable/server-driven-pagination/link/nextPage",
+      // }),
+    },
+    handler: (req: MockRequest) => {
+      return {
+        status: 200,
+        body: json({
+          pets: FirstPage,
+          next: `${req.baseUrl}/payload/pageable/server-driven-pagination/link/nextPage`,
+        }),
+      };
+    },
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/payload/pageable/server-driven-pagination/link/nextPage",
+    method: "get",
+    request: {},
+    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/payload/xml/mockapi.ts

@@ -139,10 +139,7 @@ function createServerTests(uri: string, data?: any) {
       uri,
       method: "put",
       request: {
-        body: data,
-        headers: {
-          "content-type": "application/xml",
-        },
+        body: xml(data),
       },
       handler: (req: MockRequest) => {
         req.expect.containsHeader("content-type", "application/xml");

package/specs/response/status-code-range/main.tsp

@@ -0,0 +1,82 @@
+import "@typespec/http";
+import "@typespec/spector";
+
+using Http;
+using Spector;
+
+/**
+ * Test for range of status code.
+ */
+@scenarioService("/response/status-code-range")
+namespace Response.StatusCodeRange;
+
+@scenario
+@scenarioDoc("""
+  Test case for range of status code in error response.
+  
+  Verify that the result of the API is an error/exception in client, and the error response can be de-serialized to ErrorInRange model (instead of DefaultError model).
+  
+  Expected status code 494 and response body:
+  ```json
+  { 
+    "code": "request-header-too-large",
+    "message": "Request header too large"
+  }
+  ```
+  """)
+@route("/error-response-status-code-in-range")
+@get
+op errorResponseStatusCodeInRange(): NoContentResponse | ErrorInRange | DefaultError;
+
+@scenario
+@scenarioDoc("""
+  Test case for range of status code in error response.
+  
+  Verify that the result of the API is an error/exception in client, and the error response can be de-serialized to NotFoundError model (instead of Standard4XXError model).
+  
+  Expected status code 404 and response body:
+  ```json
+  { 
+    "code": "not-found",
+    "resourceId": "resource1"
+  }
+  ```
+  """)
+@route("/error-response-status-code-404")
+@get
+op errorResponseStatusCode404(): NoContentResponse | NotFoundError | Standard4XXError;
+
+@error
+model NotFoundError {
+  @statusCode
+  _: 404;
+
+  code: string;
+  resourceId: string;
+}
+
+@error
+model ErrorInRange {
+  @minValue(494)
+  @maxValue(499)
+  @statusCode
+  _: int32;
+
+  code: string;
+  message: string;
+}
+
+@error
+model Standard4XXError {
+  @minValue(400)
+  @maxValue(499)
+  @statusCode
+  _: int32;
+
+  code: string;
+}
+
+@error
+model DefaultError {
+  code: string;
+}

package/specs/response/status-code-range/mockapi.ts

@@ -0,0 +1,31 @@
+import { json, passOnCode, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Response_StatusCodeRange_errorResponseStatusCodeInRange = passOnCode(494, {
+  uri: "/response/status-code-range/error-response-status-code-in-range",
+  method: "get",
+  request: {},
+  response: {
+    status: 494,
+    body: json({
+      code: "request-header-too-large",
+      message: "Request header too large",
+    }),
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Response_StatusCodeRange_errorResponseStatusCode404 = passOnCode(404, {
+  uri: "/response/status-code-range/error-response-status-code-404",
+  method: "get",
+  request: {},
+  response: {
+    status: 404,
+    body: json({
+      code: "not-found",
+      resourceId: "resource1",
+    }),
+  },
+  kind: "MockApiDefinition",
+});