Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mrparalon opened this issue Apr 2, 2024 · 1 comment
Open
Labels
enhancement New feature or request

Comments

@mrparalon
Copy link
Contributor

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

  • Disable copy of docstring
  • Add warning about it on code generation
  • Add setting to disable it
  • Migrate docstrings

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

@mrparalon mrparalon added the enhancement New feature or request label Apr 2, 2024
@zmievsa
Copy link
Owner

zmievsa commented Apr 2, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants