helpers/zod: fix type on props parameter and add test (#1018)

openai · Aug 29, 2024 · 3f12b92 · 3f12b92
1 parent 8243907
commit 3f12b92
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/src/helpers/zod.ts b/src/helpers/zod.ts
@@ -58,7 +58,7 @@ function zodToJsonSchema(schema: z.ZodType, options: { name: string }): Record<s
 export function zodResponseFormat<ZodInput extends z.ZodType>(
   zodObject: ZodInput,
   name: string,
-  props?: Omit<ResponseFormatJSONSchema, 'schema' | 'strict' | 'name'>,
+  props?: Omit<ResponseFormatJSONSchema.JSONSchema, 'schema' | 'strict' | 'name'>,
 ): AutoParseableResponseFormat<z.infer<ZodInput>> {
   return makeParseableResponseFormat(
     {

diff --git a/tests/helpers/zod.test.ts b/tests/helpers/zod.test.ts
@@ -132,6 +132,18 @@ describe('zodResponseFormat', () => {
     `);
   });
 
+  it('allows description field to be passed in', () => {
+    expect(
+      zodResponseFormat(
+        z.object({
+          city: z.string(),
+        }),
+        'city',
+        { description: 'A city' },
+      ).json_schema,
+    ).toHaveProperty('description', 'A city');
+  });
+
   test('kitchen sink types', () => {
     const Table = z.enum(['orders', 'customers', 'products']);