You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Interesting. I didn't know arbitrary keys are allowed in Schema Objects. Could you share where exactly in the specification this is mentioned?
Anyway, I'm not sure if it makes sense to allow arbitrary properties in the Schema Object when linting OAS descriptions, as it makes it harder to detect typos and other mistakes.
@tatomyr Thanks for the quick response! Here's the ref from the spec.
Typos would still be detected in most cases since schema definitions would be missing required properties. Obviously my preference here is that ReDocly strictly adheres to the specification by default 🙏 (rules can always toggle certain behaviors)
I'm still not sure if we want to change the behaviour. Let's wait until we get more votes for that.
Meanwhile, you can tweak the behaviour by supplying the type extension via a plugin. I understand it won't change the default settings but most users don't need those additional keys (or they can use specification extensions instead; BTW, could the specification extension cover your case?).
Describe the bug
For OAS 3.1, arbitrary keywords within schemas produce lint errors. This contradicts the 3.1 specification.
To Reproduce
Using
minimal
, this example spec from OpenAPI fails linting when it should pass.Expected behavior
The spec should pass linting.
Logs
OpenAPI description
3.1
Redocly Version(s)
@redocly/openapi-core@1.12.0
The text was updated successfully, but these errors were encountered: