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

package/specs/encode/bytes/main.tsp

@@ -59,10 +59,7 @@ namespace Query {
     value=dGVzdA, dGVzdA
     """)
   op base64urlArray(
-    #suppress "deprecated" "Deprecated in next release"
-    @query({
-      format: "csv",
-    })
+    @query
     value: base64urlBytes[],
   ): NoContentResponse;
 }
@@ -216,9 +213,7 @@ namespace Header {
     value=dGVzdA,dGVzdA
     """)
   op base64urlArray(
-    @header({
-      format: "csv",
-    })
+    @header
     value: base64urlBytes[],
   ): NoContentResponse;
 }
@@ -228,9 +223,8 @@ namespace RequestBody {
   @route("/default")
   @scenario
   @scenarioDoc("""
-    Test default encode (base64) for bytes in a json body.
-    Expected body:
-    "dGVzdA==" (base64 encode of test, in JSON string)
+    When content type is not defined and body is `bytes` the payload is a binary stream.
+    Stream should match packages/http-specs/assets/image.png file.
     """)
   @post
   op default(
@@ -241,8 +235,8 @@ namespace RequestBody {
   @route("/octet-stream")
   @scenario
   @scenarioDoc("""
-    When content type is application/octet-stream and body is `bytes` the payload is a binary file.
-    File should match packages/cadl-ranch-specs/assets/image.png
+    When content type is application/octet-stream and body is `bytes` the payload is a binary stream.
+    Stream should match packages/http-specs/assets/image.png file.
     """)
   @post
   op octetStream(
@@ -257,7 +251,7 @@ namespace RequestBody {
   @scenario
   @scenarioDoc("""
     When content type is a custom type(image/png here) and body is `bytes` the payload is a binary file.
-    File should match packages/cadl-ranch-specs/assets/image.png
+    File should match packages/http-specs/assets/image.png.
     """)
   @post
   op customContentType(
@@ -277,6 +271,9 @@ namespace RequestBody {
     """)
   @post
   op base64(
+    @header
+    contentType: "application/json",
+
     @body
     @encode(BytesKnownEncoding.base64)
     value: bytes,
@@ -291,6 +288,9 @@ namespace RequestBody {
     """)
   @post
   op base64url(
+    @header
+    contentType: "application/json",
+
     @body
     @encode(BytesKnownEncoding.base64url)
     value: bytes,
@@ -302,9 +302,8 @@ namespace ResponseBody {
   @route("/default")
   @scenario
   @scenarioDoc("""
-    Test default encode (base64) for bytes in a json body.
-    Expected body:
-    "dGVzdA==" (base64 encode of test, in JSON string)
+    When content type is not defined and body is `bytes` the payload is a binary stream.
+    Stream should match packages/http-specs/assets/image.png file.
     """)
   op default(): {
     @body
@@ -314,8 +313,8 @@ namespace ResponseBody {
   @route("/octet-stream")
   @scenario
   @scenarioDoc("""
-    When content type is application/octet-stream and body is `bytes` the payload is a binary file.
-    File should match packages/cadl-ranch-specs/assets/image.png
+    When content type is application/octet-stream and body is `bytes` the payload is a binary stream.
+    Stream should match packages/http-specs/assets/image.png file.
     """)
   op octetStream(): {
     @header
@@ -329,7 +328,7 @@ namespace ResponseBody {
   @scenario
   @scenarioDoc("""
     When content type is a custom type(image/png here) and body is `bytes` the payload is a binary file.
-    File should match packages/cadl-ranch-specs/assets/image.png
+    File should match packages/http-specs/assets/image.png
     """)
   op customContentType(): {
     @header
@@ -347,6 +346,9 @@ namespace ResponseBody {
     "dGVzdA==" (base64 encode of test, in JSON string)
     """)
   op base64(): {
+    @header
+    contentType: "application/json";
+
     @body
     @encode(BytesKnownEncoding.base64)
     value: bytes;
@@ -359,5 +361,11 @@ namespace ResponseBody {
     Expected body:
     "dGVzdA" (base64url encode of test, in JSON string)
     """)
-  op base64url(): base64urlBytes;
+  op base64url(): {
+    @header
+    contentType: "application/json";
+
+    @body
+    body: base64urlBytes;
+  };
 }

package/specs/encode/bytes/mockapi.ts

@@ -25,7 +25,7 @@ function createQueryServerTests(
     uri,
     method: "get",
     request: {
-      params: data,
+      query: data,
     },
     response: {
       status: 204,
@@ -73,7 +73,7 @@ function createPropertyServerTests(uri: string, data: any, value: any) {
     uri,
     method: "post",
     request: {
-      body: data,
+      body: json(data),
     },
     response: {
       status: 200,
@@ -154,23 +154,23 @@ Scenarios.Encode_Bytes_Header_base64urlArray = createHeaderServerTests(
 function createRequestBodyServerTests(
   uri: string,
   data: any,
-  headersData: any,
-  value: any,
   contentType: string = "application/json",
 ) {
   return passOnSuccess({
     uri,
     method: "post",
     request: {
-      body: data,
-      headers: headersData,
+      body: {
+        contentType: contentType,
+        rawContent: data,
+      },
     },
     response: {
       status: 204,
     },
     handler(req: MockRequest) {
       req.expect.containsHeader("content-type", contentType);
-      req.expect.rawBodyEquals(value);
+      req.expect.rawBodyEquals(data);
       return {
         status: 204,
       };
@@ -180,45 +180,26 @@ function createRequestBodyServerTests(
 }
 Scenarios.Encode_Bytes_RequestBody_default = createRequestBodyServerTests(
   "/encode/bytes/body/request/default",
-  '"dGVzdA=="',
-  {
-    "Content-Type": "application/json",
-  },
-  '"dGVzdA=="',
+  pngFile,
+  "application/octet-stream",
 );
 Scenarios.Encode_Bytes_RequestBody_base64 = createRequestBodyServerTests(
   "/encode/bytes/body/request/base64",
   '"dGVzdA=="',
-  {
-    "Content-Type": "application/json",
-  },
-  '"dGVzdA=="',
 );
 Scenarios.Encode_Bytes_RequestBody_base64url = createRequestBodyServerTests(
   "/encode/bytes/body/request/base64url",
   '"dGVzdA"',
-  {
-    "Content-Type": "application/json",
-  },
-  '"dGVzdA"',
 );
 
 Scenarios.Encode_Bytes_RequestBody_customContentType = createRequestBodyServerTests(
   "/encode/bytes/body/request/custom-content-type",
   pngFile,
-  {
-    "Content-Type": "image/png",
-  },
-  pngFile,
   "image/png",
 );
 Scenarios.Encode_Bytes_RequestBody_octetStream = createRequestBodyServerTests(
   "/encode/bytes/body/request/octet-stream",
   pngFile,
-  {
-    "Content-Type": "application/octet-stream",
-  },
-  pngFile,
   "application/octet-stream",
 );
 function createResponseBodyServerTests(
@@ -255,11 +236,12 @@ function createResponseBodyServerTests(
 }
 Scenarios.Encode_Bytes_ResponseBody_default = createResponseBodyServerTests(
   "/encode/bytes/body/response/default",
-  JSON.stringify("dGVzdA=="),
+  pngFile,
   {
-    "Content-Type": "application/json",
+    "Content-Type": "application/octet-stream",
   },
-  JSON.stringify("dGVzdA=="),
+  pngFile,
+  "application/octet-stream",
 );
 Scenarios.Encode_Bytes_ResponseBody_base64 = createResponseBodyServerTests(
   "/encode/bytes/body/response/base64",

package/specs/encode/datetime/main.tsp

@@ -72,10 +72,7 @@ namespace Query {
     value=1686566864, 1686734256
     """)
   op unixTimestampArray(
-    #suppress "deprecated" "Deprecated in next release"
-    @query({
-      format: "csv",
-    })
+    @query
     value: unixTimestampDatetime[],
   ): NoContentResponse;
 }
@@ -269,9 +266,7 @@ namespace Header {
     value=1686566864,1686734256
     """)
   op unixTimestampArray(
-    @header({
-      format: "csv",
-    })
+    @header
     value: unixTimestampDatetime[],
   ): NoContentResponse;
 }

package/specs/encode/datetime/mockapi.ts

@@ -21,7 +21,7 @@ function createQueryServerTests(
     uri,
     method: "get",
     request: {
-      params: paramData,
+      query: paramData,
     },
     response: {
       status: 204,
@@ -93,7 +93,7 @@ function createPropertyServerTests(
     uri,
     method: "post",
     request: {
-      body: data,
+      body: json(data),
     },
     response: {
       status: 200,

package/specs/encode/duration/main.tsp

@@ -79,10 +79,7 @@ namespace Query {
     Expected query parameter `input=36,47`
     """)
   op int32SecondsArray(
-    #suppress "deprecated" "Deprecated in next release"
-    @query({
-      format: "csv",
-    })
+    @query
     input: Int32Duration[],
   ): NoContentResponse;
 }
@@ -274,9 +271,7 @@ namespace Header {
     Expected header `duration: [P40D,P50D]`
     """)
   op iso8601Array(
-    @header({
-      format: "csv",
-    })
+    @header
     duration: Iso8601Duration[],
   ): NoContentResponse;
 

package/specs/encode/duration/mockapi.ts

@@ -13,7 +13,7 @@ function createBodyServerTests(uri: string, data: any, value: any) {
     uri,
     method: "post",
     request: {
-      body: data,
+      body: json(data),
     },
     response: {
       status: 200,
@@ -75,7 +75,7 @@ function createQueryServerTests(
     uri,
     method: "get",
     request: {
-      params: paramData,
+      query: paramData,
     },
     response: {
       status: 204,

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/mockapi.ts

@@ -1,4 +1,4 @@
-import { MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 function createServerTests(uri: string, data: any) {
@@ -6,7 +6,7 @@ function createServerTests(uri: string, data: any) {
     uri,
     method: "post",
     request: {
-      body: data,
+      body: json(data),
     },
     response: {
       status: 204,
@@ -27,9 +27,9 @@ Scenarios.Parameters_BodyOptionality_OptionalExplicit = passOnSuccess([
     uri: "/parameters/body-optionality/optional-explicit/set",
     method: "post",
     request: {
-      body: {
+      body: json({
         name: "foo",
-      },
+      }),
     },
     response: {
       status: 204,

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