Skip to content

Comments

chore: update generated output under .openapi markers#45

Merged
mridang merged 1 commit intomainfrom
release-v3.2.0
Jun 16, 2025
Merged

chore: update generated output under .openapi markers#45
mridang merged 1 commit intomainfrom
release-v3.2.0

Conversation

@mridang
Copy link
Collaborator

@mridang mridang commented Jun 16, 2025

Description

This PR cleans up the public API in our generated SDK.

Helper methods like ...Raw, ...withHttpInfo, or those with extra header parameters are now private. This leaves a single, simple public method for each API operation.

Related Issue

This change makes our SDKs much easier and more intuitive for developers to use. The previous design exposed multiple internal methods, cluttering the API and causing confusion. This cleanup provides a simple and obvious entry point for every API call.

Motivation and Context

How Has This Been Tested?

  • All SDKs were regenerated using the new, cleaner templates.
  • All existing unit and integration tests were run against the new code and passed, confirming that no functionality was broken.

Documentation:

The generated code documentation is now cleaner by default. No other documentation changes are needed.

Checklist:

  • I have updated the documentation accordingly.
  • I have assigned the correct milestone or created one if non-existent.
  • I have correctly labeled this pull request.
  • I have linked the corresponding issue in this description.
  • I have requested a review from at least 2 reviewers
  • I have checked the base branch of this pull request
  • I have checked my code for any possible security vulnerabilities

@github-actions
Copy link
Contributor

Qodana for Python

It seems all right 👌

No new problems were found according to the checks applied

@@ Code coverage @@
+ 73% total lines covered
773 lines analyzed, 572 lines covered
# Calculated according to the filters of your coverage tool

💡 Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Contact Qodana team

Contact us at qodana-support@jetbrains.com

@mridang mridang self-assigned this Jun 16, 2025
@mridang mridang added the enhancement New feature or request label Jun 16, 2025
@mridang mridang merged commit 16ff68a into main Jun 16, 2025
14 checks passed
@mridang mridang deleted the release-v3.2.0 branch June 17, 2025 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant