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

package/specs/parameters/spread/mockapi.ts

@@ -1,4 +1,4 @@
-import { passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+import { json, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
@@ -6,9 +6,9 @@ Scenarios.Parameters_Spread_Model_spreadAsRequestBody = passOnSuccess({
   uri: `/parameters/spread/model/request-body`,
   method: "put",
   request: {
-    body: {
+    body: json({
       name: "foo",
-    },
+    }),
   },
   response: {
     status: 204,
@@ -20,9 +20,9 @@ Scenarios.Parameters_Spread_Model_spreadCompositeRequestOnlyWithBody = passOnSuc
   uri: `/parameters/spread/model/composite-request-only-with-body`,
   method: "put",
   request: {
-    body: {
+    body: json({
       name: "foo",
-    },
+    }),
   },
   response: {
     status: 204,
@@ -48,9 +48,9 @@ Scenarios.Parameters_Spread_Model_spreadCompositeRequest = passOnSuccess({
   uri: `/parameters/spread/model/composite-request/foo`,
   method: "put",
   request: {
-    body: {
+    body: json({
       name: "foo",
-    },
+    }),
     headers: {
       "test-header": "bar",
     },
@@ -65,9 +65,9 @@ Scenarios.Parameters_Spread_Model_spreadCompositeRequestMix = passOnSuccess({
   uri: `/parameters/spread/model/composite-request-mix/foo`,
   method: "put",
   request: {
-    body: {
+    body: json({
       prop: "foo",
-    },
+    }),
     headers: {
       "test-header": "bar",
     },
@@ -82,9 +82,9 @@ Scenarios.Parameters_Spread_Alias_spreadAsRequestBody = passOnSuccess({
   uri: `/parameters/spread/alias/request-body`,
   method: "put",
   request: {
-    body: {
+    body: json({
       name: "foo",
-    },
+    }),
   },
   response: {
     status: 204,
@@ -96,9 +96,9 @@ Scenarios.Parameters_Spread_Alias_spreadAsRequestParameter = passOnSuccess({
   uri: `/parameters/spread/alias/request-parameter/1`,
   method: "put",
   request: {
-    body: {
+    body: json({
       name: "foo",
-    },
+    }),
     headers: {
       "x-ms-test-header": "bar",
     },
@@ -113,12 +113,12 @@ Scenarios.Parameters_Spread_Alias_spreadWithMultipleParameters = passOnSuccess({
   uri: `/parameters/spread/alias/multiple-parameters/1`,
   method: "put",
   request: {
-    body: {
+    body: json({
       requiredString: "foo",
       optionalInt: 1,
       requiredIntList: [1, 2],
       optionalStringList: ["foo", "bar"],
-    },
+    }),
     headers: {
       "x-ms-test-header": "bar",
     },
@@ -133,9 +133,9 @@ Scenarios.Parameters_Spread_Alias_spreadParameterWithInnerModel = passOnSuccess(
   uri: `/parameters/spread/alias/inner-model-parameter/1`,
   method: "post",
   request: {
-    body: {
+    body: json({
       name: "foo",
-    },
+    }),
     headers: {
       "x-ms-test-header": "bar",
     },
@@ -150,10 +150,10 @@ Scenarios.Parameters_Spread_Alias_spreadParameterWithInnerAlias = passOnSuccess(
   uri: `/parameters/spread/alias/inner-alias-parameter/1`,
   method: "post",
   request: {
-    body: {
+    body: json({
       name: "foo",
       age: 1,
-    },
+    }),
     headers: {
       "x-ms-test-header": "bar",
     },

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,18 @@ using Spector;
 namespace Payload.MultiPart;
 
 model MultiPartRequest {
-  id: string;
-  profileImage: bytes;
+  id: HttpPart<string>;
+  profileImage: HttpPart<bytes>;
+}
+
+model MultiPartRequestWithWireName {
+  identifier: HttpPart<string, #{ name: "id" }>;
+  image: HttpPart<bytes, #{ name: "profileImage" }>;
+}
+
+model MultiPartOptionalRequest {
+  id?: HttpPart<string>;
+  profileImage?: HttpPart<bytes>;
 }
 
 model Address {
@@ -52,25 +62,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 +89,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 +116,115 @@ namespace FormData {
   @route("/mixed-parts")
   op basic(
     @header contentType: "multipart/form-data",
-    @body body: MultiPartRequest,
+    @multipartBody body: MultiPartRequest,
+  ): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Expect request with wire names (
+    - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.4, content-type of file part shall be labeled with
+      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, server can't parse them all.
+    ):
+    ```
+    POST /upload HTTP/1.1
+    Content-Length: 428
+    Content-Type: multipart/form-data; boundary=abcde12345
+    
+    --abcde12345
+    Content-Disposition: form-data; name="id"
+    Content-Type: text/plain
+    
+    123
+    --abcde12345
+    Content-Disposition: form-data; name="profileImage"; filename="<any-or-no-name-is-ok>"
+    Content-Type: application/octet-stream;
+    
+    {…file content of .jpg file…}
+    --abcde12345--
+    ```
+    """)
+  @doc("Test content-type: multipart/form-data with wire names")
+  @post
+  @route("/mixed-parts-with-wire-name")
+  op withWireName(
+    @header contentType: "multipart/form-data",
+    @multipartBody body: MultiPartRequestWithWireName,
+  ): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Please send request three times:
+    - First time with only id
+    - Second time with only profileImage
+    - Third time with both id and profileImage
+    
+    Expect requests (
+      - according to https://datatracker.ietf.org/doc/html/rfc7578#section-4.4, content-type of file part shall be labeled with
+        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, server can't parse them all.
+      ):
+    ```
+    POST /upload HTTP/1.1
+    Content-Length: 428
+    Content-Type: multipart/form-data; boundary=abcde12345
+    
+    --abcde12345
+    Content-Disposition: form-data; name="id"
+    Content-Type: text/plain
+    
+    123
+    --abcde12345--
+    ```
+    
+    ```
+    POST /upload HTTP/1.1
+    Content-Length: 428
+    Content-Type: multipart/form-data; boundary=abcde12345
+    
+    --abcde12345
+    Content-Disposition: form-data; name="profileImage"; filename="<any-or-no-name-is-ok>"
+    Content-Type: application/octet-stream
+    
+    {…file content of .jpg file…}
+    --abcde12345--
+    ```
+    
+    ```
+    POST /upload HTTP/1.1
+    Content-Length: 428
+    Content-Type: multipart/form-data; boundary=abcde12345
+    
+    --abcde12345
+    Content-Disposition: form-data; name="id"
+    Content-Type: text/plain
+    
+    123
+    --abcde12345
+    Content-Disposition: form-data; name="profileImage"; filename="<any-or-no-name-is-ok>"
+    Content-Type: application/octet-stream
+    
+    {…file content of .jpg file…}
+    --abcde12345--
+    ```
+    """)
+  @doc("Test content-type: multipart/form-data with optional parts")
+  @post
+  @route("/optional-parts")
+  op optionalParts(
+    @header contentType: "multipart/form-data",
+    @multipartBody body: MultiPartOptionalRequest,
   ): 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 +275,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 +311,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 +350,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 +384,7 @@ namespace FormData {
   @route("/multi-binary-parts")
   op multiBinaryParts(
     @header contentType: "multipart/form-data",
-    @body body: MultiBinaryPartsRequest,
+    @multipartBody body: MultiBinaryPartsRequest,
   ): NoContentResponse;
 
   @scenario
@@ -304,16 +413,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 +442,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 +523,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
@@ -497,4 +608,91 @@ namespace FormData {
       ): NoContentResponse;
     }
   }
+
+  @route("/file")
+  namespace File {
+    model FileWithRequiredFilename extends TypeSpec.Http.File<"image/png"> {
+      filename: string;
+    }
+
+    @scenario
+    @scenarioDoc("""
+      Test File type in multipart form data with specific content type.
+      Expected request:
+      ```
+      POST /multipart/form-data/file/specific-content-type HTTP/1.1
+      Content-Type: multipart/form-data; boundary=abcde12345
+      
+      --abcde12345
+      Content-Disposition: form-data; name="file"; filename="image.png"
+      Content-Type: image/png
+      
+      {…file content of image.png…}
+      --abcde12345--
+      ```
+      """)
+    @post
+    @route("/specific-content-type")
+    op uploadFileSpecificContentType(
+      @header contentType: "multipart/form-data",
+      @multipartBody body: {
+        file: HttpPart<TypeSpec.Http.File<"image/png">>;
+      },
+    ): NoContentResponse;
+
+    @scenario
+    @scenarioDoc("""
+      Test File type in multipart form data with required filename.
+      Expected request:
+      ```
+      POST /multipart/form-data/file/required-filename HTTP/1.1
+      Content-Type: multipart/form-data; boundary=abcde12345
+      
+      --abcde12345
+      Content-Disposition: form-data; name="file"; filename="image.png"
+      Content-Type: image/png
+      
+      {…file content of image.png…}
+      --abcde12345--
+      ```
+      """)
+    @post
+    @route("/required-filename")
+    op uploadFileRequiredFilename(
+      @header contentType: "multipart/form-data",
+      @multipartBody body: {
+        file: HttpPart<FileWithRequiredFilename>;
+      },
+    ): NoContentResponse;
+
+    @scenario
+    @scenarioDoc("""
+      Test multiple File instances in multipart form data.
+      Expected request:
+      ```
+      POST /multipart/form-data/file/file-array HTTP/1.1
+      Content-Type: multipart/form-data; boundary=abcde12345
+      
+      --abcde12345
+      Content-Disposition: form-data; name="files"; filename="image1.png"
+      Content-Type: image/png
+      
+      {…file content of image.png…}
+      --abcde12345
+      Content-Disposition: form-data; name="files"; filename="image2.png"
+      Content-Type: image/png
+      
+      {…file content of image.png…}
+      --abcde12345--
+      ```
+      """)
+    @post
+    @route("/file-array")
+    op uploadFileArray(
+      @header contentType: "multipart/form-data",
+      @multipartBody body: {
+        files: HttpPart<TypeSpec.Http.File<"image/png">>[];
+      },
+    ): NoContentResponse;
+  }
 }