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

package/specs/payload/json-merge-patch/main.tsp

@@ -58,7 +58,7 @@ model InnerModel {
       }
     ],
     "intValue": 1,
-    "floatValue": 1.1,
+    "floatValue": 1.25,
     "innerModel": {
       "name": "InnerMadge",
       "description": "innerDesc"
@@ -85,7 +85,7 @@ model InnerModel {
       }
     ],
     "intValue": 1,
-    "floatValue": 1.1,
+    "floatValue": 1.25,
     "innerModel": {
       "name": "InnerMadge",
       "description": "innerDesc"

package/specs/payload/json-merge-patch/mockapi.ts

@@ -18,7 +18,7 @@ export const expectedCreateBody = {
     },
   ],
   intValue: 1,
-  floatValue: 1.1,
+  floatValue: 1.25,
   innerModel: {
     name: "InnerMadge",
     description: "innerDesc",
@@ -45,7 +45,7 @@ Scenarios.Payload_JsonMergePatch_createResource = passOnSuccess({
   uri: "/json-merge-patch/create/resource",
   method: "put",
   request: {
-    body: expectedCreateBody,
+    body: json(expectedCreateBody),
   },
   response: {
     status: 200,
@@ -58,7 +58,7 @@ Scenarios.Payload_JsonMergePatch_updateResource = passOnSuccess({
   uri: "/json-merge-patch/update/resource",
   method: "patch",
   request: {
-    body: expectedUpdateBody,
+    body: json(expectedUpdateBody),
   },
   response: {
     status: 200,
@@ -78,7 +78,7 @@ Scenarios.Payload_JsonMergePatch_updateOptionalResource = passOnSuccess({
   uri: "/json-merge-patch/update/resource/optional",
   method: "patch",
   request: {
-    body: expectedUpdateBody,
+    body: json(expectedUpdateBody),
   },
   response: {
     status: 200,

package/specs/payload/media-type/mockapi.ts

@@ -6,7 +6,7 @@ Scenarios.Payload_MediaType_StringBody_sendAsText = passOnSuccess({
   uri: "/payload/media-type/string-body/sendAsText",
   method: "post",
   request: {
-    body: "{cat}",
+    body: json("{cat}"),
     headers: {
       "Content-Type": "text/plain",
     },
@@ -36,7 +36,7 @@ Scenarios.Payload_MediaType_StringBody_sendAsJson = passOnSuccess({
   uri: "/payload/media-type/string-body/sendAsJson",
   method: "post",
   request: {
-    body: "foo",
+    body: json("foo"),
     headers: {
       "Content-Type": "application/json",
     },

package/specs/payload/multipart/main.tsp

@@ -9,8 +9,8 @@ using Spector;
 namespace Payload.MultiPart;
 
 model MultiPartRequest {
-  id: string;
-  profileImage: bytes;
+  id: HttpPart<string>;
+  profileImage: HttpPart<bytes>;
 }
 
 model Address {
@@ -52,25 +52,25 @@ model ComplexHttpPartsModelRequest {
 }
 
 model ComplexPartsRequest {
-  id: string;
-  address: Address;
-  profileImage: bytes;
-  pictures: bytes[];
+  id: HttpPart<string>;
+  address: HttpPart<Address>;
+  profileImage: HttpPart<bytes>;
+  pictures: HttpPart<bytes>[];
 }
 
 model JsonPartRequest {
-  address: Address;
-  profileImage: bytes;
+  address: HttpPart<Address>;
+  profileImage: HttpPart<bytes>;
 }
 
 model BinaryArrayPartsRequest {
-  id: string;
-  pictures: bytes[];
+  id: HttpPart<string>;
+  pictures: HttpPart<bytes>[];
 }
 
 model MultiBinaryPartsRequest {
-  profileImage: bytes;
-  picture?: bytes;
+  profileImage: HttpPart<bytes>;
+  picture?: HttpPart<bytes>;
 }
 
 @route("/form-data")
@@ -79,9 +79,9 @@ namespace FormData {
   @scenarioDoc("""
     Expect request (
     - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.4, content-type of file part shall be labeled with
-      appropriate media type, cadl-ranch will check it; content-type of other parts is optional, cadl-ranch will ignore it.
+      appropriate media type, server will check it; content-type of other parts is optional, server will ignore it.
     - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.2, filename of file part SHOULD be supplied.
-      If there are duplicated filename in same fieldName, cadl-ranch can't parse them all.
+      If there are duplicated filename in same fieldName, server can't parse them all.
     ):
     ```
     POST /upload HTTP/1.1
@@ -106,16 +106,16 @@ namespace FormData {
   @route("/mixed-parts")
   op basic(
     @header contentType: "multipart/form-data",
-    @body body: MultiPartRequest,
+    @multipartBody body: MultiPartRequest,
   ): NoContentResponse;
 
   @scenario
   @scenarioDoc("""
     Expect request (
       - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.4, content-type of file part shall be labeled with
-        appropriate media type, cadl-ranch will check it; content-type of other parts is optional, cadl-ranch will ignore it.
+        appropriate media type, server will check it; content-type of other parts is optional, server will ignore it.
       - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.2, filename of file part SHOULD be supplied.
-        If there are duplicated filename in same fieldName, cadl-ranch can't parse them all.
+        If there are duplicated filename in same fieldName, server can't parse them all.
       ):
     ```
     POST /upload HTTP/1.1
@@ -166,16 +166,16 @@ namespace FormData {
   @route("/complex-parts")
   op fileArrayAndBasic(
     @header contentType: "multipart/form-data",
-    @body body: ComplexPartsRequest,
+    @multipartBody body: ComplexPartsRequest,
   ): NoContentResponse;
 
   @scenario
   @scenarioDoc("""
     Expect request (
       - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.4, content-type of file part shall be labeled with
-        appropriate media type, cadl-ranch will check it; content-type of other parts is optional, cadl-ranch will ignore it.
+        appropriate media type, server will check it; content-type of other parts is optional, server will ignore it.
       - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.2, filename of file part SHOULD be supplied.
-        If there are duplicated filename in same fieldName, cadl-ranch can't parse them all.
+        If there are duplicated filename in same fieldName, server can't parse them all.
       ):
     ```
     POST /upload HTTP/1.1
@@ -202,16 +202,16 @@ namespace FormData {
   @route("/json-part")
   op jsonPart(
     @header contentType: "multipart/form-data",
-    @body body: JsonPartRequest,
+    @multipartBody body: JsonPartRequest,
   ): NoContentResponse;
 
   @scenario
   @scenarioDoc("""
     Expect request (
       - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.4, content-type of file part shall be labeled with
-        appropriate media type, cadl-ranch will check it; content-type of other parts is optional, cadl-ranch will ignore it.
+        appropriate media type, server will check it; content-type of other parts is optional, server will ignore it.
       - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.2, filename of file part SHOULD be supplied.
-        If there are duplicated filename in same fieldName, cadl-ranch can't parse them all.
+        If there are duplicated filename in same fieldName, server can't parse them all.
       ):
     ```
     POST /upload HTTP/1.1
@@ -241,16 +241,16 @@ namespace FormData {
   @route("/binary-array-parts")
   op binaryArrayParts(
     @header contentType: "multipart/form-data",
-    @body body: BinaryArrayPartsRequest,
+    @multipartBody body: BinaryArrayPartsRequest,
   ): NoContentResponse;
 
   @scenario
   @scenarioDoc("""
     Please send request twice, first time with only profileImage, second time with both profileImage and picture(
       - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.4, content-type of file part shall be labeled with
-        appropriate media type, cadl-ranch will check it; content-type of other parts is optional, cadl-ranch will ignore it.
+        appropriate media type, server will check it; content-type of other parts is optional, server will ignore it.
       - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.2, filename of file part SHOULD be supplied.
-        If there are duplicated filename in same fieldName, cadl-ranch can't parse them all.
+        If there are duplicated filename in same fieldName, server can't parse them all.
       ):
     ```
     POST /upload HTTP/1.1
@@ -275,7 +275,7 @@ namespace FormData {
   @route("/multi-binary-parts")
   op multiBinaryParts(
     @header contentType: "multipart/form-data",
-    @body body: MultiBinaryPartsRequest,
+    @multipartBody body: MultiBinaryPartsRequest,
   ): NoContentResponse;
 
   @scenario
@@ -304,16 +304,16 @@ namespace FormData {
   @route("/check-filename-and-content-type")
   op checkFileNameAndContentType(
     @header contentType: "multipart/form-data",
-    @body body: MultiPartRequest,
+    @multipartBody body: MultiPartRequest,
   ): NoContentResponse;
 
   @scenario
   @scenarioDoc("""
     Expect request (
     - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.4, content-type of file part shall be labeled with 
-      appropriate media type, cadl-ranch will check it; content-type of other parts is optional, cadl-ranch will ignore it.
+      appropriate media type, server will check it; content-type of other parts is optional, server will ignore it.
     - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.2, filename of file part SHOULD be supplied.
-      If there are duplicated filename in same filedName, cadl-ranch can't parse them all.
+      If there are duplicated filename in same filedName, server can't parse them all.
     ):
     ```
     POST /multipart/form-data/anonymous-model HTTP/1.1
@@ -333,7 +333,9 @@ namespace FormData {
   @route("/anonymous-model")
   op anonymousModel(
     @header contentType: "multipart/form-data",
-    profileImage: MultiPartRequest.profileImage,
+    @multipartBody body: {
+      profileImage: HttpPart<bytes>;
+    },
   ): NoContentResponse;
 
   namespace HttpParts {
@@ -412,7 +414,7 @@ namespace FormData {
     }
     @scenario
     @scenarioDoc("""
-      For File part, filename will not be checked but it is necessary otherwise cadl-ranch can't parse it;
+      For File part, filename will not be checked but it is necessary otherwise server can't parse it;
       content-type will be checked with value "application/octet-stream". Expect request:
       ```
       POST /upload HTTP/1.1

package/specs/payload/multipart/mockapi.ts

@@ -1,5 +1,6 @@
 import {
   MockRequest,
+  multipart,
   passOnSuccess,
   ScenarioMockApi,
   ValidationError,
@@ -29,7 +30,7 @@ function checkFile(
   fileName: string | undefined = undefined,
   mustCheckContentType: boolean = true,
 ) {
-  // cadl-ranch depends on multer, which sets the mimetype to "text/plain" if this part has no content-type header
+  // server depends on multer, which sets the mimetype to "text/plain" if this part has no content-type header
   if (mustCheckContentType || file.mimetype !== "text/plain") {
     req.expect.deepEqual(file.mimetype, contentType);
   }
@@ -185,11 +186,7 @@ Scenarios.Payload_MultiPart_FormData_basic = passOnSuccess({
   uri: "/multipart/form-data/mixed-parts",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123 },
-    files: [files[0]],
+    body: multipart({ parts: { id: 123 }, files: [files[0]] }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkProfileImage]),
@@ -199,11 +196,10 @@ Scenarios.Payload_MultiPart_FormData_fileArrayAndBasic = passOnSuccess({
   uri: "/multipart/form-data/complex-parts",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123, address: { city: "X" } },
-    files: [files[0], files[1], files[1]],
+    body: multipart({
+      parts: { id: 123, address: { city: "X" } },
+      files: [files[0], files[1], files[1]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkAddress, checkAllFiles]),
@@ -213,11 +209,7 @@ Scenarios.Payload_MultiPart_FormData_jsonPart = passOnSuccess({
   uri: "/multipart/form-data/json-part",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { address: { city: "X" } },
-    files: [files[0]],
+    body: multipart({ parts: { address: { city: "X" } }, files: [files[0]] }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkAddress, checkProfileImage]),
@@ -227,11 +219,7 @@ Scenarios.Payload_MultiPart_FormData_binaryArrayParts = passOnSuccess({
   uri: "/multipart/form-data/binary-array-parts",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123 },
-    files: [files[1], files[1]],
+    body: multipart({ parts: { id: 123 }, files: [files[1], files[1]] }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkPictures]),
@@ -245,10 +233,9 @@ Scenarios.Payload_MultiPart_FormData_multiBinaryParts = withServiceKeys([
     uri: "/multipart/form-data/multi-binary-parts",
     method: "post",
     request: {
-      headers: {
-        "Content-Type": "multipart/form-data",
-      },
-      files: [files[0]],
+      body: multipart({
+        files: [files[0]],
+      }),
     },
     response: { status: 204 },
     handler: createMultiBinaryPartsHandler,
@@ -258,10 +245,9 @@ Scenarios.Payload_MultiPart_FormData_multiBinaryParts = withServiceKeys([
     uri: "/multipart/form-data/multi-binary-parts",
     method: "post",
     request: {
-      headers: {
-        "Content-Type": "multipart/form-data",
-      },
-      files: [files[0], { ...files[1], fieldname: "picture" }],
+      body: multipart({
+        files: [files[0], { ...files[1], fieldname: "picture" }],
+      }),
     },
     response: { status: 204 },
     handler: createMultiBinaryPartsHandler,
@@ -272,11 +258,10 @@ Scenarios.Payload_MultiPart_FormData_checkFileNameAndContentType = passOnSuccess
   uri: "/multipart/form-data/check-filename-and-content-type",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123 },
-    files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    body: multipart({
+      parts: { id: 123 },
+      files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkFileNameAndContentType]),
@@ -286,10 +271,9 @@ Scenarios.Payload_MultiPart_FormData_anonymousModel = passOnSuccess({
   uri: "/multipart/form-data/anonymous-model",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [files[0]],
+    body: multipart({
+      files: [files[0]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkProfileImage]),
@@ -299,10 +283,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_ContentType_imageJpegContentType
   uri: "/multipart/form-data/check-filename-and-specific-content-type-with-httppart",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    body: multipart({
+      files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkFileNameAndContentType]),
@@ -312,10 +295,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_ContentType_requiredContentType =
   uri: "/multipart/form-data/check-filename-and-required-content-type-with-httppart",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [files[0]],
+    body: multipart({
+      files: [files[0]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkProfileImage]),
@@ -325,10 +307,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_ContentType_optionalContentType =
   uri: "/multipart/form-data/file-with-http-part-optional-content-type",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [files[0]],
+    body: multipart({
+      files: [files[0]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkOptionalContentType]),
@@ -338,11 +319,14 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_jsonArrayAndFileArray = passOnSuc
   uri: "/multipart/form-data/complex-parts-with-httppart",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123, address: { city: "X" }, previousAddresses: [{ city: "Y" }, { city: "Z" }] },
-    files: [files[0], files[1], files[1]],
+    body: multipart({
+      parts: {
+        id: 123,
+        address: { city: "X" },
+        previousAddresses: [{ city: "Y" }, { city: "Z" }],
+      },
+      files: [files[0], files[1], files[1]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) =>
@@ -353,10 +337,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_NonString_float = passOnSuccess({
   uri: "/multipart/form-data/non-string-float",
   method: "post",
   request: {
-    body: { temperature: 0.5 },
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
+    body: multipart({
+      parts: { temperature: 0.5 },
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkFloat]),