[FEATURE] (type-safe-api) only require OpenApi Generator when API changes
- Dominant language
- TypeScript
- Stars
- 451
- Forks
- 84
- Avg merge
- 20h 3m
- Merged PRs (30d)
- 1
Description
### Describe the feature
Enable generated type-safe-api code to optionally be committed to the repo and only run OpenAPI Generator when the api spec is modified.
### Use Case
I've heard developers say they are hesitant to adopt type-safe-api because it adds a dependency on the JDK and maven and that could be an issue for their customers. By committing the generated code, only developers who modify the API spec will need those dependencies.
### Proposed Solution
_No response_
### Other Information
_No response_
### Acknowledgements
- [X] I may be able to implement this feature request
- [ ] This feature might incur a breaking change
### PDK version used
0.23.47
### What languages will this feature affect?
Typescript, Java, Python
### Environment details (OS name and version, etc.)
macos
Contributor guide
Research direction
Start by locating the type-safe-api generation entry points, the API spec, and how OpenAPI Generator is currently invoked. Determine how generated TypeScript, Java, and Python code can be committed and how changes to the API spec trigger generation; done means unchanged specs avoid requiring the JDK and Maven while generated code stays up to date.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi, python, typescript
- Domain
- api, build-system, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100