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

package/specs/encode/numeric/mockapi.ts

@@ -7,9 +7,9 @@ function createTests(uri: string, value: any) {
     uri,
     method: "post",
     request: {
-      body: {
+      body: json({
         value,
-      },
+      }),
     },
     response: {
       status: 200,

package/specs/parameters/basic/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> = {};
 function createServerTests(uri: string) {
@@ -6,9 +6,9 @@ function createServerTests(uri: string) {
     uri,
     method: "put",
     request: {
-      body: {
+      body: json({
         name: "foo",
-      },
+      }),
     },
     response: {
       status: 204,

package/specs/parameters/body-optionality/main.tsp

@@ -33,8 +33,10 @@ op requiredExplicit(@body body: BodyModel): NoContentResponse;
   ```json
   { "name": "foo" }
   ```
+  Expected Content-Type header: application/json
   
   Expected no request body for `omit`
+  Expected Content-Type header: must NOT be present
   """)
 @route("/optional-explicit")
 namespace OptionalExplicit {

package/specs/parameters/body-optionality/mockapi.ts

@@ -1,4 +1,10 @@
-import { MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+import {
+  json,
+  MockRequest,
+  passOnSuccess,
+  ScenarioMockApi,
+  ValidationError,
+} from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 function createServerTests(uri: string, data: any) {
@@ -6,7 +12,7 @@ function createServerTests(uri: string, data: any) {
     uri,
     method: "post",
     request: {
-      body: data,
+      body: json(data),
     },
     response: {
       status: 204,
@@ -27,13 +33,18 @@ Scenarios.Parameters_BodyOptionality_OptionalExplicit = passOnSuccess([
     uri: "/parameters/body-optionality/optional-explicit/set",
     method: "post",
     request: {
-      body: {
+      body: json({
         name: "foo",
-      },
+      }),
     },
     response: {
       status: 204,
     },
+    handler: (req: MockRequest) => {
+      // Validate that Content-Type header is present when body is provided
+      req.expect.containsHeader("content-type", "application/json");
+      return { status: 204 };
+    },
     kind: "MockApiDefinition",
   },
   {
@@ -45,6 +56,15 @@ Scenarios.Parameters_BodyOptionality_OptionalExplicit = passOnSuccess([
     },
     handler: (req: MockRequest) => {
       req.expect.rawBodyEquals(undefined);
+      // Validate that Content-Type header is NOT present when body is omitted
+      const contentTypeHeader = req.headers["content-type"];
+      if (contentTypeHeader !== undefined) {
+        throw new ValidationError(
+          "Content-Type header must NOT be present when body is omitted",
+          undefined,
+          contentTypeHeader,
+        );
+      }
       return { status: 204 };
     },
     kind: "MockApiDefinition",

package/specs/parameters/collection-format/main.tsp

@@ -27,25 +27,9 @@ namespace Query {
     """)
   @route("/ssv")
   op ssv(
-    #suppress "deprecated" "Deprecated in next release"
     @doc("Possible values for colors are [blue,red,green]")
-    @query({
-      format: "ssv",
-    })
-    colors: string[],
-  ): NoContentResponse;
-
-  @scenario
-  @scenarioDoc("""
-    This test is testing sending a tsv collection format array query parameters
-    """)
-  @route("/tsv")
-  op tsv(
-    #suppress "deprecated" "Deprecated in next release"
-    @doc("Possible values for colors are [blue,red,green]")
-    @query({
-      format: "tsv",
-    })
+    @query
+    @encode(ArrayEncoding.spaceDelimited)
     colors: string[],
   ): NoContentResponse;
 
@@ -55,11 +39,9 @@ namespace Query {
     """)
   @route("/pipes")
   op pipes(
-    #suppress "deprecated" "Deprecated in next release"
     @doc("Possible values for colors are [blue,red,green]")
-    @query({
-      format: "pipes",
-    })
+    @query
+    @encode(ArrayEncoding.pipeDelimited)
     colors: string[],
   ): NoContentResponse;
 
@@ -84,9 +66,7 @@ namespace Header {
   @route("/csv")
   op csv(
     @doc("Possible values for colors are [blue,red,green]")
-    @header({
-      format: "csv",
-    })
+    @header
     colors: string[],
   ): NoContentResponse;
 }

package/specs/parameters/collection-format/mockapi.ts

@@ -8,7 +8,7 @@ Scenarios.Parameters_CollectionFormat_Query_multi = passOnSuccess({
   uri: `/parameters/collection-format/query/multi`,
   method: "get",
   request: {
-    params: { colors: ["blue", "red", "green"] },
+    query: { colors: ["blue", "red", "green"] },
   },
   response: {
     status: 204,
@@ -26,7 +26,7 @@ Scenarios.Parameters_CollectionFormat_Query_csv = passOnSuccess({
   uri: `/parameters/collection-format/query/csv`,
   method: "get",
   request: {
-    params: { colors: colors.join(",") },
+    query: { colors: colors.join(",") },
   },
   response: {
     status: 204,
@@ -38,19 +38,7 @@ Scenarios.Parameters_CollectionFormat_Query_ssv = passOnSuccess({
   uri: `/parameters/collection-format/query/ssv`,
   method: "get",
   request: {
-    params: { colors: colors.join(" ") },
-  },
-  response: {
-    status: 204,
-  },
-  kind: "MockApiDefinition",
-});
-
-Scenarios.Parameters_CollectionFormat_Query_tsv = passOnSuccess({
-  uri: `/parameters/collection-format/query/tsv`,
-  method: "get",
-  request: {
-    params: { colors: colors.join("\t") },
+    query: { colors: colors.join(" ") },
   },
   response: {
     status: 204,
@@ -62,7 +50,7 @@ Scenarios.Parameters_CollectionFormat_Query_pipes = passOnSuccess({
   uri: `/parameters/collection-format/query/pipes`,
   method: "get",
   request: {
-    params: { colors: colors.join("|") },
+    query: { colors: colors.join("|") },
   },
   response: {
     status: 204,

package/specs/parameters/path/main.tsp

@@ -0,0 +1,48 @@
+import "@typespec/http";
+import "@typespec/spector";
+
+using Http;
+using Spector;
+
+@doc("Test for path parameters cases.")
+@scenarioService("/parameters/path")
+namespace Parameters.Path;
+
+@scenario
+@scenarioDoc("""
+  Test case for normal path parameter. 
+  
+  Should generate an operation like below:
+  ```
+  normal(name: string)
+  ```
+  
+  Expected request path:
+  ```
+  /normal/foo
+  ```
+  """)
+@route("/normal/{name}")
+op normal(@path name: string): NoContentResponse;
+
+@scenario
+@scenarioDoc("""
+  Test case for optional path parameter. 
+  
+  Should generate an operation like below:
+  ```
+  optional(name?: string)
+  ```
+  
+  Expected two request:
+  First request path:
+  ```
+  /optional
+  ```
+  Second request path:
+  ```
+  /optional/foo
+  ```
+  """)
+@route("/optional{/name}")
+op optional(@path name?: string): NoContentResponse;

package/specs/parameters/path/mockapi.ts

@@ -0,0 +1,34 @@
+import { passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Parameters_Path_normal = passOnSuccess({
+  uri: "/parameters/path/normal/foo",
+  method: "get",
+
+  response: {
+    status: 204,
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Parameters_Path_optional = passOnSuccess([
+  {
+    uri: "/parameters/path/optional",
+    method: "get",
+
+    response: {
+      status: 204,
+    },
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/parameters/path/optional/foo",
+    method: "get",
+
+    response: {
+      status: 204,
+    },
+    kind: "MockApiDefinition",
+  },
+]);

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,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