Skip to content

Commit

Permalink
Merge branch 'enhance-example-types' of github.com:samchungy/zod-open…
Browse files Browse the repository at this point in the history
…api into enhance-example-types
  • Loading branch information
samchungy committed Dec 14, 2024
2 parents 912c8d4 + 24fe23f commit b70430f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ Wherever `title` is used in schemas across the document, it will instead be crea
}
```

This can be an extremely powerful way to create less repetitive Open API documentation. There are some Open API features like [discriminator mapping](https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/) which require all schemas in the union to contain a ref.
This is a great way to create less repetitive Open API documentation. There are some Open API features like [discriminator mapping](https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/) which require all schemas in the union to contain a ref.

##### Manually Registering Schema

Expand All @@ -468,7 +468,7 @@ createDocument({
});
```

Unfortunately, as a limitation of this library, you will need to attach an `.openapi()` field or `.describe()` to the schema that you are passing into the components or else you may not get the full power of the component generation. As a result, I recommend utilising the auto registering components over manual registration.
Unfortunately, as a limitation of this library, you will need to attach an `.openapi()` field or `.describe()` to the schema that you are passing into the components or you will not reap the full benefits of component generation. As a result, I recommend utilising the auto registering components over manual registration.

#### Parameters

Expand Down

0 comments on commit b70430f

Please sign in to comment.