[@azure-tools/cadl-ranch-specs] - Handle PassOnCode, Remove Handler & Remove commonapi.ts file

.changeset/poor-deers-happen.md

@@ -0,0 +1,6 @@
+---
+"@azure-tools/cadl-ranch-specs": minor
+"@azure-tools/cadl-ranch": minor
+---
+
+Remove handler code and commonapi file

packages/cadl-ranch-specs/cadl-ranch-summary.md

@@ -79,12 +79,12 @@ Expects header 'authorization': 'Bearer https://security.microsoft.com/.default'
   - `get /azure/client-generator-core/access/internalOperation/publicDecoratorInInternal`
 
 This scenario contains internal operations. All should be generated but not exposed.
-Expected query parameter: name=<any string>
+Expected query parameter: name= "sample"
 Expected response body:
 
 ```json
 {
-  "name": <any string>
+  "name": "sample"
 }
 ```
 
@@ -95,12 +95,12 @@ Expected response body:
   - `get /azure/client-generator-core/access/publicOperation/publicDecoratorInPublic`
 
 This scenario contains public operations. It should be generated and exported.
-Expected query parameter: name=<any string>
+Expected query parameter: name="sample"
 Expected response body:
 
 ```json
 {
-  "name": <any string>
+  "name": "sample"
 }
 ```
 
@@ -119,12 +119,12 @@ This scenario contains internal operations. All should be generated but not expo
   - `get /azure/client-generator-core/access/sharedModelInOperation/internal`
 
 This scenario contains two operations, one public, another internal. The public one should be generated and exported while the internal one should be generated but not exposed.
-Expected query parameter: name=<any string>
+Expected query parameter: name= "sample"
 Expected response body:
 
 ```json
 {
-  "name": <any string>
+  "name": "sample"
 }
 ```
 

packages/cadl-ranch-specs/http/authentication/api-key/mockapi.ts

@@ -1,4 +1,4 @@
-import { json, MockRequest, passOnCode, passOnSuccess } from "@azure-tools/cadl-ranch-api";
+import { json, passOnCode, passOnSuccess } from "@azure-tools/cadl-ranch-api";
 import { ScenarioMockApi } from "@azure-tools/cadl-ranch-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
@@ -14,10 +14,6 @@ Scenarios.Authentication_ApiKey_valid = passOnSuccess({
   response: {
     status: 204,
   },
-  handler: (req: MockRequest) => {
-    req.expect.containsHeader("x-ms-api-key", "valid-key");
-    return { status: 204 };
-  },
   kind: "MockApiDefinition",
 });
 
@@ -36,13 +32,5 @@ Scenarios.Authentication_ApiKey_invalid = passOnCode(403, {
       error: "invalid-api-key",
     }),
   },
-  handler: (req: MockRequest) => {
-    return {
-      status: 403,
-      body: json({
-        error: "invalid-api-key",
-      }),
-    };
-  },
   kind: "MockApiDefinition",
 });

packages/cadl-ranch-specs/http/authentication/http/custom/mockapi.ts

@@ -1,4 +1,4 @@
-import { json, MockRequest, passOnSuccess, passOnCode } from "@azure-tools/cadl-ranch-api";
+import { json, passOnSuccess, passOnCode } from "@azure-tools/cadl-ranch-api";
 import { ScenarioMockApi } from "@azure-tools/cadl-ranch-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
@@ -14,10 +14,6 @@ Scenarios.Authentication_Http_Custom_valid = passOnSuccess({
   response: {
     status: 204,
   },
-  handler: (req: MockRequest) => {
-    req.expect.containsHeader("authorization", "SharedAccessKey valid-key");
-    return { status: 204 };
-  },
   kind: "MockApiDefinition",
 });
 
@@ -36,13 +32,5 @@ Scenarios.Authentication_Http_Custom_invalid = passOnCode(403, {
       error: "invalid-api-key",
     }),
   },
-  handler: (req: MockRequest) => {
-    return {
-      status: 403,
-      body: json({
-        error: "invalid-api-key",
-      }),
-    };
-  },
   kind: "MockApiDefinition",
 });

packages/cadl-ranch-specs/http/authentication/oauth2/mockapi.ts

@@ -1,4 +1,4 @@
-import { json, MockRequest, passOnSuccess, passOnCode } from "@azure-tools/cadl-ranch-api";
+import { json, passOnSuccess, passOnCode } from "@azure-tools/cadl-ranch-api";
 import { ScenarioMockApi } from "@azure-tools/cadl-ranch-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
@@ -14,10 +14,6 @@ Scenarios.Authentication_OAuth2_valid = passOnSuccess({
   response: {
     status: 204,
   },
-  handler: (req: MockRequest) => {
-    req.expect.containsHeader("authorization", "Bearer https://security.microsoft.com/.default");
-    return { status: 204 };
-  },
   kind: "MockApiDefinition",
 });
 
@@ -33,13 +29,5 @@ Scenarios.Authentication_OAuth2_invalid = passOnCode(403, {
       error: "invalid-grant",
     }),
   },
-  handler: (req: MockRequest) => {
-    return {
-      status: 403,
-      body: json({
-        error: "invalid-grant",
-      }),
-    };
-  },
   kind: "MockApiDefinition",
 });

packages/cadl-ranch-specs/http/authentication/union/mockapi.ts

@@ -1,4 +1,4 @@
-import { passOnSuccess, MockRequest } from "@azure-tools/cadl-ranch-api";
+import { passOnSuccess } from "@azure-tools/cadl-ranch-api";
 import { ScenarioMockApi } from "@azure-tools/cadl-ranch-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
@@ -14,10 +14,6 @@ Scenarios.Authentication_Union_validKey = passOnSuccess({
   response: {
     status: 204,
   },
-  handler: (req: MockRequest) => {
-    req.expect.containsHeader("x-ms-api-key", "valid-key");
-    return { status: 204 };
-  },
   kind: "MockApiDefinition",
 });
 
@@ -32,9 +28,5 @@ Scenarios.Authentication_Union_validToken = passOnSuccess({
   response: {
     status: 204,
   },
-  handler: (req: MockRequest) => {
-    req.expect.containsHeader("authorization", "Bearer https://security.microsoft.com/.default");
-    return { status: 204 };
-  },
   kind: "MockApiDefinition",
 });

packages/cadl-ranch-specs/http/azure/client-generator-core/access/main.tsp

@@ -15,11 +15,11 @@ namespace _Specs_.Azure.ClientGenerator.Core.Access;
 @scenario
 @scenarioDoc("""
   This scenario contains public operations. It should be generated and exported.
-  Expected query parameter: name=<any string>
+  Expected query parameter: name="sample"
   Expected response body:
   ```json
   {
-    "name": <any string>
+    "name": "sample"
   }
   ```
   """)
@@ -51,11 +51,11 @@ namespace PublicOperation {
 @scenario
 @scenarioDoc("""
   This scenario contains internal operations. All should be generated but not exposed.
-  Expected query parameter: name=<any string>
+  Expected query parameter: name= "sample"
   Expected response body:
   ```json
   {
-    "name": <any string>
+    "name": "sample"
   }
   ```
   """)
@@ -98,11 +98,11 @@ namespace InternalOperation {
 @scenario
 @scenarioDoc("""
   This scenario contains two operations, one public, another internal. The public one should be generated and exported while the internal one should be generated but not exposed.
-  Expected query parameter: name=<any string>
+  Expected query parameter: name= "sample"
   Expected response body:
   ```json
   {
-    "name": <any string>
+    "name":  "sample"
   }
   ```
   """)
@@ -157,14 +157,14 @@ namespace RelativeModelInOperation {
   }
 
   @doc("""
-    Expected query parameter: name=<any string>
+    Expected query parameter: name="Madge"
     Expected response body:
     ```json
     {
-      "name": <any string>,
+      "name": "Madge",
       "inner":
       {
-        "name": <any string>
+        "name": "Madge"
       }
     }
     ```
@@ -175,11 +175,11 @@ namespace RelativeModelInOperation {
   op operation(@query name: string): OuterModel;
 
   @doc("""
-    Expected query parameter: kind=<any string>
+    Expected query parameter: kind= "real"
     Expected response body:
     ```json
     {
-      "name": <any string>,
+      "name": "Madge",
       "kind": "real"
     }
     ```

packages/cadl-ranch-specs/http/azure/client-generator-core/access/mockapi.ts

@@ -1,4 +1,4 @@
-import { passOnSuccess, ValidationError, json, MockApiDefinition, MockRequest } from "@azure-tools/cadl-ranch-api";
+import { passOnSuccess, json, MockApiDefinition } from "@azure-tools/cadl-ranch-api";
 import { ScenarioMockApi } from "@azure-tools/cadl-ranch-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
@@ -16,15 +16,6 @@ function createMockApiDefinitions(route: string): MockApiDefinition {
       status: 200,
       body: json({ name: "sample" }),
     },
-    handler: (req: MockRequest) => {
-      if (!("name" in req.query)) {
-        throw new ValidationError("Should submit name query", "any string", undefined);
-      }
-      return {
-        status: 200,
-        body: json({ name: req.query["name"] }),
-      };
-    },
     kind: "MockApiDefinition",
   };
 }
@@ -58,15 +49,6 @@ Scenarios.Azure_ClientGenerator_Core_Access_RelativeModelInOperation = passOnSuc
       status: 200,
       body: json({ name: "Madge", inner: { name: "Madge" } }),
     },
-    handler: (req: MockRequest) => {
-      if (!("name" in req.query)) {
-        throw new ValidationError("Should submit name query", "any string", undefined);
-      }
-      return {
-        status: 200,
-        body: json({ name: "Madge", inner: { name: "Madge" } }),
-      };
-    },
     kind: "MockApiDefinition",
   },
   {
@@ -81,15 +63,6 @@ Scenarios.Azure_ClientGenerator_Core_Access_RelativeModelInOperation = passOnSuc
       status: 200,
       body: json({ name: "Madge", kind: "real" }),
     },
-    handler: (req: MockRequest) => {
-      if (!("kind" in req.query)) {
-        throw new ValidationError("Should submit name query", "any string", undefined);
-      }
-      return {
-        status: 200,
-        body: json({ name: "Madge", kind: "real" }),
-      };
-    },
     kind: "MockApiDefinition",
   },
 ]);

packages/cadl-ranch-specs/http/azure/client-generator-core/flatten-property/mockapi.ts

@@ -1,4 +1,4 @@
-import { passOnSuccess, json, MockApiDefinition, MockRequest } from "@azure-tools/cadl-ranch-api";
+import { passOnSuccess, json, MockApiDefinition } from "@azure-tools/cadl-ranch-api";
 import { ScenarioMockApi } from "@azure-tools/cadl-ranch-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
@@ -13,13 +13,6 @@ function createMockApiDefinitions(route: string, request: any, response: any): M
       status: 200,
       body: json(response),
     },
-    handler: (req: MockRequest) => {
-      req.expect.bodyEquals(request);
-      return {
-        status: 200,
-        body: json(response),
-      };
-    },
     kind: "MockApiDefinition",
   };
 }

packages/cadl-ranch-specs/http/azure/client-generator-core/usage/main.tsp

@@ -28,7 +28,7 @@ namespace ModelInOperation {
     Expected body parameter: 
     ```json
     {
-      "name": <any string>
+      "name": "Madge"
     }
     ```
     """)
@@ -48,7 +48,7 @@ namespace ModelInOperation {
     Expected response body: 
     ```json
     {
-      "name": <any string>
+      "name": "Madge"
     }
     ```
     """)
@@ -78,7 +78,7 @@ namespace ModelInOperation {
     ```json
     {
       "result": {
-        "name": <any string>
+        "name": "Madge"
       }
     }
     ```