Skip to content

Simplify SDK auto-generation architecture #86

@dyeam0

Description

@dyeam0

Problem Statement

Today's SDKs require development to be done first in the SDK's language repo (ex. java-sdk, python-sdk, etc.) and then a manual sync of the changes to the SDK generator repo (sdk-generator), from which the code is generated.

The SDK generator allows auto-generation of models from the OpenAPI Specification. The complexity comes from the manual step of syncing changes to the SDK generator which then generates of other components of the SDKs using mustache templating.

Goals:

  • Simplify the process for maintaining and generating SDKs, reducing the manual effort required.
  • Improve developer experience, allowing a lower barrier for the community to make contributions to SDKs.

References

  • Many facets of the issue have been captured in this community discussion #456.
  • POC (proof of concept) to reduce amount of generated code: chore: reduce client generation sdk-generator#638
    • Reduces the scope of the code generated by the SDK generator by excluding certain files from generation.
    • The changes support a transition towards manually maintaining more SDK code while keeping models, API definitions, and documentation auto-generated.

Sub-issues

Metadata

Metadata

Assignees

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions