fix: schema-path handles falsy values and JSON path expression as field #917
Conversation
P0lip
changed the title
| expect(runSchemaPath(target, fieldToCheck, path)).toEqual([ | ||
| { | ||
| path: ['example'], | ||
| message: '{{property|gravis|append-property|optional-typeof}}type should be string', |
There was a problem hiding this comment.
What is this syntax? Does type need a space before it?
There was a problem hiding this comment.
It's replaced at runtime, when Spectral processes messages returned by functions.
| acts kind of like the unix pipe.
So in this case, this is what happens:
propertyprints the property namegravisis a function that decorates a property with gravises (\property``)append-propertyadds\${property} property`` if there is a property or return empty string if there is no property- optional-typeof prints a type of linted value if
append-propertyreturned an empty string or the result of append-property.
I know this sounds weird, but so perhaps a note in documentation would be nice to have?
What user receives is something like
message: '`example` property type should be number',
or
message: `number should be equal to one of the allowed values: 1, 3, 5, 10, 12`,
That does make sense?
There was a problem hiding this comment.
If this is something users should know about then please let's document it.
There was a problem hiding this comment.
This also confused me a lot when working on my recent PRs....
There was a problem hiding this comment.
If this is something users should know about then please let's document it.
Will do!
This also confused me a lot when working on my recent PRs....
My apologies! Going to document that syntax this week.
| ]); | ||
| }); | ||
|
|
||
| it('given non-existing property, returns the whole document', () => { |
There was a problem hiding this comment.
@P0lip Either the test title is misleading or there's something I don't understand. Where is the "whole document" in the provided output?
There was a problem hiding this comment.
ah, I should have stated input
Fixes #916
Checklist
Does this PR introduce a breaking change?