refactor: resolveParams with example strategy

Author: omermecitoglu

src/core/definer.ts

@@ -110,8 +110,8 @@ function defineRoute<
   };
 
   const parameters = [
-    ...resolveParams("path", input.pathParams),
-    ...resolveParams("query", input.queryParams),
+    ...resolveParams("path", input.exampleStrategy ?? "none", input.pathParams),
+    ...resolveParams("query", input.exampleStrategy ?? "none", input.queryParams),
   ];
 
   const responses = bundleResponses(input.responses);

src/core/params.test.ts

@@ -5,14 +5,14 @@ import type { ParameterObject } from "@omer-x/openapi-types/parameter";
 
 describe("resolveParams", () => {
   it("should return an empty array if source is not provided", () => {
-    const result = resolveParams("query", undefined);
+    const result = resolveParams("query", "none", undefined);
     expect(result).toEqual([]);
   });
 
   it("should throw an error if the schema does not have properties", () => {
     const zodSchema = z.string();
 
-    expect(() => resolveParams("query", zodSchema)).toThrow("Invalid object schema");
+    expect(() => resolveParams("query", "none", zodSchema)).toThrow("Invalid object schema");
   });
 
   it("should resolve parameters for a valid Zod object schema", () => {
@@ -21,7 +21,7 @@ describe("resolveParams", () => {
       includeDetails: z.boolean().optional().describe("Whether to include user details"),
     });
 
-    const result = resolveParams("query", zodSchema);
+    const result = resolveParams("query", "none", zodSchema);
 
     const expectedParams: ParameterObject[] = [
       {
@@ -55,7 +55,7 @@ describe("resolveParams", () => {
       includeDetails: z.boolean().optional().describe("Whether to include user details"),
     });
 
-    const result = resolveParams("query", zodSchema);
+    const result = resolveParams("query", "none", zodSchema);
 
     const expectedParams: ParameterObject[] = [
       {

src/core/params.ts

@@ -1,8 +1,10 @@
+import type { ExampleStrategy } from "~/types/example";
+import { injectExample } from "./example";
 import convertToOpenAPI from "./zod-to-openapi";
 import type { ParameterObject } from "@omer-x/openapi-types/parameter";
 import type { ZodType } from "zod";
 
-export function resolveParams(kind: ParameterObject["in"], source?: ZodType<unknown>) {
+export function resolveParams(kind: ParameterObject["in"], exampleStrategy: ExampleStrategy, source?: ZodType<unknown>) {
   if (!source) return [];
   const schema = convertToOpenAPI(source, false);
   if (!("properties" in schema)) throw new Error("Invalid object schema");
@@ -13,5 +15,6 @@ export function resolveParams(kind: ParameterObject["in"], source?: ZodType<unkn
     required: schema.required?.includes(name) ?? false,
     description: definition.description,
     schema: definition,
+    ...injectExample(exampleStrategy, source, false),
   }));
 }