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

Avoid similar name confusion between autogenerated files and client wrappers #24

Open
UZ9 opened this issue Oct 25, 2024 · 0 comments
Open

Comments

@UZ9
Copy link
Contributor

UZ9 commented Oct 25, 2024

Juno's SDK primarily consists of two parts:

  • The autogenerated files from OpenAPI
  • Wrappers for each service to handle validation, authentication, etc.

However, these two files have very similar names:

  • <Service>Api (autogenerated) vs <Service>API (wrapper)

This can especially be confusing if we're doing any sort of documentation generation:
image

As such, we'll likely need to switch the wrapper classes to a name other than an API suffix. One idea might be changing it to <Service>Client for wrappers:

  • EmailClient
  • AuthClient
  • UserClient
  • ...etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant