Skip to content

Commit e8ce236

Browse files
author
Stefan Terdell
committed
📝 Add "describe" to readme example
1 parent 5ec2789 commit e8ce236

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

readme.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import zodToJsonSchema from "zod-to-json-schema";
2121
const mySchema = z.object({
2222
myString: z.string().min(5),
2323
myUnion: z.union([z.number(), z.boolean()]),
24-
});
24+
}).describe("My neat object schema");
2525

2626
const jsonSchema = zodToJsonSchema(mySchema, "mySchema");
2727
```
@@ -34,6 +34,7 @@ const jsonSchema = zodToJsonSchema(mySchema, "mySchema");
3434
"$ref": "#/definitions/mySchema",
3535
"definitions": {
3636
"mySchema": {
37+
"description": "My neat object schema",
3738
"type": "object",
3839
"properties": {
3940
"myString": {

test/readme.test.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ describe('The readme example', () => {
66
const mySchema = z.object({
77
myString: z.string().min(5),
88
myUnion: z.union([z.number(), z.boolean()]),
9-
});
9+
}).describe("My neat object schema");
1010

1111
const jsonSchema = zodToJsonSchema(mySchema, 'mySchema');
1212

@@ -15,6 +15,7 @@ describe('The readme example', () => {
1515
$ref: '#/definitions/mySchema',
1616
definitions: {
1717
mySchema: {
18+
description: "My neat object schema",
1819
type: 'object',
1920
properties: {
2021
myString: {

0 commit comments

Comments
 (0)