Optional Query Parameter Test

.changeset/rich-comics-draw.md

@@ -0,0 +1,5 @@
+---
+"@azure-tools/cadl-ranch-specs": minor
+---
+
+Add test in parameters/query-optional.

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

@@ -2549,6 +2549,35 @@ This test is testing sending a ssv collection format array query parameters
 
 This test is testing sending a tsv collection format array query parameters
 
+### Parameters_QueryOptionality_FromOptional
+
+- Endpoint: `head /parameters/query-optionality/fromoptional`
+
+Test another existing scenario where the query optional parameter is placed before the required parameter, but in the generated code, the required parameter still appears before the optional parameter.
+
+Should generate an operation like below:
+
+```
+fromoptional(end: string, start?: string)
+```
+
+Expected query parameter: end=required
+
+### Parameters_QueryOptionality_FromRequired
+
+- Endpoint: `head /parameters/query-optionality/fromrequired`
+
+Test scenarios for using a combination of required and optional query parameters.
+
+Should generate an operation like below:
+
+```
+fromRequired(start: string, end?: string)
+```
+
+Expected query parameter: api-version=2022-12-01-preview
+Expected query parameter: start=required
+
 ### Parameters_Spread_Alias_spreadAsRequestBody
 
 - Endpoint: `put /parameters/spread/alias/request-body`

packages/cadl-ranch-specs/http/parameters/query-optionality/main.tsp

@@ -0,0 +1,59 @@
+import "@azure-tools/cadl-ranch-expect";
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-client-generator-core";
+import "@typespec/http";
+import "@typespec/rest";
+import "@typespec/versioning";
+
+using TypeSpec.Http;
+using Azure.Core;
+using global.Azure.Core.Traits;
+using Azure.ClientGenerator.Core;
+using TypeSpec.Versioning;
+
+#suppress "@azure-tools/typespec-azure-core/casing-style" "For spec"
+@doc("Test describing optionality of the query.")
+@scenarioService(
+  "/parameters/query-optionality",
+  {
+    versioned: Versions,
+  }
+)
+namespace Parameters.QueryOptionality;
+
+@doc("The API version.")
+enum Versions {
+  @doc("The 2022-12-01-preview version.")
+  @useDependency(global.Azure.Core.Versions.v1_0_Preview_2)
+  v2022_12_01_preview: "2022-12-01-preview",
+}
+
+@scenario
+@scenarioDoc("""
+  Test scenarios for using a combination of required and optional query parameters.
+
+  Should generate an operation like below:
+    ```
+    fromRequired(start: string, end?: string)
+    ```
+
+  Expected query parameter: api-version=2022-12-01-preview
+  Expected query parameter: start=required
+  """)
+@route("/fromrequired")
+@head
+op FromRequired(@query start: string, @query end?: string, @query("api-version") apiVersion: string): void;
+
+@scenario
+@scenarioDoc("""
+  Test another existing scenario where the query optional parameter is placed before the required parameter, but in the generated code, the required parameter still appears before the optional parameter.
+
+  Should generate an operation like below:
+    ```
+    fromoptional(end: string, start?: string)
+    ```
+  Expected query parameter: end=required
+  """)
+@route("/fromoptional")
+@head
+op FromOptional(@query start?: string, @query end: string): void;

packages/cadl-ranch-specs/http/parameters/query-optionality/mockapi.ts

@@ -0,0 +1,19 @@
+import { passOnSuccess, mockapi, json } from "@azure-tools/cadl-ranch-api";
+import { ScenarioMockApi } from "@azure-tools/cadl-ranch-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Parameters_QueryOptionality_FromRequired = passOnSuccess(
+  mockapi.head("/parameters/query-optionality/fromrequired", (req) => {
+    req.expect.containsQueryParam("api-version", "2022-12-01-preview");
+    req.expect.containsQueryParam("start", "required");
+    return { status: 204 };
+  }),
+);
+
+Scenarios.Parameters_QueryOptionality_FromOptional = passOnSuccess(
+  mockapi.head("/parameters/query-optionality/fromoptional", (req) => {
+    req.expect.containsQueryParam("end", "required");
+    return { status: 204 };
+  }),
+);