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

package/specs/type/property/additional-properties/main.tsp

@@ -463,11 +463,11 @@ interface SpreadRecordUnion
     > {}
 
 // ****************** spread record of discriminated unions **************************
-@discriminator("kind")
-union WidgetData {
-  kind0: WidgetData0,
-  kind1: WidgetData1,
-}
+// @discriminated(#{ envelope: "none" })
+// union WidgetData {
+//   kind0: WidgetData0,
+//   kind1: WidgetData1,
+// }
 
 model WidgetData0 {
   kind: "kind0";
@@ -485,20 +485,20 @@ model WidgetData2 {
   start: string;
 }
 
-@doc("The model spread Record<WidgetData>")
-model SpreadRecordForDiscriminatedUnion {
-  @doc("The name property")
-  name: string;
+// @doc("The model spread Record<WidgetData>")
+// model SpreadRecordForDiscriminatedUnion {
+//   @doc("The name property")
+//   name: string;
 
-  ...Record<WidgetData>;
-}
+//   ...Record<WidgetData>;
+// }
 
-@route("/spreadRecordDiscriminatedUnion")
-interface SpreadRecordDiscriminatedUnion
-  extends ModelOperations<
-      SpreadRecordForDiscriminatedUnion,
-      "{'name': 'abc', 'prop1': {'kind': 'kind0', 'fooProp': 'abc'}, 'prop2': {'kind': 'kind1', 'start': '2021-01-01T00:00:00Z', 'end': '2021-01-02T00:00:00Z'}}"
-    > {}
+// @route("/spreadRecordDiscriminatedUnion")
+// interface SpreadRecordDiscriminatedUnion
+//   extends ModelOperations<
+//       SpreadRecordForDiscriminatedUnion,
+//       "{'name': 'abc', 'prop1': {'kind': 'kind0', 'fooProp': 'abc'}, 'prop2': {'kind': 'kind1', 'start': '2021-01-01T00:00:00Z', 'end': '2021-01-02T00:00:00Z'}}"
+//     > {}
 
 // ****************** spread record of non-discriminated unions but could guess a discriminator **************************
 @doc("The model spread Record<WidgetData0 | WidgetData1>")

package/specs/type/property/additional-properties/mockapi.ts

@@ -98,7 +98,7 @@ const recordNonDiscriminatedUnion3Body = {
     end: "2021-01-02T00:00:00Z",
   },
 };
-function createServerTests(url: string, value: any) {
+function createServerTests(url: string, value: unknown) {
   return {
     get: passOnSuccess({
       uri: url,
@@ -114,7 +114,7 @@ function createServerTests(url: string, value: any) {
       uri: url,
       method: `put`,
       request: {
-        body: value,
+        body: json(value),
       },
       response: {
         status: 204,
@@ -432,14 +432,14 @@ Scenarios.Type_Property_AdditionalProperties_SpreadRecordUnion_get =
 Scenarios.Type_Property_AdditionalProperties_SpreadRecordUnion_put =
   Type_Property_Additional_Properties_Spread_Record_Union.put;
 
-const Type_Property_Additional_Properties_Spread_Record_Discriminated_Union = createServerTests(
-  `/type/property/additionalProperties/spreadRecordDiscriminatedUnion`,
-  recordDiscriminatedUnionBody,
-);
-Scenarios.Type_Property_AdditionalProperties_SpreadRecordDiscriminatedUnion_get =
-  Type_Property_Additional_Properties_Spread_Record_Discriminated_Union.get;
-Scenarios.Type_Property_AdditionalProperties_SpreadRecordDiscriminatedUnion_put =
-  Type_Property_Additional_Properties_Spread_Record_Discriminated_Union.put;
+// const Type_Property_Additional_Properties_Spread_Record_Discriminated_Union = createServerTests(
+//   `/type/property/additionalProperties/spreadRecordDiscriminatedUnion`,
+//   recordDiscriminatedUnionBody,
+// );
+// Scenarios.Type_Property_AdditionalProperties_SpreadRecordDiscriminatedUnion_get =
+//   Type_Property_Additional_Properties_Spread_Record_Discriminated_Union.get;
+// Scenarios.Type_Property_AdditionalProperties_SpreadRecordDiscriminatedUnion_put =
+//   Type_Property_Additional_Properties_Spread_Record_Discriminated_Union.put;
 
 const Type_Property_Additional_Properties_Spread_Record_Non_Discriminated_Union = createServerTests(
   `/type/property/additionalProperties/spreadRecordNonDiscriminatedUnion`,

package/specs/type/property/nullable/mockapi.ts

@@ -7,7 +7,6 @@ function createServerTests(url: string, value: unknown, patchNullableProperty?:
     get: passOnSuccess({
       uri: url,
       method: `get`,
-      request: {},
       response: {
         status: 200,
         body: json(value),
@@ -18,13 +17,13 @@ function createServerTests(url: string, value: unknown, patchNullableProperty?:
       uri: url,
       method: `patch`,
       request: {
-        body: {
-          requiredProperty: "foo",
-          nullableProperty: patchNullableProperty || null,
-        },
-        headers: {
-          "Content-Type": "application/merge-patch+json",
-        },
+        body: json(
+          {
+            requiredProperty: "foo",
+            nullableProperty: patchNullableProperty || null,
+          },
+          "application/merge-patch+json",
+        ),
       },
       response: {
         status: 204,

package/specs/type/property/optionality/mockapi.ts

@@ -18,7 +18,7 @@ function createServerTests(url: string, value: unknown) {
       uri: url,
       method: `put`,
       request: {
-        body: value,
+        body: json(value),
       },
       response: {
         status: 204,

package/specs/type/property/value-types/mockapi.ts

@@ -18,7 +18,7 @@ function createServerTests(url: string, data: unknown) {
       uri: url,
       method: `put`,
       request: {
-        body: data,
+        body: json(data),
       },
       response: {
         status: 204,
@@ -166,9 +166,9 @@ Scenarios.Type_Property_ValueTypes_Never_put = passOnSuccess({
   uri: `/type/property/value-types/never`,
   method: `put`,
   request: {
-    body: {
+    body: json({
       property: undefined,
-    },
+    }),
   },
   response: {
     status: 204,

package/specs/type/scalar/main.tsp

@@ -14,14 +14,25 @@ interface String {
   @scenarioDoc("Expect to handle a string value. Mock api will return 'test'")
   @get
   @doc("get string value")
-  get(): string;
+  get(): {
+    @header
+    contentType: "application/json";
+
+    @body
+    body: string;
+  };
 
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing"
   @scenario
   @scenarioDoc("Expect to send a string value. Mock api expect to receive 'test'")
   @put
   @doc("put string value")
-  put(@body @doc("_") body: string): void;
+  put(
+    @header
+    contentType: "application/json",
+
+    @body @doc("_") body: string,
+  ): void;
 }
 
 @route("/boolean")
@@ -31,14 +42,25 @@ interface Boolean {
   @scenarioDoc("Expect to handle a boolean value. Mock api will return true ")
   @get
   @doc("get boolean value")
-  get(): boolean;
+  get(): {
+    @header
+    contentType: "application/json";
+
+    @body
+    body: boolean;
+  };
 
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing"
   @scenario
   @scenarioDoc("Expect to send a boolean value. Mock api expect to receive 'true'")
   @put
   @doc("put boolean value")
-  put(@body @doc("_") body: boolean): void;
+  put(
+    @header
+    contentType: "application/json",
+
+    @body @doc("_") body: boolean,
+  ): void;
 }
 
 @route("/unknown")
@@ -48,14 +70,25 @@ interface Unknown {
   @scenarioDoc("Expect to handle a unknown type value. Mock api will return 'test'")
   @get
   @doc("get unknown value")
-  get(): unknown;
+  get(): {
+    @header
+    contentType: "application/json";
+
+    @body
+    body: unknown;
+  };
 
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing"
   @scenario
   @scenarioDoc("Expect to send a string value. Mock api expect to receive 'test'")
   @put
   @doc("put unknown value")
-  put(@body @doc("_") body: unknown): void;
+  put(
+    @header
+    contentType: "application/json",
+
+    @body @doc("_") body: unknown,
+  ): void;
 }
 
 @doc("Template to have scalar types operations")
@@ -69,7 +102,13 @@ interface ScalarTypesOperations<T, TDoc extends valueof string> {
     """)
   @get
   @route("/response_body")
-  responseBody(): T;
+  responseBody(): {
+    @header
+    contentType: "application/json";
+
+    @body
+    body: T;
+  };
 
   @scenario
   @scenarioDoc("""
@@ -80,7 +119,12 @@ interface ScalarTypesOperations<T, TDoc extends valueof string> {
     """)
   @put
   @route("/resquest_body")
-  requestBody(@body body: T): void;
+  requestBody(
+    @header
+    contentType: "application/json",
+
+    @body body: T,
+  ): void;
 
   @scenario
   @scenarioDoc("""
@@ -124,7 +168,12 @@ interface NumberTypesVerifyOperations<
     """)
   @post
   @route("/verify")
-  verify(@body body: T): void;
+  verify(
+    @header
+    contentType: "application/json",
+
+    @body body: T,
+  ): void;
 }
 
 @doc("Decimal type verification")

package/specs/type/scalar/mockapi.ts

@@ -17,7 +17,7 @@ Scenarios.Type_Scalar_String_put = passOnSuccess({
   uri: "/type/scalar/string",
   method: `put`,
   request: {
-    body: "test",
+    body: json("test"),
     headers: {
       "Content-Type": "text/plain",
     },
@@ -43,7 +43,7 @@ Scenarios.Type_Scalar_Boolean_put = passOnSuccess({
   uri: "/type/scalar/boolean",
   method: `put`,
   request: {
-    body: true,
+    body: json(true),
     headers: {
       "Content-Type": "application/json; charset=utf-8",
     },
@@ -68,7 +68,7 @@ Scenarios.Type_Scalar_Unknown_put = passOnSuccess({
   uri: "/type/scalar/unknown",
   method: `put`,
   request: {
-    body: "test",
+    body: json("test"),
     headers: {
       "Content-Type": "text/plain",
     },
@@ -103,7 +103,7 @@ Scenarios.Type_Scalar_DecimalType_requestBody = passOnSuccess({
   uri: "/type/scalar/decimal/resquest_body",
   method: `put`,
   request: {
-    body: 0.33333,
+    body: json(0.33333),
     headers: {
       "Content-Type": "application/json; charset=utf-8",
     },
@@ -117,7 +117,7 @@ Scenarios.Type_Scalar_Decimal128Type_requestBody = passOnSuccess({
   uri: "/type/scalar/decimal128/resquest_body",
   method: `put`,
   request: {
-    body: 0.33333,
+    body: json(0.33333),
     headers: {
       "Content-Type": "application/json; charset=utf-8",
     },
@@ -131,7 +131,7 @@ Scenarios.Type_Scalar_DecimalType_requestParameter = passOnSuccess({
   uri: "/type/scalar/decimal/request_parameter",
   method: `get`,
   request: {
-    params: { value: "0.33333" },
+    query: { value: "0.33333" },
   },
   response: {
     status: 204,
@@ -142,7 +142,7 @@ Scenarios.Type_Scalar_Decimal128Type_requestParameter = passOnSuccess({
   uri: "/type/scalar/decimal128/request_parameter",
   method: `get`,
   request: {
-    params: { value: "0.33333" },
+    query: { value: "0.33333" },
   },
   response: {
     status: 204,
@@ -173,7 +173,7 @@ Scenarios.Type_Scalar_DecimalVerify_verify = passOnSuccess({
   uri: "/type/scalar/decimal/verify",
   method: `post`,
   request: {
-    body: 0.3,
+    body: json(0.3),
     headers: {
       "Content-Type": "application/json; charset=utf-8",
     },
@@ -187,7 +187,7 @@ Scenarios.Type_Scalar_Decimal128Verify_verify = passOnSuccess({
   uri: "/type/scalar/decimal128/verify",
   method: `post`,
   request: {
-    body: 0.3,
+    body: json(0.3),
     headers: {
       "Content-Type": "application/json; charset=utf-8",
     },

package/specs/type/union/discriminated/main.tsp

@@ -0,0 +1,251 @@
+import "@typespec/http";
+import "@typespec/spector";
+
+using Http;
+using Spector;
+
+/**
+ * Describe scenarios for discriminated unions.
+ */
+@scenarioService("/type/union/discriminated")
+namespace Type.Union.Discriminated;
+
+// Models for discriminated unions
+model Cat {
+  name: string;
+  meow: boolean;
+}
+
+model Dog {
+  name: string;
+  bark: boolean;
+}
+
+/**
+ * Test discriminated union with default envelope serialization.
+ * The discriminated union should serialize with "kind" as discriminator
+ * and "value" as envelope property.
+ */
+@discriminated
+union PetWithEnvelope {
+  cat: Cat,
+  dog: Dog,
+}
+
+@route("/envelope")
+namespace Envelope {
+  @route("/object")
+  namespace Object {
+    @route("/default")
+    interface Default {
+      @scenario
+      @scenarioDoc("""
+        Test discriminated union with envelope serialization.
+        When value of query parameter "kind" is "cat" or no query parameter input, the expected response is:
+        ```json
+        {
+          "kind": "cat",
+          "value": {
+            "name": "Whiskers",
+            "meow": true
+          }
+        }
+        ```
+        When it is "dog", expected response is:
+        ```json
+        {
+          "kind": "dog",
+          "value": {
+            "name": "Rex",
+            "bark": false
+          }
+        }
+        ```
+        """)
+      @get
+      get(@query kind?: string): PetWithEnvelope;
+
+      @scenario
+      @scenarioDoc("""
+        Test discriminated union with envelope serialization.
+        Send the union as:
+        ```json
+        {
+          "kind": "cat", 
+          "value": {
+            "name": "Whiskers",
+            "meow": true
+          }
+        }
+        ```
+        """)
+      @put
+      put(@body input: PetWithEnvelope): PetWithEnvelope;
+    }
+
+    @route("/custom-properties")
+    interface CustomProperties {
+      @scenario
+      @scenarioDoc("""
+        Test discriminated union with custom property names.
+        When value of query parameter "petType" is "cat" or no query parameter input, the expected response is:
+        ```json
+        {
+          "petType": "cat",
+          "petData": {
+            "name": "Whiskers", 
+            "meow": true
+          }
+        }
+        ```
+        When it is "dog", expected response is:
+        ```json
+        {
+          "petType": "dog",
+          "petData": {
+            "name": "Rex",
+            "bark": false
+          }
+        }
+        ```
+        """)
+      @get
+      get(@query petType?: string): PetWithCustomNames;
+
+      @scenario
+      @scenarioDoc("""
+        Test discriminated union with custom property names.
+        Send the union as:
+        ```json
+        {
+          "petType": "cat",
+          "petData": {
+            "name": "Whiskers",
+            "meow": true
+          }
+        }
+        ```
+        """)
+      @put
+      put(@body input: PetWithCustomNames): PetWithCustomNames;
+    }
+  }
+}
+
+/**
+ * Test discriminated union with custom property names.
+ * The discriminated union should serialize with custom discriminator
+ * and envelope property names.
+ */
+@discriminated(#{ discriminatorPropertyName: "petType", envelopePropertyName: "petData" })
+union PetWithCustomNames {
+  cat: Cat,
+  dog: Dog,
+}
+
+/**
+ * Test discriminated union with inline discriminator (no envelope).
+ * The discriminated union should serialize with discriminator property
+ * injected directly into the variant object.
+ */
+@discriminated(#{ envelope: "none" })
+union PetInline {
+  cat: Cat,
+  dog: Dog,
+}
+
+/**
+ * Test discriminated union with inline discriminator and custom discriminator property name.
+ * The discriminated union should serialize with custom discriminator property
+ * injected directly into the variant object.
+ */
+@discriminated(#{ envelope: "none", discriminatorPropertyName: "type" })
+union PetInlineWithCustomDiscriminator {
+  cat: Cat,
+  dog: Dog,
+}
+
+@route("/no-envelope")
+namespace NoEnvelope {
+  @route("/default")
+  interface Default {
+    @scenario
+    @scenarioDoc("""
+      Test discriminated union with inline discriminator.
+      When value of query parameter "kind" is "cat" or no query parameter input, the expected response is:
+      ```json
+      {
+        "kind": "cat",
+        "name": "Whiskers",
+        "meow": true
+      }
+      ```
+      When it is "dog", expected response is:
+      ```json
+      {
+        "kind": "dog",
+        "name": "Rex",
+        "bark": false
+      }
+      ```
+      """)
+    @get
+    get(@query kind?: string): PetInline;
+
+    @scenario
+    @scenarioDoc("""
+      Test discriminated union with inline discriminator.
+      Send the union as:
+      ```json
+      {
+        "kind": "cat",
+        "name": "Whiskers", 
+        "meow": true
+      }
+      ```
+      """)
+    @put
+    put(@body input: PetInline): PetInline;
+  }
+
+  @route("/custom-discriminator")
+  interface CustomDiscriminator {
+    @scenario
+    @scenarioDoc("""
+      Test discriminated union with inline discriminator and custom discriminator property name.
+      When value of query parameter "type" is "cat" or no query parameter input, the expected response is:
+      ```json
+      {
+        "type": "cat",
+        "name": "Whiskers",
+        "meow": true
+      }
+      ```
+      When it is "dog", expected response is:
+      ```json
+      {
+        "type": "dog",
+        "name": "Rex",
+        "bark": false
+      }
+      ```
+      """)
+    @get
+    get(@query type?: string): PetInlineWithCustomDiscriminator;
+
+    @scenario
+    @scenarioDoc("""
+      Test discriminated union with inline discriminator and custom discriminator property name.
+      Send the union as:
+      ```json
+      {
+        "type": "cat",
+        "name": "Whiskers", 
+        "meow": true
+      }
+      ```
+      """)
+    @put
+    put(@body input: PetInlineWithCustomDiscriminator): PetInlineWithCustomDiscriminator;
+  }
+}