Add compliant example sets to show expected behaviour
These examples are taken from the test suite of https://github.com/lornajane/openapi-overlays-js (and with thanks to @MikeRalphson who helped with the tests originally!) to illustrate the expected outputs from applying particular Overlays to OpenAPI descriptions.
I think these examples could be improved/expanded, and I'm not sure if we should try to somehow standardise how whitespace/quotes work because they are most of the diff. Would it make sense to lint/format all the yaml? Advice welcome!
we should try to somehow standardise how whitespace/quotes work because they are most of the diff
I'd run Prettier on the YAML files to minimize these differences.
There should also be JSON inputs.
And some "mixed" inputs with OpenAPI JSON and Overlay YAML, and vice versa. Would the output format be determined by the format of the OpenAPI input? The spec doesn't tell.
Fair enough. I don't think these are of a quality that we can publish for tests but from our conversation yesterday I thought we agreed that sharing whatever we had would be useful at this stage. Should I just close?
Don't close, I think these are a good starting point. Even if they aren't complete yet, they are behavior that we expect from each implementation.
This change is super useful, even in it's current state. I am building a ruby library against this right now ♥️
@ahx thanks for the encouraging words! I've updated the PR and re-requested reviews for it.
This looks really great and would really like to see it approved.
@ralfhandl Could you check if these were the changes you had in mind?