marshmallow-code
Support Overlays standard
There is a reasonably new formalised standard out called "Overlays - https://github.com/OAI/Overlay-Specification/blob/main/versions/1.0.0.md 2024-10-17 .
Currently, I can generate my openapi definition from the code, then add a few tweaks to it, commit this to a documentation site, but the second the source code changes, then one has to manually add in the tweaks again, repeat this process for every update.
This standard helps a lot with that, since now, using something like - https://github.com/lornajane/openapi-overlays-js - then any additional changes can be kept in a seperate file, then added back in when we want to add it.
Currently, if there is an issue with the generator, or you just want to add in some new properties to the auto-generated code, then you either have to fix this repo or then use a 3rd party tool to then join the two back together again.
Might be nice to add in an overlay merging step, but if this is outside the scope of this project, then that's also fine since adding more features (even if pulling in a library for most of it) does distract from the main scope of this project.
Or probably one to make a plugin that is compatible with this library and then can be added to the Ecosystem page?
Ended up using oas-patch to remove any private parts of the openapi docs + patch in things that are missing for the time being like for issue #821.
It's not too hard to pull in and merge an overlay to change the generated docs, might be one for an example project to add it in rather than it ends up part of the core library.
If so, probably this is a feature request that can be closed off.
Hi. Thanks for sharing those ideas.
I wouldn't say overlay is out of scope but I don't have time and motivation to look into it myself.
I already had to tweak the generated doc in an app of mine and I did it in user code by either monkeypatching apispec functions to hardcode the behaviour that suited me or just modifying the output.
It's nice to see there are other methods. Thanks for sharing.
