@typespec/http-specs 0.1.0-alpha.1 → 0.1.0-alpha.10-dev.1

package/specs/response/status-code-range/mockapi.ts

@@ -0,0 +1,35 @@
+import { json, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Response_StatusCodeRange_errorResponseStatusCodeInRange = passOnSuccess({
+  uri: "/response/status-code-range/error-response-status-code-in-range",
+  method: "get",
+  request: {
+    status: 494,
+  },
+  response: {
+    status: 494,
+    body: json({
+      code: "request-header-too-large",
+      message: "Request header too large",
+    }),
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Response_StatusCodeRange_errorResponseStatusCode404 = passOnSuccess({
+  uri: "/response/status-code-range/error-response-status-code-404",
+  method: "get",
+  request: {
+    status: 404,
+  },
+  response: {
+    status: 404,
+    body: json({
+      code: "not-found",
+      resourceId: "resource1",
+    }),
+  },
+  kind: "MockApiDefinition",
+});

package/specs/routes/main.tsp

@@ -87,7 +87,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test simple expansion with explode: false when passed a primitive value.
             Param value: "a"
-            Expected path: /routes/simple/standard/primitivea
+            Expected path: /routes/path/simple/standard/primitivea
         """)
       @route("primitive{param}")
       op primitive(param: string): void;
@@ -96,7 +96,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test simple expansion with explode: false when passed an array value.
             Param value: ["a","b"]
-            Expected path: /routes/simple/standard/arraya,b
+            Expected path: /routes/path/simple/standard/arraya,b
         """)
       @route("array{param}")
       op array(param: string[]): void;
@@ -105,7 +105,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test simple expansion with explode: false when passed a record value.
             Param value: {a: 1, b: 2}
-            Expected path: /routes/simple/standard/recorda,1,b,2
+            Expected path: /routes/path/simple/standard/recorda,1,b,2
         """)
       @route("record{param}")
       op record(param: Record<int32>): void;
@@ -117,7 +117,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test simple expansion with explode: true when passed a primitive value.
             Param value: "a"
-            Expected path: /routes/simple/explode/primitivea
+            Expected path: /routes/path/simple/explode/primitivea
         """)
       @route("primitive{param*}")
       op primitive(param: string): void;
@@ -126,7 +126,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test simple expansion with explode: true when passed an array value.
             Param value: ["a","b"]
-            Expected path: /routes/simple/explode/arraya.b
+            Expected path: /routes/path/simple/explode/arraya.b
         """)
       @route("array{param*}")
       op array(param: string[]): void;
@@ -135,7 +135,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test simple expansion with explode: true when passed a record value.
             Param value: {a: 1, b: 2}
-            Expected path: /routes/simple/explode/recorda=1,b=2
+            Expected path: /routes/path/simple/explode/recorda=1,b=2
         """)
       @route("record{param*}")
       op record(param: Record<int32>): void;
@@ -150,7 +150,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test path expansion with explode: false when passed a primitive value.
             Param value: "a"
-            Expected path: /routes/path/standard/primitive/a
+            Expected path: /routes/path/path/standard/primitive/a
         """)
       @route("primitive{/param}")
       op primitive(param: string): void;
@@ -159,7 +159,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test path expansion with explode: false when passed an array value.
             Param value: ["a","b"]
-            Expected path: /routes/path/standard/array/a,b
+            Expected path: /routes/path/path/standard/array/a,b
         """)
       @route("array{/param}")
       op array(param: string[]): void;
@@ -168,7 +168,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test path expansion with explode: false when passed a record value.
             Param value: {a: 1, b: 2}
-            Expected path: /routes/path/standard/record/a,1,b,2
+            Expected path: /routes/path/path/standard/record/a,1,b,2
         """)
       @route("record{/param}")
       op record(param: Record<int32>): void;
@@ -180,7 +180,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test path expansion with explode: true when passed a primitive value.
             Param value: "a"
-            Expected path: /routes/path/explode/primitive/a
+            Expected path: /routes/path/path/explode/primitive/a
         """)
       @route("primitive{/param*}")
       op primitive(param: string): void;
@@ -189,7 +189,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test path expansion with explode: true when passed an array value.
             Param value: ["a","b"]
-            Expected path: /routes/path/explode/array/a/b
+            Expected path: /routes/path/path/explode/array/a/b
         """)
       @route("array{/param*}")
       op array(param: string[]): void;
@@ -198,7 +198,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test path expansion with explode: true when passed a record value.
             Param value: {a: 1, b: 2}
-            Expected path: /routes/path/explode/record/a=1/b=2
+            Expected path: /routes/path/path/explode/record/a=1/b=2
         """)
       @route("record{/param*}")
       op record(param: Record<int32>): void;
@@ -213,7 +213,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test label expansion with explode: false when passed a primitive value.
             Param value: "a"
-            Expected path: /routes/label/standard/primitive.a
+            Expected path: /routes/path/label/standard/primitive.a
         """)
       @route("primitive{.param}")
       op primitive(param: string): void;
@@ -222,7 +222,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test label expansion with explode: false when passed an array value.
             Param value: ["a","b"]
-            Expected path: /routes/label/standard/array.a,b
+            Expected path: /routes/path/label/standard/array.a,b
         """)
       @route("array{.param}")
       op array(param: string[]): void;
@@ -231,7 +231,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test label expansion with explode: false when passed a record value.
             Param value: {a: 1, b: 2}
-            Expected path: /routes/label/standard/record.a,1,b,2
+            Expected path: /routes/path/label/standard/record.a,1,b,2
         """)
       @route("record{.param}")
       op record(param: Record<int32>): void;
@@ -243,7 +243,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test label expansion with explode: true when passed a primitive value.
             Param value: "a"
-            Expected path: /routes/label/explode/primitive.a
+            Expected path: /routes/path/label/explode/primitive.a
         """)
       @route("primitive{.param*}")
       op primitive(param: string): void;
@@ -252,7 +252,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test label expansion with explode: true when passed an array value.
             Param value: ["a","b"]
-            Expected path: /routes/label/explode/array.a.b
+            Expected path: /routes/path/label/explode/array.a.b
         """)
       @route("array{.param*}")
       op array(param: string[]): void;
@@ -261,7 +261,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test label expansion with explode: true when passed a record value.
             Param value: {a: 1, b: 2}
-            Expected path: /routes/label/explode/record.a=1.b=2
+            Expected path: /routes/path/label/explode/record.a=1.b=2
         """)
       @route("record{.param*}")
       op record(param: Record<int32>): void;
@@ -276,7 +276,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test matrix expansion with explode: false when passed a primitive value.
             Param value: "a"
-            Expected path: /routes/matrix/standard/primitive;a
+            Expected path: /routes/path/matrix/standard/primitive;param=a
         """)
       @route("primitive{;param}")
       op primitive(param: string): void;
@@ -285,7 +285,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test matrix expansion with explode: false when passed an array value.
             Param value: ["a","b"]
-            Expected path: /routes/matrix/standard/array;a,b
+            Expected path: /routes/path/matrix/standard/array;param=a;param=b
         """)
       @route("array{;param}")
       op array(param: string[]): void;
@@ -294,7 +294,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test matrix expansion with explode: false when passed a record value.
             Param value: {a: 1, b: 2}
-            Expected path: /routes/matrix/standard/record;a,1,b,2
+            Expected path: /routes/path/matrix/standard/record;a=1;b=2
         """)
       @route("record{;param}")
       op record(param: Record<int32>): void;
@@ -306,7 +306,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test matrix expansion with explode: true when passed a primitive value.
             Param value: "a"
-            Expected path: /routes/matrix/explode/primitive;a
+            Expected path: /routes/path/matrix/explode/primitive;param=a
         """)
       @route("primitive{;param*}")
       op primitive(param: string): void;
@@ -315,7 +315,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test matrix expansion with explode: true when passed an array value.
             Param value: ["a","b"]
-            Expected path: /routes/matrix/explode/array;a.b
+            Expected path: /routes/path/matrix/explode/array;param=a;param=b
         """)
       @route("array{;param*}")
       op array(param: string[]): void;
@@ -324,7 +324,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test matrix expansion with explode: true when passed a record value.
             Param value: {a: 1, b: 2}
-            Expected path: /routes/matrix/explode/record;a=1;b=2
+            Expected path: /routes/path/matrix/explode/record;a=1;b=2
         """)
       @route("record{;param*}")
       op record(param: Record<int32>): void;

package/specs/routes/mockapi.ts

@@ -61,76 +61,76 @@ Scenarios.Routes_PathParameters_ReservedExpansion_annotation = createTests(
   "/routes/path/reserved-expansion/annotation/foo/bar%20baz",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Standard_primitive = createTests(
-  "/routes/simple/standard/primitivea",
+  "/routes/path/simple/standard/primitivea",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Standard_array = createTests(
-  "/routes/simple/standard/arraya,b",
+  "/routes/path/simple/standard/arraya,b",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Standard_record = createTests(
-  "/routes/simple/standard/recorda,1,b,2",
+  "/routes/path/simple/standard/recorda,1,b,2",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Explode_primitive = createTests(
-  "/routes/simple/standard/primitivea",
+  "/routes/path/simple/explode/primitivea",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Explode_array = createTests(
-  "/routes/simple/standard/arraya,b",
+  "/routes/path/simple/explode/arraya,b",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Explode_record = createTests(
-  "/routes/simple/standard/recorda=1,b=2",
+  "/routes/path/simple/explode/recorda=1,b=2",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Standard_primitive = createTests(
-  "/routes/path/standard/primitive/a",
+  "/routes/path/path/standard/primitive/a",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Standard_array = createTests(
-  "/routes/path/standard/array/a,b",
+  "/routes/path/path/standard/array/a,b",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Standard_record = createTests(
-  "/routes/path/standard/record/a,1,b,2",
+  "/routes/path/path/standard/record/a,1,b,2",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Explode_primitive = createTests(
-  "/routes/path/standard/primitive/a",
+  "/routes/path/path/explode/primitive/a",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Explode_array = createTests(
-  "/routes/path/standard/array/a/b",
+  "/routes/path/path/explode/array/a/b",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Explode_record = createTests(
-  "/routes/path/standard/record/a=1/b=2",
+  "/routes/path/path/explode/record/a=1/b=2",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Standard_primitive = createTests(
-  "/routes/label/standard/primitive.a",
+  "/routes/path/label/standard/primitive.a",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Standard_array = createTests(
-  "/routes/label/standard/array.a,b",
+  "/routes/path/label/standard/array.a,b",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Standard_record = createTests(
-  "/routes/label/standard/record.a,1,b,2",
+  "/routes/path/label/standard/record.a,1,b,2",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Explode_primitive = createTests(
-  "/routes/label/standard/primitive.a",
+  "/routes/path/label/explode/primitive.a",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Explode_array = createTests(
-  "/routes/label/standard/array.a.b",
+  "/routes/path/label/explode/array.a.b",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Explode_record = createTests(
-  "/routes/label/standard/record.a=1.b=2",
+  "/routes/path/label/explode/record.a=1.b=2",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Standard_primitive = createTests(
-  "/routes/matrix/standard/primitive;a",
+  "/routes/path/matrix/standard/primitive;param=a",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Standard_array = createTests(
-  "/routes/matrix/standard/array;a,b",
+  "/routes/path/matrix/standard/array;param=a,b",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Standard_record = createTests(
-  "/routes/matrix/standard/record;a,1,b,2",
+  "/routes/path/matrix/standard/record;param=a,1,b,2",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Explode_primitive = createTests(
-  "/routes/matrix/standard/primitive;a",
+  "/routes/path/matrix/explode/primitive;param=a",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Explode_array = createTests(
-  "/routes/matrix/standard/array;a;b",
+  "/routes/path/matrix/explode/array;param=a;param=b",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Explode_record = createTests(
-  "/routes/matrix/standard/record;a=1;b=2",
+  "/routes/path/matrix/explode/record;a=1;b=2",
 );
 Scenarios.Routes_QueryParameters_templateOnly = createTests("/routes/query/template-only?param=a");
 Scenarios.Routes_QueryParameters_explicit = createTests("/routes/query/explicit?param=a");

package/specs/type/dictionary/mockapi.ts

@@ -23,6 +23,12 @@ function createServerTests(uri: string, data: any) {
       response: {
         status: 204,
       },
+      handler: (req) => {
+        req.expect.coercedBodyEquals(data);
+        return {
+          status: 204,
+        };
+      },
       kind: "MockApiDefinition",
     }),
   };

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

@@ -11,24 +11,28 @@ namespace Type.Model.Visibility;
 @doc("Output model with visibility properties.")
 model VisibilityModel {
   @doc("Required string, illustrating a readonly property.")
-  @visibility("read")
+  @visibility(Lifecycle.Read)
   readProp: string;
 
   @doc("Required int32, illustrating a query property.")
-  @visibility("query")
+  @visibility(Lifecycle.Query)
   queryProp: int32;
 
   @doc("Required string[], illustrating a create property.")
-  @visibility("create")
+  @visibility(Lifecycle.Create)
   createProp: string[];
 
   @doc("Required int32[], illustrating a update property.")
-  @visibility("update")
+  @visibility(Lifecycle.Update)
   updateProp: int32[];
 
   @doc("Required bool, illustrating a delete property.")
-  @visibility("delete")
+  @visibility(Lifecycle.Delete)
   deleteProp: boolean;
+
+  @doc("Property that does not exist in any payload.")
+  @invisible(Lifecycle)
+  noneProp: "none";
 }
 
 /** RoundTrip model with readonly optional properties. */

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

@@ -1,4 +1,4 @@
-import { json, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
@@ -119,6 +119,13 @@ function createServerTests(url: string, value: any) {
       response: {
         status: 204,
       },
+      handler: (req: MockRequest) => {
+        const expectedBody = JSON.parse(JSON.stringify(value));
+        req.expect.coercedBodyEquals(expectedBody);
+        return {
+          status: 204,
+        };
+      },
       kind: "MockApiDefinition",
     }),
   };

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

@@ -29,6 +29,15 @@ function createServerTests(url: string, value: unknown, patchNullableProperty?:
       response: {
         status: 204,
       },
+      handler: (req) => {
+        req.expect.coercedBodyEquals({
+          requiredProperty: "foo",
+          nullableProperty: patchNullableProperty || null,
+        });
+        return {
+          status: 204,
+        };
+      },
       kind: "MockApiDefinition",
     }),
   };

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

@@ -23,6 +23,12 @@ function createServerTests(url: string, value: unknown) {
       response: {
         status: 204,
       },
+      handler: (req) => {
+        req.expect.coercedBodyEquals(value);
+        return {
+          status: 204,
+        };
+      },
       kind: "MockApiDefinition",
     }),
   };

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

@@ -23,6 +23,12 @@ function createServerTests(url: string, data: unknown) {
       response: {
         status: 204,
       },
+      handler: (req) => {
+        req.expect.coercedBodyEquals(data);
+        return {
+          status: 204,
+        };
+      },
       kind: "MockApiDefinition",
     }),
   };

package/specs/versioning/removed/main.tsp

@@ -21,7 +21,7 @@ using TypeSpec.Versioning;
     endpoint: url,
 
     /**
-     * Need to be set as 'v1' or 'v2' in client.
+     * Need to be set as 'v1', 'v2preview' or 'v2' in client.
      */
     version: Versions,
   }
@@ -37,6 +37,11 @@ enum Versions {
    */
   v1: "v1",
 
+  /**
+   * The V2 Preview version.
+   */
+  v2preview: "v2preview",
+
   /**
    * The version v2.
    */
@@ -67,6 +72,14 @@ model ModelV2 {
   unionProp: UnionV2;
 }
 
+model ModelV3 {
+  id: string;
+
+  @removed(Versions.v2preview)
+  @added(Versions.v2)
+  enumProp: EnumV3;
+}
+
 enum EnumV2 {
   @removed(Versions.v2)
   enumMemberV1,
@@ -74,6 +87,14 @@ enum EnumV2 {
   enumMemberV2,
 }
 
+enum EnumV3 {
+  @removed(Versions.v2preview)
+  @added(Versions.v2)
+  enumMemberV1,
+
+  enumMemberV2Preview,
+}
+
 @removed(Versions.v2)
 union UnionV1 {
   string,
@@ -124,3 +145,44 @@ interface InterfaceV1 {
   @route("/v1")
   v1InInterface(@body body: ModelV1): ModelV1;
 }
+
+/** This operation will pass different paths and different request bodies based on different versions. */
+@scenario
+@scenarioDoc("""
+  path: "/versioning/removed/api-version[:]v1/v3"
+  Expected request body:
+  ```json
+  { "id": "123", "enumProp": "enumMemberV1" }
+  ```
+  
+  Expected response body:
+  ```json
+  { "id": "123", "enumProp": "enumMemberV1" }
+  ```
+  
+  path: "/versioning/removed/api-version[:]v2preview/v3"
+  Expected request body:
+  ```json
+  { "id": "123"}
+  ```
+  
+    Expected response body:
+  ```json
+  { "id": "123"}
+  ```
+  
+  path: "/versioning/removed/api-version[:]v2/v3"
+  Expected request body:
+  ```json
+  { "id": "123", "enumProp": "enumMemberV1" }
+  ```
+  
+    Expected response body:
+  ```json
+  { "id": "123", "enumProp": "enumMemberV1" }
+  ```
+  
+  """)
+@post
+@route("/v3")
+op modelV3(@body body: ModelV3): ModelV3;

package/specs/versioning/removed/mockapi.ts

@@ -18,3 +18,50 @@ Scenarios.Versioning_Removed_v2 = passOnSuccess({
   },
   kind: "MockApiDefinition",
 });
+
+Scenarios.Versioning_Removed_modelV3 = passOnSuccess({
+  uri: `/versioning/removed/api-version[:]v1/v3`,
+  method: "post",
+  request: {
+    body: {
+      id: "123",
+      enumProp: "enumMemberV1",
+    },
+  },
+  response: {
+    status: 200,
+    body: json({ id: "123", enumProp: "enumMemberV1" }),
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Versioning_Removed_modelV3_V2 = passOnSuccess({
+  uri: `/versioning/removed/api-version[:]v2/v3`,
+  method: "post",
+  request: {
+    body: {
+      id: "123",
+      enumProp: "enumMemberV1",
+    },
+  },
+  response: {
+    status: 200,
+    body: json({ id: "123", enumProp: "enumMemberV1" }),
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Versioning_Removed_modelV3_V2preview = passOnSuccess({
+  uri: `/versioning/removed/api-version[:]v2preview/v3`,
+  method: "post",
+  request: {
+    body: {
+      id: "123",
+    },
+  },
+  response: {
+    status: 200,
+    body: json({ id: "123" }),
+  },
+  kind: "MockApiDefinition",
+});