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

DX: Update OpenAPI schema naming and SDK method names #437

Open
eric-nguyen-cs opened this issue Mar 12, 2024 · 0 comments
Open

DX: Update OpenAPI schema naming and SDK method names #437

eric-nguyen-cs opened this issue Mar 12, 2024 · 0 comments
Labels
🐛 bug Something isn't working 🏄‍♂️ good first issue Good for newcomers

Comments

@eric-nguyen-cs
Copy link
Contributor

eric-nguyen-cs commented Mar 12, 2024

What

  • OpenAPI variables are weirdly named
  • Same for the method names on the client
  • Input params do not have any description

It is possible to customise these names: https://fastapi.tiangolo.com/advanced/generate-clients/#custom-operation-ids-and-better-method-names
And add descriptions with: https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#declare-more-metadata

#436 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working 🏄‍♂️ good first issue Good for newcomers
Projects
Development

No branches or pull requests

1 participant