GTBitsOfGood / GTBitsOfGood/juno-sdk
Avoid similar name confusion between autogenerated files and client wrappers
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
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:
- `Api` (autogenerated) vs `API` (wrapper)
This can especially be confusing if we're doing any sort of documentation generation:

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 `Client` for wrappers:
- `EmailClient`
- `AuthClient`
- `UserClient`
- ...etc.
Contributor guide
No contributing guide indexed for this repository
Research direction
Locate the autogenerated Api files and the corresponding API wrapper classes, then trace their references in the SDK and documentation-generation setup. Confirm the replacement naming convention with maintainers before changing names. Done means wrapper and generated names are unambiguous and all affected references and documentation use the agreed convention.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100