Skip to content

feat:OpenAPI: add x-stainless-naming, remove go variant constructor skip#209

Merged
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202508111519
Aug 11, 2025
Merged

feat:OpenAPI: add x-stainless-naming, remove go variant constructor skip#209
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202508111519

Conversation

@HavenDV
Copy link
Copy Markdown
Contributor

@HavenDV HavenDV commented Aug 11, 2025

Summary by CodeRabbit

  • Chores
    • Updated internal API specification metadata, adjusting naming entries within component definitions.
    • Removed an obsolete vendor extension and introduced a new naming block for language-specific models.
    • No user-facing functionality changes; APIs, responses, and behavior remain unchanged.
    • This change is backward compatible and requires no action from users.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Aug 11, 2025

Walkthrough

OpenAPI spec updated to adjust vendor extensions. Removed x-stainless-go-variant-constructor: skip and introduced x-stainless-naming with Python-specific model_name and param_model_name for tool-call union naming. No structural or discriminator changes elsewhere.

Changes

Cohort / File(s) Summary of edits
OpenAPI vendor extensions
src/libs/tryAGI.OpenAI/openapi.yaml
Removed x-stainless-go-variant-constructor: skip. Added x-stainless-naming with python.model_name: chat_completion_message_tool_call_union and python.param_model_name: chat_completion_message_tool_call_union_param. No other schema/discriminator changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A nibble of YAML, a hop in the night,
I mapped new names in Python’s light.
Go’s old flag, I let it slip—
a gentle tweak, a tidy flip.
Thump-thump! My paws approve the run;
specs aligned, the merge is done. 🐇✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bot/update-openapi_202508111519

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@HavenDV HavenDV merged commit 2920d45 into main Aug 11, 2025
2 of 4 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202508111519 branch August 11, 2025 15:20
@coderabbitai coderabbitai Bot changed the title feat:@coderabbitai feat:OpenAPI: add x-stainless-naming, remove go variant constructor skip Aug 11, 2025
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/libs/tryAGI.OpenAI/openapi.yaml (1)

8553-8556: Optional: Define naming for other SDKs to avoid cross-language drift

If you generate multiple SDKs, consider also setting x-stainless-naming for other targets (e.g., typescript, go, java) to keep union naming aligned across languages.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6390beb and 9b22e6e.

📒 Files selected for processing (1)
  • src/libs/tryAGI.OpenAI/openapi.yaml (1 hunks)
🔇 Additional comments (2)
src/libs/tryAGI.OpenAI/openapi.yaml (2)

8553-8556: Stainless Python Naming Keys Verified

  • Stainless supports x-stainless-naming.python.model_name and param_model_name under schema nodes.
  • No duplicate model_name values were detected—each appears only once in the spec.
  • Naming follows the same snake_case pattern as the existing union at lines 10364–10366 (chat_completion_tool_union / chat_completion_tool_union_param).

All checks pass—no further action needed.


8552-8556: Please confirm x-stainless-go-variant-constructor vs. x-stainless-naming usage

I ran a repo-wide grep and can confirm both the original
x-stainless-go-variant-constructor: skip
and the new

x-stainless-naming:
  python:
    model_name: chat_completion_message_tool_call_union
    param_model_name: chat_completion_message_tool_call_union_param

are present on lines 8552–8556. To keep the SDKs in sync:

• Do you intend to keep the Go-specific variant-constructor: skip, or should it be removed in favor of the naming extension?
• Should similar x-stainless-naming blocks be added for other languages (e.g., Go, Java, Kotlin) for this union type, as seen elsewhere in the file?

No syntax errors detected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant