Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add readme explanation about ajv coerceTypes configuration #110

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix: add readme explanation about ajv coerceTypes configuration #110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
670adcc
fix: add readme explanation about ajv coerceTypes configuration
gal-cohen-payu-gpo Jan 13, 2025
209b9e3
fix: add readme explanation about ajv coerceTypes configuration
gal-cohen-payu-gpo Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ Arguments, options and response are the same as for the `buildSchemaSync` method

- Objects - it is important to set any objects with the property `type: object` inside your swagger file, although it isn't a must in the Swagger (OpenAPI) spec in order to validate it accurately with [ajv](https://www.npmjs.com/package/ajv) it must be marked as `object`
- Response validator does not support readOnly attribute

- It uses the Ajv `coerceTypes: "array"` flag, which enables type coercion for fields defined as arrays in the schema. This means values will be automatically parsed into arrays when possible. For example, `1` becomes `[1]`, and `"[1,2,3]"` becomes `[1, 2, 3]`.
## Open api 3 - known issues
- supporting inheritance with discriminator , only if the ancestor object is the discriminator.
- The discriminator supports in the inheritance chain stop when getting to a child with no discriminator (a leaf in the inheritance tree), meaning a leaf can't have a field which starts a new inheritance tree.
Expand Down
Loading