search

OAI / Overlay-Specification

The OAI Overlay Specification
Apache License 2.0
60 stars 15 forks source link

Add compliant example sets to show expected behaviour #99

Open lornajane opened 6 days ago

lornajane commented 6 days ago

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!

ralfhandl commented 6 days ago

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.

ralfhandl commented 6 days ago

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.

lornajane commented 6 days ago

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?

ralfhandl commented 6 days ago

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.