Add support for OpenAPI overlays

[TristanSpeakEasy]

Would love to see support for https://github.com/OAI/Overlay-Specification/blob/main/versions/1.0.0.md

[daveshanley]

Good suggestion! adding to the backlog.

[daveshanley]

I've been thinking more about this. I've looked into the syntax, and it's kinda crazy.

Is there much support for Overlays? I don't see much of it myself.

I think there are better ways to cover the use cases that overlays would provide when adding, removing or modifyingm or creating 'sub renders'

[jamietanna]

I think there are better ways to cover the use cases that overlays would provide when adding, removing or modifyingm or creating 'sub renders'

What would you be thinking? 👀

oapi-codegen/oapi-codegen#1553 is where we're considering this, as a common issue folks have is that they can't modify the source spec before generation, or it's a pain to modify it from the upstream, and as upstream spec changes, they have to re-apply patches

From what I can tell, https://github.com/speakeasy-api/speakeasy/tree/main/internal/overlay is Speakeasy's implementation (which we'd consider vendoring into oapi-codegen)

[TristanSpeakEasy]

Just to add to this we are seeing a huge amount of usage of overlays these days as most customers do want to keep their spec pure because they are generating it from code.

It would definitely be great to see support in Libopenapi though as that would give us hopefully relevant line numbers to either the spec or overlay when validation fails for example.

Though as Jamie mentions we do have our own implementation as a preprocess before passing over to Libopenapi.

@jamietanna let us know if there would be interest from you for us to open source our implementation

[jamietanna]

Thanks @TristanSpeakEasy! Looking at it, there is actually https://github.com/speakeasy-api/openapi-overlay which may do the heavy lifting? 👀

[TristanSpeakEasy]

Oh yeah completely forgot we had already open sourced that, well hope it helps haha

…

On Fri, 16 Aug 2024 at 07:10, Jamie Tanna ***@***.***> wrote: Thanks @TristanSpeakEasy <https://github.com/TristanSpeakEasy>! Looking at it, there is actually https://github.com/speakeasy-api/openapi-overlay which may do the heavy lifting? 👀 — Reply to this email directly, view it on GitHub <#125 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AZYQK2FEQH7S7TLT276VVYDZRWJXBAVCNFSM6AAAAABMS6V2S2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEOJSHA4DCOBZGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[daveshanley]

I am adding this onto the roadmap. Overlays add value and I see speakeasy has done a great job with the overlay playground.