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

Replace OpenAPI code generation with direct provider schema definitions #29

Open
SierraJC opened this issue Nov 23, 2024 · 0 comments
Open
Assignees
Labels
technical debt Code that needs refactoring to improve maintainability and reduce complexity.

Comments

@SierraJC
Copy link
Owner

Currently, we generate provider models and attributes from OpenAPI specs, which creates unnecessary complexity and disconnects between the API and provider designs. This leads to:

  1. Multiple schema overrides to fix discrepancies
  2. Extra maintenance overhead
  3. Less control over the provider schema design

Proposed Solution:

  • Remove OpenAPI code generation for provider schemas
  • Directly define provider models and attributes in Go
  • Keep API client generation for actual API interactions
  • Document provider schema separately from API specs
  • Keep provider code generation files in source control to help with bootstrapping and detecting API changes?

Benefits:

  • Cleaner and more maintainable code
  • Better control over provider schema design
  • Reduced need for schema overrides
@SierraJC SierraJC added the technical debt Code that needs refactoring to improve maintainability and reduce complexity. label Nov 23, 2024
@SierraJC SierraJC self-assigned this Nov 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical debt Code that needs refactoring to improve maintainability and reduce complexity.
Projects
None yet
Development

No branches or pull requests

1 participant