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

package/specs/special-words/mockapi.ts

@@ -1,4 +1,4 @@
-import { passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
@@ -6,9 +6,46 @@ Scenarios.SpecialWords_ModelProperties_sameAsModel = passOnSuccess({
   uri: "/special-words/model-properties/same-as-model",
   method: "post",
   request: {
-    body: {
+    body: json({
       SameAsModel: "ok",
-    },
+    }),
+  },
+  response: {
+    status: 204,
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.SpecialWords_ModelProperties_dictMethods = passOnSuccess({
+  uri: "/special-words/model-properties/dict-methods",
+  method: "post",
+  request: {
+    body: json({
+      keys: "ok",
+      items: "ok",
+      values: "ok",
+      popitem: "ok",
+      clear: "ok",
+      update: "ok",
+      setdefault: "ok",
+      pop: "ok",
+      get: "ok",
+      copy: "ok",
+    }),
+  },
+  response: {
+    status: 204,
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.SpecialWords_ModelProperties_withList = passOnSuccess({
+  uri: "/special-words/model-properties/list",
+  method: "post",
+  request: {
+    body: json({
+      list: "ok",
+    }),
   },
   response: {
     status: 204,
@@ -21,9 +58,9 @@ function createModelsTests(uri: string) {
     uri,
     method: "post",
     request: {
-      body: {
+      body: json({
         name: "ok",
-      },
+      }),
     },
     response: {
       status: 204,
@@ -134,7 +171,7 @@ function createParametersTests(uri: string, data: any, paramName: string) {
     uri,
     method: "get",
     request: {
-      params: data,
+      query: data,
     },
     response: {
       status: 204,
@@ -382,3 +419,22 @@ Scenarios.SpecialWords_Parameters_cancellationToken = createParametersTests(
   },
   "cancellationToken",
 );
+
+Scenarios.SpecialWords_ExtensibleStrings_putExtensibleStringValue = passOnSuccess({
+  uri: `/special-words/extensible-strings/string`,
+  method: "put",
+  request: {
+    body: json("class"),
+  },
+  response: {
+    status: 200,
+    body: json("class"),
+  },
+  handler: (req: MockRequest) => {
+    return {
+      status: 200,
+      body: json(req.body),
+    };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/streaming/jsonl/main.tsp

@@ -0,0 +1,33 @@
+import "@typespec/http";
+import "@typespec/http/streams";
+import "@typespec/spector";
+
+using Http;
+using Http.Streams;
+using Spector;
+
+@doc("Test of jsonl streaming.")
+@scenarioService("/streaming/jsonl")
+namespace Streaming.Jsonl;
+
+@route("basic")
+namespace Basic {
+  @scenario
+  @scenarioDoc("""
+    Basic jsonl streaming for request.
+    """)
+  @route("send")
+  @post
+  op send(stream: JsonlStream<Info>): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Basic jsonl streaming for response.
+    """)
+  @route("receive")
+  op receive(): JsonlStream<Info>;
+
+  model Info {
+    desc: string;
+  }
+}

package/specs/streaming/jsonl/mockapi.ts

@@ -0,0 +1,32 @@
+import { passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Streaming_Jsonl_Basic_send = passOnSuccess({
+  uri: "/streaming/jsonl/basic/send",
+  method: "post",
+  request: {
+    body: {
+      rawContent: Buffer.from('{"desc": "one"}\n{"desc": "two"}\n{"desc": "three"}'),
+      contentType: "application/jsonl",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Streaming_Jsonl_Basic_receive = passOnSuccess({
+  uri: "/streaming/jsonl/basic/receive",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: {
+      rawContent: Buffer.from('{"desc": "one"}\n{"desc": "two"}\n{"desc": "three"}'),
+      contentType: "application/jsonl",
+    },
+  },
+  kind: "MockApiDefinition",
+});

package/specs/type/array/mockapi.ts

@@ -18,7 +18,7 @@ function createServerTests(uri: string, data: any) {
       uri,
       method: "put",
       request: {
-        body: data,
+        body: json(data),
       },
       response: {
         status: 204,

package/specs/type/dictionary/mockapi.ts

@@ -18,7 +18,7 @@ function createServerTests(uri: string, data: any) {
       uri,
       method: "put",
       request: {
-        body: data,
+        body: json(data),
       },
       response: {
         status: 204,

package/specs/type/enum/extensible/main.tsp

@@ -40,6 +40,9 @@ interface String {
   @get
   @route("/known-value")
   getKnownValue(): {
+    @header
+    contentType: "application/json";
+
     @body body: DaysOfWeekExtensibleEnum;
   };
 
@@ -48,6 +51,9 @@ interface String {
   @get
   @route("/unknown-value")
   getUnknownValue(): {
+    @header
+    contentType: "application/json";
+
     @body body: DaysOfWeekExtensibleEnum;
   };
 
@@ -55,11 +61,21 @@ interface String {
   @scenarioDoc("Expect to send a known value. Mock api expect to receive 'Monday'")
   @put
   @route("/known-value")
-  putKnownValue(@body body: DaysOfWeekExtensibleEnum): void;
+  putKnownValue(
+    @header
+    contentType: "application/json",
+
+    @body body: DaysOfWeekExtensibleEnum,
+  ): void;
 
   @scenario
   @scenarioDoc("Expect to handle an unknown value. Mock api expect to receive 'Weekend'")
   @put
   @route("/unknown-value")
-  putUnknownValue(@body body: DaysOfWeekExtensibleEnum): void;
+  putUnknownValue(
+    @header
+    contentType: "application/json",
+
+    @body body: DaysOfWeekExtensibleEnum,
+  ): void;
 }

package/specs/type/enum/extensible/mockapi.ts

@@ -18,7 +18,7 @@ function createMockServerTests(uri: string, data: any) {
       uri,
       method: "put",
       request: {
-        body: data,
+        body: json(data),
         headers: {
           "Content-Type": "text/plain",
         },

package/specs/type/enum/fixed/main.tsp

@@ -40,7 +40,13 @@ interface String {
   @get
   @route("/known-value")
   @doc("getKnownValue")
-  getKnownValue(): DaysOfWeekEnum;
+  getKnownValue(): {
+    @header
+    contentType: "application/json";
+
+    @body
+    body: DaysOfWeekEnum;
+  };
 
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing"
   @scenario
@@ -48,7 +54,10 @@ interface String {
   @put
   @route("/known-value")
   @doc("putKnownValue")
-  putKnownValue(@body @doc("_") body: DaysOfWeekEnum): void;
+  putKnownValue(
+    @header contentType: "application/json",
+    @body @doc("_") body: DaysOfWeekEnum,
+  ): void;
 
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing"
   @scenario
@@ -56,5 +65,8 @@ interface String {
   @put
   @route("/unknown-value")
   @doc("putUnknownValue")
-  putUnknownValue(@body @doc("_") body: DaysOfWeekEnum): void;
+  putUnknownValue(
+    @header contentType: "application/json",
+    @body @doc("_") body: DaysOfWeekEnum,
+  ): void;
 }

package/specs/type/enum/fixed/mockapi.ts

@@ -16,7 +16,7 @@ Scenarios.Type_Enum_Fixed_String_putKnownValue = passOnSuccess({
   uri: "/type/enum/fixed/string/known-value",
   method: "put",
   request: {
-    body: "Monday",
+    body: json("Monday"),
     headers: {
       "Content-Type": "application/json",
     },
@@ -31,7 +31,7 @@ Scenarios.Type_Enum_Fixed_String_putUnknownValue = passOnCode(500, {
   uri: "/type/enum/fixed/string/unknown-value",
   method: "put",
   request: {
-    body: "Weekend",
+    body: json("Weekend"),
     headers: {
       "Content-Type": "application/json",
     },

package/specs/type/file/main.tsp

@@ -0,0 +1,109 @@
+import "@typespec/http";
+import "@typespec/spector";
+
+using Http;
+using Spector;
+
+@doc("Test for File type usage in request and response bodies")
+@scenarioService("/type/file")
+namespace Type.File;
+
+/**
+ * Test File as request and response body with specific content type
+ */
+@route("/body")
+namespace Body {
+  @scenario
+  @scenarioDoc("""
+    Test File type as request body with specific content type.
+    Expected request:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @post
+  @route("/request/specific-content-type")
+  op uploadFileSpecificContentType(@bodyRoot file: Http.File<"image/png">): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as request body with JSON content type.
+    Expected request:
+    - Content-Type header: application/json
+    - Body: JSON content with file data
+    """)
+  @post
+  @route("/request/json-content-type")
+  op uploadFileJsonContentType(@bodyRoot file: Http.File<"application/json">): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as response body with JSON content type.
+    Expected response:
+    - Content-Type header: application/json
+    - Body: JSON content with file data
+    """)
+  @get
+  @route("/response/json-content-type")
+  op downloadFileJsonContentType(): Http.File<"application/json">;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as response body with specific content type.
+    Expected response:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @get
+  @route("/response/specific-content-type")
+  op downloadFileSpecificContentType(): Http.File<"image/png">;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as request body with multiple allowed content types (image/png or image/jpeg).
+    Client should send image/png.
+    Expected request:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @post
+  @route("/request/multiple-content-types")
+  op uploadFileMultipleContentTypes(
+    @bodyRoot file: Http.File<"image/png" | "image/jpeg">,
+  ): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as response body with multiple allowed content types.
+    Service will return image/png.
+    Expected response:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @get
+  @route("/response/multiple-content-types")
+  op downloadFileMultipleContentTypes(): Http.File<"image/png" | "image/jpeg">;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as request body with unspecified content type.
+    The File type accepts any content type. For testing, sender will use image/png.
+    Expected request:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @post
+  @route("/request/default-content-type")
+  op uploadFileDefaultContentType(@bodyRoot file: Http.File): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as response body with unspecified content type.
+    The File type accepts any content type. For testing, server will return image/png.
+    Expected response:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @get
+  @route("/response/default-content-type")
+  op downloadFileDefaultContentType(): Http.File;
+}

package/specs/type/file/mockapi.ts

@@ -0,0 +1,200 @@
+import { MockRequest, passOnSuccess, ScenarioMockApi, ValidationError } from "@typespec/spec-api";
+import { pngFile } from "../../helper.js";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+// Helper function to check file content
+function checkFileContent(req: MockRequest, expectedFile: Buffer) {
+  req.expect.rawBodyEquals(expectedFile);
+}
+
+// Body tests - Request with specific content type
+Scenarios.Type_File_Body_uploadFileSpecificContentType = passOnSuccess({
+  uri: "/type/file/body/request/specific-content-type",
+  method: "post",
+  request: {
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    req.expect.containsHeader("content-type", "image/png");
+    checkFileContent(req, pngFile);
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Request with JSON content type
+Scenarios.Type_File_Body_uploadFileJsonContentType = passOnSuccess({
+  uri: "/type/file/body/request/json-content-type",
+  method: "post",
+  request: {
+    body: {
+      contentType: "application/json",
+      rawContent: JSON.stringify({ message: "test file content" }),
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    req.expect.containsHeader("content-type", "application/json");
+    req.expect.rawBodyEquals(JSON.stringify({ message: "test file content" }));
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Response with JSON content type
+Scenarios.Type_File_Body_downloadFileJsonContentType = passOnSuccess({
+  uri: "/type/file/body/response/json-content-type",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: {
+      contentType: "application/json",
+      rawContent: JSON.stringify({ message: "test file content" }),
+    },
+  },
+  handler(req: MockRequest) {
+    return {
+      status: 200,
+      body: {
+        contentType: "application/json",
+        rawContent: JSON.stringify({ message: "test file content" }),
+      },
+    };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Response with specific content type
+Scenarios.Type_File_Body_downloadFileSpecificContentType = passOnSuccess({
+  uri: "/type/file/body/response/specific-content-type",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  handler(req: MockRequest) {
+    return {
+      status: 200,
+      body: {
+        contentType: "image/png",
+        rawContent: pngFile,
+      },
+    };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Request with multiple content types
+Scenarios.Type_File_Body_uploadFileMultipleContentTypes = passOnSuccess({
+  uri: "/type/file/body/request/multiple-content-types",
+  method: "post",
+  request: {
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    // Client should send image/png (one of the allowed types)
+    const contentType = req.headers["content-type"];
+    if (contentType !== "image/png" && contentType !== "image/jpeg") {
+      throw new ValidationError(
+        "Expected content-type to be image/png or image/jpeg",
+        "image/png or image/jpeg",
+        contentType,
+      );
+    }
+    checkFileContent(req, pngFile);
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Response with multiple content types
+Scenarios.Type_File_Body_downloadFileMultipleContentTypes = passOnSuccess({
+  uri: "/type/file/body/response/multiple-content-types",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  handler(req: MockRequest) {
+    // Server returns image/png (one of the allowed types)
+    return {
+      status: 200,
+      body: {
+        contentType: "image/png",
+        rawContent: pngFile,
+      },
+    };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Request with default content type
+Scenarios.Type_File_Body_uploadFileDefaultContentType = passOnSuccess({
+  uri: "/type/file/body/request/default-content-type",
+  method: "post",
+  request: {
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    // File type accepts any content type, but for testing we expect image/png
+    req.expect.containsHeader("content-type", "image/png");
+    checkFileContent(req, pngFile);
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Response with default content type
+Scenarios.Type_File_Body_downloadFileDefaultContentType = passOnSuccess({
+  uri: "/type/file/body/response/default-content-type",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  handler(req: MockRequest) {
+    // File type accepts any content type, but for testing we return image/png
+    return {
+      status: 200,
+      body: {
+        contentType: "image/png",
+        rawContent: pngFile,
+      },
+    };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/type/model/empty/mockapi.ts

@@ -8,7 +8,7 @@ Scenarios.Type_Model_Empty_putEmpty = passOnSuccess({
   uri: "/type/model/empty/alone",
   method: "put",
   request: {
-    body: body,
+    body: json(body),
   },
   response: {
     status: 204,
@@ -30,7 +30,7 @@ Scenarios.Type_Model_Empty_postRoundTripEmpty = passOnSuccess({
   uri: "/type/model/empty/round-trip",
   method: "post",
   request: {
-    body: body,
+    body: json(body),
   },
   response: {
     status: 200,

package/specs/type/model/inheritance/enum-discriminator/mockapi.ts

@@ -39,7 +39,7 @@ function createGetPutServerTests(uri: string, data: any) {
       uri: uri,
       method: "put",
       request: {
-        body: data,
+        body: json(data),
       },
       response: {
         status: 204,

package/specs/type/model/inheritance/nested-discriminator/mockapi.ts

@@ -78,7 +78,7 @@ Scenarios.Type_Model_Inheritance_NestedDiscriminator_putModel = passOnSuccess({
   uri: "/type/model/inheritance/nested-discriminator/model",
   method: "put",
   request: {
-    body: validPolymorphicBody,
+    body: json(validPolymorphicBody),
   },
   response: {
     status: 204,
@@ -100,7 +100,7 @@ Scenarios.Type_Model_Inheritance_NestedDiscriminator_putRecursiveModel = passOnS
   uri: "/type/model/inheritance/nested-discriminator/recursivemodel",
   method: "put",
   request: {
-    body: validRecursiveBody,
+    body: json(validRecursiveBody),
   },
   response: {
     status: 204,

package/specs/type/model/inheritance/not-discriminated/mockapi.ts

@@ -8,7 +8,7 @@ Scenarios.Type_Model_Inheritance_NotDiscriminated_postValid = passOnSuccess({
   uri: "/type/model/inheritance/not-discriminated/valid",
   method: "post",
   request: {
-    body: inheritanceValidBody,
+    body: json(inheritanceValidBody),
   },
   response: {
     status: 204,
@@ -29,7 +29,7 @@ Scenarios.Type_Model_Inheritance_NotDiscriminated_putValid = passOnSuccess({
   uri: "/type/model/inheritance/not-discriminated/valid",
   method: "put",
   request: {
-    body: inheritanceValidBody,
+    body: json(inheritanceValidBody),
   },
   response: {
     status: 200,

package/specs/type/model/inheritance/recursive/mockapi.ts

@@ -22,7 +22,7 @@ Scenarios.Type_Model_Inheritance_Recursive_put = passOnSuccess({
   uri: "/type/model/inheritance/recursive",
   method: "put",
   request: {
-    body: body,
+    body: json(body),
   },
   response: {
     status: 204,