Automated Cross-Repo Testing for SDKs When OpenAPI Specifications Are Updated

[tokuhirom]

Background

This repository hosts the OpenAPI specifications that serve as the basis for various SDKs, including but not limited to Python, Node.js, and Golang. These SDKs are maintained in separate repositories, some of which are officially supported by us.

Proposal

To ensure that changes to the OpenAPI specifications do not inadvertently break these SDKs, I propose an automated testing pipeline that triggers whenever a pull request modifying the OpenAPI specs is submitted. Specifically, the pipeline would:

1. Update the OpenAPI submodule in each officially supported SDK repository.
2. Run the SDK tests in these repositories.
3. Report the test results back to the original pull request in this OpenAPI repository, either as comments or through other mechanisms like GitHub Checks.

Expected Benefits

1. Early detection of issues in the officially supported SDKs due to changes in the OpenAPI specs.
2. Increased confidence in the robustness of both the OpenAPI specifications and the SDKs that rely on them.
3. Streamlining of the review process by automating checks that would otherwise be manual.

I look forward to hearing your thoughts on this proposal.

[Yang-33]

We need to support 6 SDKs finally.
(SDKs based on OpenAPI generator)

• Java (Run SDK test on PR #35)
• PHP (Add test for Python, PHP, and Node.js sdks #37)
• Python (Add test for Python, PHP, and Node.js sdks #37)
• Node.js (Add test for Python, PHP, and Node.js sdks #37)
• Go (Test golang SDK on PR #38)

(SDKs trying to use OpenAPI generator)

• Ruby