Module: OpenAPI Specs & SDK Generation

[memplethee-lab]

Feature Request

Problem Statement

Lack of an authoritative OpenAPI specification and SDKs makes it harder for integrators and reduces adoption potential.

Proposed Solution

Produce a complete OpenAPI v3 spec for the REST surface and add CI-driven SDK generation for TypeScript and Python clients.

Alternatives Considered

Manually maintaining docs increases drift and makes automated SDKs unreliable.

Additional Context

Include example client usage and CI artifacts so Grant reviewers can run end-to-end demos easily.

Implementation Ideas (Optional)

• Use openapi-generator or similar in CI to publish SDK artifacts
• Keep specs in sync via tests that validate generated SDKs against a mock server

Would you be willing to contribute?

• Yes, I'd like to submit a PR for this feature
• I can help with testing
• I can help with documentation

[Just-Bamford]

I’d tackle this by first defining the REST surface in a complete OpenAPI v3 specification, covering endpoints, request/response schemas, authentication, errors, and reusable components. Then I’d use the spec as the single source of truth for generating TypeScript and Python SDKs, with example usage for both so integrators can test the API quickly.

I’d also add CI validation to ensure the OpenAPI spec stays consistent with the API and that generated SDKs build correctly against a mock server. This keeps the documentation and SDKs synchronized automatically instead of relying on manual maintenance.

[grantfox-oss]

🦊 GrantFox — @Just-Bamford has been assigned to this issue as part of the Third Campaign campaign!

Next steps:

1. Open a Pull Request referencing this issue (e.g., Closes #129)
2. Your PR will be reviewed by the SourceXXL maintainers

Good luck! Track your progress on GrantFox.