@typespec/http-specs 0.1.0-alpha.32-dev.0 → 0.1.0-alpha.32-dev.3

package/specs/encode/array/main.tsp

@@ -8,6 +8,19 @@ using Spector;
 @scenarioService("/encode/array")
 namespace Encode.Array;
 
+enum Colors {
+  Blue: "blue",
+  Red: "red",
+  Green: "green",
+}
+
+union ColorsExtensibleEnum {
+  string,
+  Blue: "blue",
+  Red: "red",
+  Green: "green",
+}
+
 model CommaDelimitedArrayProperty {
   @encode(ArrayEncoding.commaDelimited)
   value: string[];
@@ -28,6 +41,46 @@ model NewlineDelimitedArrayProperty {
   value: string[];
 }
 
+model CommaDelimitedEnumArrayProperty {
+  @encode(ArrayEncoding.commaDelimited)
+  value: Colors[];
+}
+
+model SpaceDelimitedEnumArrayProperty {
+  @encode(ArrayEncoding.spaceDelimited)
+  value: Colors[];
+}
+
+model PipeDelimitedEnumArrayProperty {
+  @encode(ArrayEncoding.pipeDelimited)
+  value: Colors[];
+}
+
+model NewlineDelimitedEnumArrayProperty {
+  @encode(ArrayEncoding.newlineDelimited)
+  value: Colors[];
+}
+
+model CommaDelimitedExtensibleEnumArrayProperty {
+  @encode(ArrayEncoding.commaDelimited)
+  value: ColorsExtensibleEnum[];
+}
+
+model SpaceDelimitedExtensibleEnumArrayProperty {
+  @encode(ArrayEncoding.spaceDelimited)
+  value: ColorsExtensibleEnum[];
+}
+
+model PipeDelimitedExtensibleEnumArrayProperty {
+  @encode(ArrayEncoding.pipeDelimited)
+  value: ColorsExtensibleEnum[];
+}
+
+model NewlineDelimitedExtensibleEnumArrayProperty {
+  @encode(ArrayEncoding.newlineDelimited)
+  value: ColorsExtensibleEnum[];
+}
+
 @route("/property")
 namespace Property {
   @route("/comma-delimited")
@@ -109,4 +162,178 @@ namespace Property {
     """)
   @post
   op newlineDelimited(@body body: NewlineDelimitedArrayProperty): NewlineDelimitedArrayProperty;
+
+  @route("/enum/comma-delimited")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains an enum array property with commaDelimited encode.
+    Expected request body:
+    ```json
+    {
+      "value": "blue,red,green"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "blue,red,green"
+    }
+    ```
+    """)
+  @post
+  op enumCommaDelimited(
+    @body body: CommaDelimitedEnumArrayProperty,
+  ): CommaDelimitedEnumArrayProperty;
+
+  @route("/enum/space-delimited")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains an enum array property with spaceDelimited encode.
+    Expected request body:
+    ```json
+    {
+      "value": "blue red green"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "blue red green"
+    }
+    ```
+    """)
+  @post
+  op enumSpaceDelimited(
+    @body body: SpaceDelimitedEnumArrayProperty,
+  ): SpaceDelimitedEnumArrayProperty;
+
+  @route("/enum/pipe-delimited")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains an enum array property with pipeDelimited encode.
+    Expected request body:
+    ```json
+    {
+      "value": "blue|red|green"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "blue|red|green"
+    }
+    ```
+    """)
+  @post
+  op enumPipeDelimited(@body body: PipeDelimitedEnumArrayProperty): PipeDelimitedEnumArrayProperty;
+
+  @route("/enum/newline-delimited")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains an enum array property with newlineDelimited encode.
+    Expected request body:
+    ```json
+    {
+      "value": "blue\\nred\\ngreen"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "blue\\nred\\ngreen"
+    }
+    ```
+    """)
+  @post
+  op enumNewlineDelimited(
+    @body body: NewlineDelimitedEnumArrayProperty,
+  ): NewlineDelimitedEnumArrayProperty;
+
+  @route("/extensible-enum/comma-delimited")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains an extensible enum (union) array property with commaDelimited encode.
+    Expected request body:
+    ```json
+    {
+      "value": "blue,red,green"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "blue,red,green"
+    }
+    ```
+    """)
+  @post
+  op extensibleEnumCommaDelimited(
+    @body body: CommaDelimitedExtensibleEnumArrayProperty,
+  ): CommaDelimitedExtensibleEnumArrayProperty;
+
+  @route("/extensible-enum/space-delimited")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains an extensible enum (union) array property with spaceDelimited encode.
+    Expected request body:
+    ```json
+    {
+      "value": "blue red green"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "blue red green"
+    }
+    ```
+    """)
+  @post
+  op extensibleEnumSpaceDelimited(
+    @body body: SpaceDelimitedExtensibleEnumArrayProperty,
+  ): SpaceDelimitedExtensibleEnumArrayProperty;
+
+  @route("/extensible-enum/pipe-delimited")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains an extensible enum (union) array property with pipeDelimited encode.
+    Expected request body:
+    ```json
+    {
+      "value": "blue|red|green"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "blue|red|green"
+    }
+    ```
+    """)
+  @post
+  op extensibleEnumPipeDelimited(
+    @body body: PipeDelimitedExtensibleEnumArrayProperty,
+  ): PipeDelimitedExtensibleEnumArrayProperty;
+
+  @route("/extensible-enum/newline-delimited")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains an extensible enum (union) array property with newlineDelimited encode.
+    Expected request body:
+    ```json
+    {
+      "value": "blue\\nred\\ngreen"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "blue\\nred\\ngreen"
+    }
+    ```
+    """)
+  @post
+  op extensibleEnumNewlineDelimited(
+    @body body: NewlineDelimitedExtensibleEnumArrayProperty,
+  ): NewlineDelimitedExtensibleEnumArrayProperty;
 }

package/specs/encode/array/mockapi.ts

@@ -41,3 +41,43 @@ Scenarios.Encode_Array_Property_newlineDelimited = createPropertyServerTests(
   "/encode/array/property/newline-delimited",
   "\n",
 );
+
+Scenarios.Encode_Array_Property_enumCommaDelimited = createPropertyServerTests(
+  "/encode/array/property/enum/comma-delimited",
+  ",",
+);
+
+Scenarios.Encode_Array_Property_enumSpaceDelimited = createPropertyServerTests(
+  "/encode/array/property/enum/space-delimited",
+  " ",
+);
+
+Scenarios.Encode_Array_Property_enumPipeDelimited = createPropertyServerTests(
+  "/encode/array/property/enum/pipe-delimited",
+  "|",
+);
+
+Scenarios.Encode_Array_Property_enumNewlineDelimited = createPropertyServerTests(
+  "/encode/array/property/enum/newline-delimited",
+  "\n",
+);
+
+Scenarios.Encode_Array_Property_extensibleEnumCommaDelimited = createPropertyServerTests(
+  "/encode/array/property/extensible-enum/comma-delimited",
+  ",",
+);
+
+Scenarios.Encode_Array_Property_extensibleEnumSpaceDelimited = createPropertyServerTests(
+  "/encode/array/property/extensible-enum/space-delimited",
+  " ",
+);
+
+Scenarios.Encode_Array_Property_extensibleEnumPipeDelimited = createPropertyServerTests(
+  "/encode/array/property/extensible-enum/pipe-delimited",
+  "|",
+);
+
+Scenarios.Encode_Array_Property_extensibleEnumNewlineDelimited = createPropertyServerTests(
+  "/encode/array/property/extensible-enum/newline-delimited",
+  "\n",
+);

package/specs/payload/pageable/main.tsp

@@ -1,8 +1,10 @@
 import "@typespec/http";
 import "@typespec/spector";
+import "@typespec/xml";
 
 using Http;
 using Spector;
+using Xml;
 
 /**
  * Test for pageable payload.
@@ -514,3 +516,141 @@ namespace PageSize {
     pets: Pet[];
   };
 }
+
+@doc("An XML pet item.")
+@name("Pet")
+model XmlPet {
+  @name("Id") id: string;
+  @name("Name") name: string;
+}
+
+@route("/xml")
+namespace XmlPagination {
+  @scenario
+  @scenarioDoc("""
+    Test case for XML pagination with continuation token. Continuation token is passed in the request query and response body.
+    
+    Two requests need to be tested.
+    
+    1. Initial request:
+    Expected route: /payload/pageable/xml/list
+    
+    Expected response body:
+    ```xml
+    <PetListResult>
+      <Pets>
+        <Pet>
+          <Id>1</Id>
+          <Name>dog</Name>
+        </Pet>
+        <Pet>
+          <Id>2</Id>
+          <Name>cat</Name>
+        </Pet>
+      </Pets>
+      <NextMarker>page2</NextMarker>
+    </PetListResult>
+    ```
+    
+    2. Next page request:
+    Expected route: /payload/pageable/xml/list?marker=page2
+    
+    Expected response body:
+    ```xml
+    <PetListResult>
+      <Pets>
+        <Pet>
+          <Id>3</Id>
+          <Name>bird</Name>
+        </Pet>
+        <Pet>
+          <Id>4</Id>
+          <Name>fish</Name>
+        </Pet>
+      </Pets>
+    </PetListResult>
+    ```
+    """)
+  @route("/list-with-continuation")
+  @list
+  op listWithContinuation(@continuationToken @query marker?: string): {
+    @header("content-type") contentType: "application/xml";
+    @body body: XmlPetListResult;
+  };
+
+  @scenario
+  @scenarioDoc("""
+    Test case for XML pagination with next link.
+    
+    Two requests need to be tested.
+    
+    1. Initial request:
+    Expected route: /payload/pageable/xml/list-with-next-link
+    
+    Expected response body:
+    ```xml
+    <PetListResult>
+      <Pets>
+        <Pet>
+          <Id>1</Id>
+          <Name>dog</Name>
+        </Pet>
+        <Pet>
+          <Id>2</Id>
+          <Name>cat</Name>
+        </Pet>
+      </Pets>
+      <NextLink>http://[host]:[port]/payload/pageable/xml/list-with-next-link/nextPage</NextLink>
+    </PetListResult>
+    ```
+    
+    2. Next page request:
+    Expected route: /payload/pageable/xml/list-with-next-link/nextPage
+    
+    Expected response body:
+    ```xml
+    <PetListResult>
+      <Pets>
+        <Pet>
+          <Id>3</Id>
+          <Name>bird</Name>
+        </Pet>
+        <Pet>
+          <Id>4</Id>
+          <Name>fish</Name>
+        </Pet>
+      </Pets>
+    </PetListResult>
+    ```
+    """)
+  @route("/list-with-next-link")
+  @list
+  op listWithNextLink(): {
+    @header("content-type") contentType: "application/xml";
+    @body body: XmlPetListResultWithNextLink;
+  };
+}
+
+@doc("The XML response for listing pets.")
+@name("PetListResult")
+model XmlPetListResult {
+  @pageItems
+  @name("Pets")
+  pets: XmlPet[];
+
+  @continuationToken
+  @name("NextMarker")
+  nextMarker?: string;
+}
+
+@doc("The XML response for listing pets with next link.")
+@name("PetListResult")
+model XmlPetListResultWithNextLink {
+  @pageItems
+  @name("Pets")
+  pets: XmlPet[];
+
+  @nextLink
+  @name("NextLink")
+  nextLink?: url;
+}

package/specs/payload/pageable/mockapi.ts

@@ -6,6 +6,7 @@ import {
   passOnSuccess,
   ScenarioMockApi,
   ValidationError,
+  xml,
 } from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
@@ -511,3 +512,180 @@ Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestHeade
       kind: "MockApiDefinition",
     },
   ]);
+
+const XmlContTokenFirstPage = `
+<PetListResult>
+  <Pets>
+    <Pet>
+      <Id>1</Id>
+      <Name>dog</Name>
+    </Pet>
+    <Pet>
+      <Id>2</Id>
+      <Name>cat</Name>
+    </Pet>
+  </Pets>
+  <NextMarker>page2</NextMarker>
+</PetListResult>
+`;
+
+const XmlContTokenSecondPage = `
+<PetListResult>
+  <Pets>
+    <Pet>
+      <Id>3</Id>
+      <Name>bird</Name>
+    </Pet>
+    <Pet>
+      <Id>4</Id>
+      <Name>fish</Name>
+    </Pet>
+  </Pets>
+</PetListResult>
+`;
+
+Scenarios.Payload_Pageable_XmlPagination_listWithContinuation = passOnSuccess([
+  {
+    uri: "/payload/pageable/xml/list-with-continuation",
+    method: "get",
+    request: {},
+    response: {
+      status: 200,
+      body: xml(XmlContTokenFirstPage),
+      headers: {
+        "content-type": "application/xml",
+      },
+    },
+    handler: (req: MockRequest) => {
+      const marker = req.query?.marker;
+
+      switch (marker) {
+        case undefined:
+          return {
+            status: 200,
+            body: xml(XmlContTokenFirstPage),
+            headers: {
+              "content-type": "application/xml",
+            },
+          };
+        case "page2":
+          return {
+            status: 200,
+            body: xml(XmlContTokenSecondPage),
+            headers: {
+              "content-type": "application/xml",
+            },
+          };
+        default:
+          throw new ValidationError("Unsupported marker", `"undefined" | "page2"`, marker);
+      }
+    },
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/payload/pageable/xml/list-with-continuation",
+    method: "get",
+    request: { query: { marker: "page2" } },
+    response: {
+      status: 200,
+      body: xml(XmlContTokenSecondPage),
+      headers: {
+        "content-type": "application/xml",
+      },
+    },
+    handler: (req: MockRequest) => {
+      const marker = req.query?.marker;
+
+      switch (marker) {
+        case undefined:
+          return {
+            status: 200,
+            body: xml(XmlContTokenFirstPage),
+            headers: {
+              "content-type": "application/xml",
+            },
+          };
+        case "page2":
+          return {
+            status: 200,
+            body: xml(XmlContTokenSecondPage),
+            headers: {
+              "content-type": "application/xml",
+            },
+          };
+        default:
+          throw new ValidationError("Unsupported marker", `"undefined" | "page2"`, marker);
+      }
+    },
+    kind: "MockApiDefinition",
+  },
+]);
+
+const xmlNextLinkFirstPage = (baseUrl: string) => `
+<PetListResult>
+  <Pets>
+    <Pet>
+      <Id>1</Id>
+      <Name>dog</Name>
+    </Pet>
+    <Pet>
+      <Id>2</Id>
+      <Name>cat</Name>
+    </Pet>
+  </Pets>
+  <NextLink>${baseUrl}/payload/pageable/xml/list-with-next-link/nextPage</NextLink>
+</PetListResult>
+`;
+
+const XmlNextLinkSecondPage = `
+<PetListResult>
+  <Pets>
+    <Pet>
+      <Id>3</Id>
+      <Name>bird</Name>
+    </Pet>
+    <Pet>
+      <Id>4</Id>
+      <Name>fish</Name>
+    </Pet>
+  </Pets>
+</PetListResult>
+`;
+
+Scenarios.Payload_Pageable_XmlPagination_listWithNextLink = passOnSuccess([
+  {
+    uri: "/payload/pageable/xml/list-with-next-link",
+    method: "get",
+    request: {},
+    response: {
+      status: 200,
+      body: xml(xmlNextLinkFirstPage("PLACEHOLDER_BASE_URL")),
+      headers: {
+        "content-type": "application/xml",
+      },
+    },
+    handler: (req: MockRequest) => {
+      return {
+        status: 200,
+        body: xml(xmlNextLinkFirstPage(req.baseUrl)),
+        headers: {
+          "content-type": "application/xml",
+        },
+      };
+    },
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/payload/pageable/xml/list-with-next-link/nextPage",
+    method: "get",
+    request: {},
+    response: {
+      status: 200,
+      body: xml(XmlNextLinkSecondPage),
+      headers: {
+        "content-type": "application/xml",
+      },
+    },
+    kind: "MockApiDefinition",
+  },
+]);