Comments (4)
Would you like to send a Pull Request to address this issue? Remember to add unit tests.
from fluent-json-schema.
I've seen this in fluent-schema's code:
https://github.com/fastify/fluent-schema/blob/b5a5c80334529a2febcc4b3a54b35f5680752e3a/src/BaseSchema.js#L180
/**
* Required has to be chained to a property:
* Examples:
* - S.prop('prop').required()
* - S.prop('prop', S.number()).required()
* - S.required(['foo', 'bar'])
But in the README.md it's used like this:
.prop(
'email',
S.string()
.format(S.FORMATS.EMAIL)
.required() // <- It's not chained to `prop` call !
)
I'm wondering which one is correct?
from fluent-json-schema.
The correct schema is:
S.object()
.prop(
'perm',
S.object()
.required()
.prop('admin', S.boolean())
.prop('comment', S.boolean())
)
.valueOf()
If you put required()
after a property definition it's attached to the last property declared ( comment
in this case )
The README is correct because in the case of the String.format('EMAIL').required()
there isn't a property so we attach required
to the root element.
Given that I agree the README is a bit misleading perhaps we could put String.required().format('EMAIL')
to be more consistent. Also, we could add in the main example a required object so we can show the correct syntax.
from fluent-json-schema.
Thanks very much! I'll close this issue now.
from fluent-json-schema.
Related Issues (20)
- Root level `required` creates invalid schema HOT 8
- Support "dependentrequired" and "dependentSchemas" HOT 5
- Support JSON Schema 2019-09 deprecated value HOT 4
- npm package does not match github repo HOT 3
- additionalProperties schemas causing unexpected behavior when passed to oneOf HOT 3
- How we can omit fields from request body that is not defined in the schema.
- .string() method validate all type values HOT 2
- 100 % code coverage HOT 1
- Set $id after clone HOT 7
- Conditional property is not allowed when using additionalProperties(false) HOT 3
- Unable to import in TS project with "moduleResolution": "NodeNext", HOT 12
- validate GET array of array param HOT 2
- Crashes on import HOT 2
- Nullable false not working HOT 1
- Object schema does not carry properties added by .raw() to a $ref HOT 3
- Object type ignored when nested properties use oneOf and raw HOT 11
- ReferenceError: Cannot access 'User' before initialization HOT 1
- Migrate test suite from `jest` to `node:test` HOT 4
- ObjectSchema.extend Does not return a schema instance HOT 3
- Add Support for custom format input
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from fluent-json-schema.