@typespec/http-specs 0.1.0-alpha.9-dev.5 → 0.1.0-dev.0

package/specs/payload/xml/main.tsp

@@ -82,6 +82,50 @@ model ModelWithEncodedNames {
   @encodedName("application/xml", "PossibleColors") colors: string[];
 }
 
+@doc("Status values for the model with enum.")
+union Status {
+  string,
+
+  @doc("Pending status.")
+  pending: "pending",
+
+  @doc("Success status.")
+  success: "success",
+
+  @doc("Error status.")
+  error: "error",
+}
+
+@doc("Contains a single property with an enum value.")
+model ModelWithEnum {
+  status: Status;
+}
+
+@doc("Contains datetime properties with different encodings.")
+model ModelWithDatetime {
+  @encode(DateTimeKnownEncoding.rfc3339)
+  @doc("DateTime value with rfc3339 encoding.")
+  rfc3339: utcDateTime;
+
+  @encode(DateTimeKnownEncoding.rfc7231)
+  @doc("DateTime value with rfc7231 encoding.")
+  rfc7231: utcDateTime;
+}
+
+@doc("An error response body in XML format.")
+@error
+model XmlError {
+  @statusCode _: 400;
+  @header("content-type") contentType: "application/xml";
+  @body body: XmlErrorBody;
+}
+
+@doc("The body of an XML error response.")
+model XmlErrorBody {
+  message: string;
+  code: int32;
+}
+
 @doc("Template for XML operations")
 interface XmlOperations<TModel, TDoc extends valueof string> {
   @scenario
@@ -300,3 +344,48 @@ interface ModelWithEncodedNamesValue
         </ModelWithEncodedNamesSrc>
         """
     > {}
+
+@doc("Operations for the ModelWithEnum type.")
+@route("/modelWithEnum")
+interface ModelWithEnumValue
+  extends XmlOperations<
+      ModelWithEnum,
+      """
+        <ModelWithEnum>
+          <status>success</status>
+        </ModelWithEnum>
+        """
+    > {}
+
+@doc("Operations for the ModelWithDatetime type.")
+@route("/modelWithDatetime")
+interface ModelWithDatetimeValue
+  extends XmlOperations<
+      ModelWithDatetime,
+      """
+        <ModelWithDatetime>
+          <rfc3339>2022-08-26T18:38:00.000Z</rfc3339>
+          <rfc7231>Fri, 26 Aug 2022 14:38:00 GMT</rfc7231>
+        </ModelWithDatetime>
+        """
+    > {}
+
+@doc("Operations that return an error response in XML format.")
+@route("/error")
+interface XmlErrorValue {
+  @scenario
+  @scenarioDoc("""
+    Expected error response body:
+    ```xml
+    <XmlErrorBody>
+      <message>Something went wrong</message>
+      <code>400</code>
+    </XmlErrorBody>
+    ```
+    """)
+  @get
+  get(): {
+    @header("content-type") contentType: "application/xml";
+    @body body: SimpleModel;
+  } | XmlError;
+}

package/specs/payload/xml/mockapi.ts

@@ -1,4 +1,4 @@
-import { MockRequest, passOnSuccess, ScenarioMockApi, xml } from "@typespec/spec-api";
+import { MockRequest, passOnCode, passOnSuccess, ScenarioMockApi, xml } from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
@@ -123,6 +123,19 @@ export const modelWithEncodedNames = `
 </ModelWithEncodedNamesSrc>
 `;
 
+export const modelWithEnum = `
+<ModelWithEnum>
+  <status>success</status>
+</ModelWithEnum>
+`;
+
+export const modelWithDatetime = `
+<ModelWithDatetime>
+  <rfc3339>2022-08-26T18:38:00.000Z</rfc3339>
+  <rfc7231>Fri, 26 Aug 2022 14:38:00 GMT</rfc7231>
+</ModelWithDatetime>
+`;
+
 function createServerTests(uri: string, data?: any) {
   return {
     get: passOnSuccess({
@@ -139,10 +152,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");
@@ -236,3 +246,32 @@ const Payload_Xml_ModelWithEncodedNames = createServerTests(
 );
 Scenarios.Payload_Xml_ModelWithEncodedNamesValue_get = Payload_Xml_ModelWithEncodedNames.get;
 Scenarios.Payload_Xml_ModelWithEncodedNamesValue_put = Payload_Xml_ModelWithEncodedNames.put;
+
+const Payload_Xml_ModelWithEnum = createServerTests("/payload/xml/modelWithEnum", modelWithEnum);
+Scenarios.Payload_Xml_ModelWithEnumValue_get = Payload_Xml_ModelWithEnum.get;
+Scenarios.Payload_Xml_ModelWithEnumValue_put = Payload_Xml_ModelWithEnum.put;
+
+const Payload_Xml_ModelWithDatetime = createServerTests(
+  "/payload/xml/modelWithDatetime",
+  modelWithDatetime,
+);
+Scenarios.Payload_Xml_ModelWithDatetimeValue_get = Payload_Xml_ModelWithDatetime.get;
+Scenarios.Payload_Xml_ModelWithDatetimeValue_put = Payload_Xml_ModelWithDatetime.put;
+
+export const xmlError = `
+<XmlErrorBody>
+  <message>Something went wrong</message>
+  <code>400</code>
+</XmlErrorBody>
+`;
+
+Scenarios.Payload_Xml_XmlErrorValue_get = passOnCode(400, {
+  uri: "/payload/xml/error",
+  method: "get",
+  request: {},
+  response: {
+    status: 400,
+    body: xml(xmlError),
+  },
+  kind: "MockApiDefinition",
+});

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

@@ -26,7 +26,7 @@ namespace Response.StatusCodeRange;
   """)
 @route("/error-response-status-code-in-range")
 @get
-op errorResponseStatusCodeInRange(): 204 | ErrorInRange | DefaultError;
+op errorResponseStatusCodeInRange(): NoContentResponse | ErrorInRange | DefaultError;
 
 @scenario
 @scenarioDoc("""
@@ -44,7 +44,7 @@ op errorResponseStatusCodeInRange(): 204 | ErrorInRange | DefaultError;
   """)
 @route("/error-response-status-code-404")
 @get
-op errorResponseStatusCode404(): 204 | NotFoundError | Standard4XXError;
+op errorResponseStatusCode404(): NoContentResponse | NotFoundError | Standard4XXError;
 
 @error
 model NotFoundError {

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

@@ -1,13 +1,11 @@
-import { json, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+import { json, passOnCode, ScenarioMockApi } from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
-Scenarios.Response_StatusCodeRange_errorResponseStatusCodeInRange = passOnSuccess({
+Scenarios.Response_StatusCodeRange_errorResponseStatusCodeInRange = passOnCode(494, {
   uri: "/response/status-code-range/error-response-status-code-in-range",
   method: "get",
-  request: {
-    status: 494,
-  },
+  request: {},
   response: {
     status: 494,
     body: json({
@@ -18,12 +16,10 @@ Scenarios.Response_StatusCodeRange_errorResponseStatusCodeInRange = passOnSucces
   kind: "MockApiDefinition",
 });
 
-Scenarios.Response_StatusCodeRange_errorResponseStatusCode404 = passOnSuccess({
+Scenarios.Response_StatusCodeRange_errorResponseStatusCode404 = passOnCode(404, {
   uri: "/response/status-code-range/error-response-status-code-404",
   method: "get",
-  request: {
-    status: 404,
-  },
+  request: {},
   response: {
     status: 404,
     body: json({

package/specs/routes/main.tsp

@@ -99,7 +99,7 @@ namespace PathParameters {
             Expected path: /routes/path/simple/standard/arraya,b
         """)
       @route("array{param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -108,7 +108,7 @@ namespace PathParameters {
             Expected path: /routes/path/simple/standard/recorda,1,b,2
         """)
       @route("record{param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -129,7 +129,7 @@ namespace PathParameters {
             Expected path: /routes/path/simple/explode/arraya.b
         """)
       @route("array{param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -138,7 +138,7 @@ namespace PathParameters {
             Expected path: /routes/path/simple/explode/recorda=1,b=2
         """)
       @route("record{param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 
@@ -162,7 +162,7 @@ namespace PathParameters {
             Expected path: /routes/path/path/standard/array/a,b
         """)
       @route("array{/param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -171,7 +171,7 @@ namespace PathParameters {
             Expected path: /routes/path/path/standard/record/a,1,b,2
         """)
       @route("record{/param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -192,7 +192,7 @@ namespace PathParameters {
             Expected path: /routes/path/path/explode/array/a/b
         """)
       @route("array{/param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -201,7 +201,7 @@ namespace PathParameters {
             Expected path: /routes/path/path/explode/record/a=1/b=2
         """)
       @route("record{/param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 
@@ -225,7 +225,7 @@ namespace PathParameters {
             Expected path: /routes/path/label/standard/array.a,b
         """)
       @route("array{.param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -234,7 +234,7 @@ namespace PathParameters {
             Expected path: /routes/path/label/standard/record.a,1,b,2
         """)
       @route("record{.param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -255,7 +255,7 @@ namespace PathParameters {
             Expected path: /routes/path/label/explode/array.a.b
         """)
       @route("array{.param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -264,7 +264,7 @@ namespace PathParameters {
             Expected path: /routes/path/label/explode/record.a=1.b=2
         """)
       @route("record{.param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 
@@ -276,7 +276,7 @@ namespace PathParameters {
       @scenarioDoc("""
         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
         """)
       @route("primitive{;param}")
       op primitive(param: string): void;
@@ -285,19 +285,19 @@ namespace PathParameters {
       @scenarioDoc("""
         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
         """)
       @route("array{;param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
         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
         """)
       @route("record{;param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -306,7 +306,7 @@ namespace PathParameters {
       @scenarioDoc("""
         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
         """)
       @route("primitive{;param*}")
       op primitive(param: string): void;
@@ -315,10 +315,10 @@ namespace PathParameters {
       @scenarioDoc("""
         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
         """)
       @route("array{;param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -327,7 +327,7 @@ namespace PathParameters {
             Expected path: /routes/path/matrix/explode/record;a=1;b=2
         """)
       @route("record{;param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 }
@@ -369,7 +369,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-expansion/standard/array?param=a,b
         """)
       @route("array{?param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -378,7 +378,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-expansion/standard/record?param=a,1,b,2
         """)
       @route("record{?param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -399,7 +399,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-expansion/explode/array?param=a&param=b
         """)
       @route("array{?param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -408,7 +408,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-expansion/explode/record?a=1&b=2
         """)
       @route("record{?param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 
@@ -432,7 +432,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-continuation/standard/array?fixed=true&param=a,b
         """)
       @route("array?fixed=true{&param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -441,7 +441,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-continuation/standard/record?fixed=true&param=a,1,b,2
         """)
       @route("record?fixed=true{&param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -462,7 +462,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-continuation/explode/array?fixed=true&param=a&param=b
         """)
       @route("array?fixed=true{&param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -471,7 +471,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-continuation/explode/record?fixed=true&a=1&b=2
         """)
       @route("record?fixed=true{&param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 }

package/specs/routes/mockapi.ts

@@ -21,7 +21,7 @@ function createTests(uri: string) {
     uri: url.pathname,
     method: "get",
     request: {
-      params: Object.fromEntries(queryMap),
+      query: Object.fromEntries(queryMap),
     },
     response: {
       status: 204,
@@ -70,13 +70,13 @@ Scenarios.Routes_PathParameters_SimpleExpansion_Standard_record = createTests(
   "/routes/path/simple/standard/recorda,1,b,2",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Explode_primitive = createTests(
-  "/routes/path/simple/standard/primitivea",
+  "/routes/path/simple/explode/primitivea",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Explode_array = createTests(
-  "/routes/path/simple/standard/arraya,b",
+  "/routes/path/simple/explode/arraya,b",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Explode_record = createTests(
-  "/routes/path/simple/standard/recorda=1,b=2",
+  "/routes/path/simple/explode/recorda=1,b=2",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Standard_primitive = createTests(
   "/routes/path/path/standard/primitive/a",
@@ -88,13 +88,13 @@ Scenarios.Routes_PathParameters_PathExpansion_Standard_record = createTests(
   "/routes/path/path/standard/record/a,1,b,2",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Explode_primitive = createTests(
-  "/routes/path/path/standard/primitive/a",
+  "/routes/path/path/explode/primitive/a",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Explode_array = createTests(
-  "/routes/path/path/standard/array/a/b",
+  "/routes/path/path/explode/array/a/b",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Explode_record = createTests(
-  "/routes/path/path/standard/record/a=1/b=2",
+  "/routes/path/path/explode/record/a=1/b=2",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Standard_primitive = createTests(
   "/routes/path/label/standard/primitive.a",
@@ -106,31 +106,31 @@ Scenarios.Routes_PathParameters_LabelExpansion_Standard_record = createTests(
   "/routes/path/label/standard/record.a,1,b,2",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Explode_primitive = createTests(
-  "/routes/path/label/standard/primitive.a",
+  "/routes/path/label/explode/primitive.a",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Explode_array = createTests(
-  "/routes/path/label/standard/array.a.b",
+  "/routes/path/label/explode/array.a.b",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Explode_record = createTests(
-  "/routes/path/label/standard/record.a=1.b=2",
+  "/routes/path/label/explode/record.a=1.b=2",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Standard_primitive = createTests(
-  "/routes/path/matrix/standard/primitive;a",
+  "/routes/path/matrix/standard/primitive;param=a",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Standard_array = createTests(
-  "/routes/path/matrix/standard/array;a,b",
+  "/routes/path/matrix/standard/array;param=a,b",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Standard_record = createTests(
-  "/routes/path/matrix/standard/record;a,1,b,2",
+  "/routes/path/matrix/standard/record;param=a,1,b,2",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Explode_primitive = createTests(
-  "/routes/path/matrix/standard/primitive;a",
+  "/routes/path/matrix/explode/primitive;param=a",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Explode_array = createTests(
-  "/routes/path/matrix/standard/array;a;b",
+  "/routes/path/matrix/explode/array;param=a;param=b",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Explode_record = createTests(
-  "/routes/path/matrix/standard/record;a=1;b=2",
+  "/routes/path/matrix/explode/record;a=1;b=2",
 );
 Scenarios.Routes_QueryParameters_templateOnly = createTests("/routes/query/template-only?param=a");
 Scenarios.Routes_QueryParameters_explicit = createTests("/routes/query/explicit?param=a");

package/specs/serialization/encoded-name/json/main.tsp

@@ -4,7 +4,7 @@ import "@typespec/spector";
 using Http;
 using Spector;
 
-@doc("Projection")
+@doc("Encoded names")
 @scenarioService("/serialization/encoded-name/json")
 namespace Serialization.EncodedName.Json;
 

package/specs/serialization/encoded-name/json/mockapi.ts

@@ -5,7 +5,7 @@ export const Scenarios: Record<string, ScenarioMockApi> = {};
 Scenarios.Serialization_EncodedName_Json_Property_send = passOnSuccess({
   uri: "/serialization/encoded-name/json/property",
   method: "post",
-  request: { body: { wireName: true } },
+  request: { body: json({ wireName: true }) },
   response: { status: 204 },
   kind: "MockApiDefinition",
 });

package/specs/server/endpoint/not-defined/main.tsp

@@ -8,9 +8,7 @@ using Spector;
  * Illustrates server doesn't define endpoint. Client should automatically add an endpoint to let user pass in.
  */
 @route("/server/endpoint/not-defined")
-@service({
-  title: "Testserver without any endpoint",
-})
+@service(#{ title: "Testserver without any endpoint" })
 namespace Server.Endpoint.NotDefined;
 
 @scenario

package/specs/server/path/multiple/main.tsp

@@ -4,13 +4,11 @@ import "@typespec/versioning";
 
 using Http;
 using Spector;
-using TypeSpec.Versioning;
-using TypeSpec.Rest;
+using Versioning;
+using Rest;
 
 @versioned(Versions)
-@service({
-  title: "ServerPathMultiple",
-})
+@service(#{ title: "ServerPathMultiple" })
 @server(
   "{endpoint}/server/path/multiple/{apiVersion}",
   "Test server with path parameters.",

package/specs/server/versions/not-versioned/mockapi.ts

@@ -40,7 +40,7 @@ Scenarios.Server_Versions_NotVersioned_withQueryApiVersion = passOnSuccess({
   uri: "/server/versions/not-versioned/with-query-api-version",
   method: "head",
   request: {
-    params: {
+    query: {
       "api-version": "v1.0",
     },
   },

package/specs/server/versions/versioned/main.tsp

@@ -4,7 +4,7 @@ import "@typespec/versioning";
 
 using Http;
 using Spector;
-using TypeSpec.Versioning;
+using Versioning;
 
 /**
  * Illustrates versioned server.

package/specs/server/versions/versioned/mockapi.ts

@@ -31,11 +31,15 @@ Scenarios.Server_Versions_Versioned_withPathApiVersion = createServerTests(
   "/server/versions/versioned/with-path-api-version/2022-12-01-preview",
 );
 
-function createAPIVersionTests(uri: string, requestData: any, serverData: string) {
+function createAPIVersionTests(uri: string, version: string) {
   return passOnSuccess({
     uri,
     method: "head",
-    request: requestData,
+    request: {
+      query: {
+        "api-version": version,
+      },
+    },
     response: {
       status: 200,
     },
@@ -45,20 +49,10 @@ function createAPIVersionTests(uri: string, requestData: any, serverData: string
 
 Scenarios.Server_Versions_Versioned_withQueryOldApiVersion = createAPIVersionTests(
   "/server/versions/versioned/with-query-old-api-version",
-  {
-    params: {
-      "api-version": "2021-01-01-preview",
-    },
-  },
   "2021-01-01-preview",
 );
 
 Scenarios.Server_Versions_Versioned_withQueryApiVersion = createAPIVersionTests(
   "/server/versions/versioned/with-query-api-version",
-  {
-    params: {
-      "api-version": "2022-12-01-preview",
-    },
-  },
   "2022-12-01-preview",
 );

package/specs/special-headers/conditional-request/main.tsp

@@ -4,7 +4,7 @@ import "@typespec/spector";
 
 using Http;
 using Spector;
-using TypeSpec.Versioning;
+using Versioning;
 
 @doc("Illustrates conditional request headers")
 @scenarioService("/special-headers/conditional-request")