@typespec/http-specs 0.37.2

package/specs/type/enum/fixed/mockapi.ts

@@ -0,0 +1,55 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Type_Enum_Fixed_String_getKnownValue = passOnSuccess({
+  uri: "/type/enum/fixed/string/known-value",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: json("Monday"),
+  },
+  handler: (req: MockRequest) => {
+    return { status: 200, body: json("Monday") };
+  },
+  kind: "MockApiDefinition",
+});
+Scenarios.Type_Enum_Fixed_String_putKnownValue = passOnSuccess({
+  uri: "/type/enum/fixed/string/known-value",
+  method: "put",
+  request: {
+    body: "Monday",
+    headers: {
+      "Content-Type": "application/json",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals("Monday");
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Type_Enum_Fixed_String_putUnknownValue = passOnSuccess({
+  uri: "/type/enum/fixed/string/unknown-value",
+  method: "put",
+  request: {
+    body: "Weekend",
+    headers: {
+      "Content-Type": "application/json",
+    },
+    status: 500,
+  },
+  response: {
+    status: 500,
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals("Weekend");
+    return { status: 500 };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/type/model/empty/main.tsp

@@ -0,0 +1,39 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+
+using TypeSpec.Http;
+
+@doc("Illustrates usage of empty model used in operation's parameters and responses.")
+@scenarioService("/type/model/empty")
+namespace Type.Model.Empty;
+
+@doc("Empty model used in operation parameters")
+model EmptyInput {}
+
+@doc("Empty model used in operation return type")
+model EmptyOutput {}
+
+@doc("Empty model used in both parameter and return type")
+model EmptyInputOutput {}
+
+@scenario
+@scenarioDoc("Send a PUT request with the following body {}")
+@route("/alone")
+@put
+op putEmpty(@body input: EmptyInput): void;
+
+@scenario
+@scenarioDoc("Send a GET request which returns the following body {}")
+@route("/alone")
+@get
+op getEmpty(): {
+  @body body: EmptyOutput;
+};
+
+@scenario
+@scenarioDoc("Send a POST request with the following body {} which returns the same.")
+@route("/round-trip")
+@post
+op postRoundTripEmpty(@body body: EmptyInputOutput): {
+  @body body: EmptyInputOutput;
+};

package/specs/type/model/empty/mockapi.ts

@@ -0,0 +1,51 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+const body = {};
+
+Scenarios.Type_Model_Empty_putEmpty = passOnSuccess({
+  uri: "/type/model/empty/alone",
+  method: "put",
+  request: {
+    body: body,
+  },
+  response: {
+    status: 204,
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals(body);
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+Scenarios.Type_Model_Empty_getEmpty = passOnSuccess({
+  uri: "/type/model/empty/alone",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: json(body),
+  },
+  handler: (req: MockRequest) => {
+    return { status: 200, body: json(body) };
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Type_Model_Empty_postRoundTripEmpty = passOnSuccess({
+  uri: "/type/model/empty/round-trip",
+  method: "post",
+  request: {
+    body: body,
+  },
+  response: {
+    status: 200,
+    body: json(body),
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals(body);
+    return { status: 200, body: json(body) };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/type/model/inheritance/enum-discriminator/main.tsp

@@ -0,0 +1,169 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+
+using TypeSpec.Http;
+using Azure.Core;
+
+@doc("Illustrates inheritance with enum discriminator.")
+@scenarioService("/type/model/inheritance/enum-discriminator")
+namespace Type.Model.Inheritance.EnumDiscriminator;
+
+@doc("extensible enum type for discriminator")
+union DogKind {
+  string,
+
+  @doc("Species golden")
+  Golden: "golden",
+}
+
+@doc("Test extensible enum type for discriminator")
+@discriminator("kind")
+model Dog {
+  @doc("discriminator property")
+  kind: DogKind;
+
+  @doc("Weight of the dog")
+  weight: int32;
+}
+
+@doc("Golden dog model")
+model Golden extends Dog {
+  @doc("discriminator property")
+  kind: DogKind.Golden;
+}
+
+#suppress "@azure-tools/typespec-azure-core/use-extensible-enum" "For testing fixed enum as discriminator property"
+@doc("fixed enum type for discriminator")
+enum SnakeKind {
+  @doc("Species cobra")
+  Cobra: "cobra",
+}
+
+#suppress "@azure-tools/typespec-azure-core/no-fixed-enum-discriminator" "For testing fixed enum as discriminator property"
+@doc("Test fixed enum type for discriminator")
+@discriminator("kind")
+model Snake {
+  @doc("discriminator property")
+  kind: SnakeKind;
+
+  @doc("Length of the snake")
+  length: int32;
+}
+
+@doc("Cobra model")
+model Cobra extends Snake {
+  @doc("discriminator property")
+  kind: SnakeKind.Cobra;
+}
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing enum as discriminator property"
+@doc("Receive model with extensible enum discriminator type.")
+@scenario
+@scenarioDoc("""
+  Receive model with extensible enum discriminator type.
+  Expected response body:
+  ```json
+  {"kind": "golden", "weight": 10}
+  ```
+  """)
+@route("/extensible-enum")
+@get
+op getExtensibleModel(): Dog;
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing enum as discriminator property"
+@doc("Send model with extensible enum discriminator type.")
+@scenario
+@scenarioDoc("""
+  Send model with extensible enum discriminator type.
+  Expected request body:
+  ```json
+  {"kind": "golden", "weight": 10}
+  ```
+  """)
+@route("/extensible-enum")
+@put
+op putExtensibleModel(@body @doc("Dog to create") input: Dog): NoContentResponse;
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing enum as discriminator property"
+@doc("Get a model omitting the discriminator.")
+@scenario
+@route("/extensible-enum/missingdiscriminator")
+@scenarioDoc("""
+  Get a model omitting the discriminator.
+  Expected response body:
+  ```json
+  {"weight": 10}
+  ```
+  """)
+@get
+op getExtensibleModelMissingDiscriminator(): Dog;
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing enum as discriminator property"
+@doc("Get a model containing discriminator value never defined.")
+@scenario
+@route("/extensible-enum/wrongdiscriminator")
+@scenarioDoc("""
+  Get a model containing discriminator value never defined.
+  Expected response body:
+  ```json
+  {"weight": 8, "kind": "wrongKind" }
+  ```
+  """)
+@get
+op getExtensibleModelWrongDiscriminator(): Dog;
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing enum as discriminator property"
+@doc("Receive model with fixed enum discriminator type.")
+@scenario
+@scenarioDoc("""
+  Receive model with fixed enum discriminator type.
+  Expected response body:
+  ```json
+  {"kind": "cobra", "length": 10}
+  ```
+  """)
+@route("/fixed-enum")
+@get
+op getFixedModel(): Snake;
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing enum as discriminator property"
+@doc("Send model with fixed enum discriminator type.")
+@scenario
+@scenarioDoc("""
+  Send model with fixed enum discriminator type.
+  Expected request body:
+  ```json
+  {"kind": "cobra", "length": 10}
+  ```
+  """)
+@route("/fixed-enum")
+@put
+op putFixedModel(@body @doc("Snake to create") input: Snake): NoContentResponse;
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing enum as discriminator property"
+@doc("Get a model omitting the discriminator.")
+@scenario
+@route("/fixed-enum/missingdiscriminator")
+@scenarioDoc("""
+  Get a model omitting the discriminator.
+  Expected response body:
+  ```json
+  {"length": 10}
+  ```
+  """)
+@get
+op getFixedModelMissingDiscriminator(): Snake;
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing enum as discriminator property"
+@doc("Get a model containing discriminator value never defined.")
+@scenario
+@route("/fixed-enum/wrongdiscriminator")
+@scenarioDoc("""
+  Get a model containing discriminator value never defined.
+  Expected response body:
+  ```json
+  {"length": 8, "kind": "wrongKind" }
+  ```
+  """)
+@get
+op getFixedModelWrongDiscriminator(): Snake;

package/specs/type/model/inheritance/enum-discriminator/mockapi.ts

@@ -0,0 +1,99 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+const validExtensibleEnumBody = {
+  weight: 10,
+  kind: "golden",
+};
+const validFixedEnumBody = {
+  length: 10,
+  kind: "cobra",
+};
+function createGetServerTests(uri: string, data: any) {
+  return passOnSuccess({
+    uri: uri,
+    method: "get",
+    request: {},
+    response: {
+      status: 200,
+      body: json(data),
+    },
+    handler: (req: MockRequest) => {
+      return { status: 200, body: json(data) };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+
+function createGetPutServerTests(uri: string, data: any) {
+  return {
+    get: passOnSuccess({
+      uri: uri,
+      method: "get",
+      request: {},
+      response: {
+        status: 200,
+        body: json(data),
+      },
+      handler: (req: MockRequest) => {
+        return { status: 200, body: json(data) };
+      },
+      kind: "MockApiDefinition",
+    }),
+    put: passOnSuccess({
+      uri: uri,
+      method: "put",
+      request: {
+        body: data,
+      },
+      response: {
+        status: 204,
+      },
+      handler: (req: MockRequest) => {
+        req.expect.bodyEquals(data);
+        return { status: 204 };
+      },
+      kind: "MockApiDefinition",
+    }),
+  };
+}
+
+const Type_Model_Inheritance_Enum_Discriminator_Extensible_Enum = createGetPutServerTests(
+  "/type/model/inheritance/enum-discriminator/extensible-enum",
+  validExtensibleEnumBody,
+);
+Scenarios.Type_Model_Inheritance_EnumDiscriminator_getExtensibleModel =
+  Type_Model_Inheritance_Enum_Discriminator_Extensible_Enum.get;
+Scenarios.Type_Model_Inheritance_EnumDiscriminator_putExtensibleModel =
+  Type_Model_Inheritance_Enum_Discriminator_Extensible_Enum.put;
+
+const Type_Model_Inheritance_Enum_Discriminator_Fixed_Enum = createGetPutServerTests(
+  "/type/model/inheritance/enum-discriminator/fixed-enum",
+  validFixedEnumBody,
+);
+Scenarios.Type_Model_Inheritance_EnumDiscriminator_getFixedModel =
+  Type_Model_Inheritance_Enum_Discriminator_Fixed_Enum.get;
+Scenarios.Type_Model_Inheritance_EnumDiscriminator_putFixedModel =
+  Type_Model_Inheritance_Enum_Discriminator_Fixed_Enum.put;
+
+Scenarios.Type_Model_Inheritance_EnumDiscriminator_getExtensibleModelMissingDiscriminator =
+  createGetServerTests(
+    "/type/model/inheritance/enum-discriminator/extensible-enum/missingdiscriminator",
+    { weight: 10 },
+  );
+Scenarios.Type_Model_Inheritance_EnumDiscriminator_getExtensibleModelWrongDiscriminator =
+  createGetServerTests(
+    "/type/model/inheritance/enum-discriminator/extensible-enum/wrongdiscriminator",
+    { weight: 8, kind: "wrongKind" },
+  );
+Scenarios.Type_Model_Inheritance_EnumDiscriminator_getFixedModelMissingDiscriminator =
+  createGetServerTests(
+    "/type/model/inheritance/enum-discriminator/fixed-enum/missingdiscriminator",
+    { length: 10 },
+  );
+Scenarios.Type_Model_Inheritance_EnumDiscriminator_getFixedModelWrongDiscriminator =
+  createGetServerTests("/type/model/inheritance/enum-discriminator/fixed-enum/wrongdiscriminator", {
+    length: 8,
+    kind: "wrongKind",
+  });

package/specs/type/model/inheritance/nested-discriminator/main.tsp

@@ -0,0 +1,223 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+
+using TypeSpec.Http;
+
+@doc("Illustrates multiple level inheritance with multiple discriminators.")
+@scenarioService("/type/model/inheritance/nested-discriminator")
+namespace Type.Model.Inheritance.NestedDiscriminator;
+
+@doc("This is base model for polymorphic multiple levels inheritance with a discriminator.")
+@discriminator("kind")
+model Fish {
+  age: int32;
+}
+
+@doc("The second level model in polymorphic multiple levels inheritance and it defines a new discriminator.")
+@discriminator("sharktype")
+model Shark extends Fish {
+  kind: "shark";
+  sharktype: string;
+}
+
+@doc("The second level model in polymorphic multiple levels inheritance which contains references to other polymorphic instances.")
+model Salmon extends Fish {
+  kind: "salmon";
+  friends?: Fish[];
+  hate?: Record<Fish>;
+  partner?: Fish;
+}
+
+@doc("The third level model SawShark in polymorphic multiple levels inheritance.")
+model SawShark extends Shark {
+  sharktype: "saw";
+}
+
+@doc("The third level model GoblinShark in polymorphic multiple levels inheritance.")
+model GoblinShark extends Shark {
+  sharktype: "goblin";
+}
+
+@scenario
+@route("/model")
+@scenarioDoc("""
+  Generate and receive polymorphic model in multiple levels inheritance with 2 discriminators.
+  Expected response body:
+  ```json
+  {"age": 1, "kind": "shark",  "sharktype": "goblin"}
+  ```
+  """)
+@get
+op getModel(): Fish;
+
+@scenario
+@route("/model")
+@scenarioDoc("""
+  Generate and send polymorphic model in multiple levels inheritance with 2 discriminators.
+  Expected input body:
+  ```json
+  {"age": 1, "kind": "shark",  "sharktype": "goblin"}
+  ```
+  """)
+@put
+op putModel(@body input: Fish): NoContentResponse;
+
+@scenario
+@route("/recursivemodel")
+@scenarioDoc("""
+  Generate and receive polymorphic models has collection and dictionary properties referring to other polymorphic models.
+  Expected response body:
+  ```json
+  {
+    "age": 1,
+    "kind": "salmon",
+    "partner": {
+      "age": 2,
+      "kind": "shark",
+      "sharktype": "saw"
+    },
+    "friends": [
+      {
+        "age": 2,
+        "kind": "salmon",
+        "partner": {
+          "age": 3,
+          "kind": "salmon"
+        },
+        "hate": {
+          "key1": {
+            "age": 4,
+            "kind": "salmon"
+          },
+          "key2": {
+            "age": 2,
+            "kind": "shark",
+            "sharktype": "goblin"
+          }
+        }
+      },
+      {
+        "age": 3,
+        "kind": "shark",
+        "sharktype": "goblin"
+      }
+    ],
+    "hate": {
+      "key3": {
+        "age": 3,
+        "kind": "shark",
+        "sharktype": "saw"
+      },
+      "key4": {
+        "age": 2,
+        "kind": "salmon",
+        "friends": [
+          {
+            "age": 1,
+            "kind": "salmon"
+          },
+          {
+            "age": 4,
+            "kind": "shark",
+            "sharktype": "goblin"
+          }
+        ]
+      }
+    }
+  }
+  ```
+  """)
+@get
+op getRecursiveModel(): Fish;
+
+@scenario
+@route("/recursivemodel")
+@scenarioDoc("""
+  Generate and send polymorphic models has collection and dictionary properties referring to other polymorphic models.
+  Expected input body:
+  ```json
+  {
+    "age": 1,
+    "kind": "salmon",
+    "partner": {
+      "age": 2,
+      "kind": "shark",
+      "sharktype": "saw"
+    },
+    "friends": [
+      {
+        "age": 2,
+        "kind": "salmon",
+        "partner": {
+          "age": 3,
+          "kind": "salmon"
+        },
+        "hate": {
+          "key1": {
+            "age": 4,
+            "kind": "salmon"
+          },
+          "key2": {
+            "age": 2,
+            "kind": "shark",
+            "sharktype": "goblin"
+          }
+        }
+      },
+      {
+        "age": 3,
+        "kind": "shark",
+        "sharktype": "goblin"
+      }
+    ],
+    "hate": {
+      "key3": {
+        "age": 3,
+        "kind": "shark",
+        "sharktype": "saw"
+      },
+      "key4": {
+        "age": 2,
+        "kind": "salmon",
+        "friends": [
+          {
+            "age": 1,
+            "kind": "salmon"
+          },
+          {
+            "age": 4,
+            "kind": "shark",
+            "sharktype": "goblin"
+          }
+        ]
+      }
+    }
+  }
+  ```
+  """)
+@put
+op putRecursiveModel(@body input: Fish): NoContentResponse;
+
+@scenario
+@route("/missingdiscriminator")
+@scenarioDoc("""
+  Get a model omitting the discriminator.
+  Expected response body:
+  ```json
+  {"age": 1}
+  ```
+  """)
+@get
+op getMissingDiscriminator(): Fish;
+
+@scenario
+@route("/wrongdiscriminator")
+@scenarioDoc("""
+  Get a model containing discriminator value never defined.
+  Expected response body:
+  ```json
+  {"age": 1, "kind": "wrongKind" }
+  ```
+  """)
+@get
+op getWrongDiscriminator(): Fish;