zmievsa / cadwyn

Production-ready community-driven modern Stripe-like API versioning in FastAPI
https://docs.cadwyn.dev/
MIT License
186 stars 24 forks source link

Internal head schema docstring copied to all generate external schemas #168

Open mrparalon opened 3 months ago

mrparalon commented 3 months ago

Is your feature request related to a problem? Please describe.

Since head schema is not exposed to users directly, it is not obvious that docsting will be copied to all generated schemas. And this docstring is shown in swagger docs. Also I'm not sure, that cadwyn user want same description for all versions.

Describe the solution you'd like I see different options to solve it

Additional context Request come from a case on my current job. We added internal docstring to head schema and it was exposed in swagger

zmievsa commented 3 months ago

Could you explain a use case where the docstring would need to be migrated or be different in between the internal and external schemas? It is not a breaking change.