Skip to content

feat:Add Python naming specification to OpenAPI schema with x-stainless-naming#206

Merged
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202508081237
Aug 8, 2025
Merged

feat:Add Python naming specification to OpenAPI schema with x-stainless-naming#206
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202508081237

Conversation

@HavenDV
Copy link
Copy Markdown
Contributor

@HavenDV HavenDV commented Aug 8, 2025

Summary by CodeRabbit

  • Chores
    • Updated internal naming specifications to improve future Python compatibility. No changes to user-facing features or functionality.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Aug 8, 2025

Walkthrough

A new Python-specific naming specification was added to the OpenAPI schema in src/libs/tryAGI.OpenAI/openapi.yaml. This introduces model_name and param_model_name fields under x-stainless-naming for a particular schema variant, without modifying any logic or public interfaces.

Changes

Cohort / File(s) Change Summary
OpenAPI Python Naming Metadata
src/libs/tryAGI.OpenAI/openapi.yaml
Added x-stainless-naming metadata for Python, defining model_name and param_model_name for code generation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A nibble of YAML, a sprinkle of name,
Python gets labels to help with the game.
No logic disturbed, just metadata cheer,
The codegen is happy, the schema is clear.
🐇✨

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

✨ 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_202508081237

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 enabled auto-merge (squash) August 8, 2025 12:38
@coderabbitai coderabbitai Bot changed the title feat:@coderabbitai feat:Add Python naming specification to OpenAPI schema with x-stainless-naming Aug 8, 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)

10358-10361: Optional: document the intent inline

A short YAML comment helps future maintainers understand why explicit naming is required for Python.

                 x-stainless-go-variant-constructor:
                   naming: 'chat_completion_{variant}_tool'
+                # Python-specific explicit names to stabilize SDK codegen
                 x-stainless-naming:
                   python:
                     model_name: chat_completion_tool_union
                     param_model_name: chat_completion_tool_union_param
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6c4a1f8 and 0b1de74.

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

10358-10361: Explicit Python naming looks good and reduces codegen drift

Defining python.model_name and python.param_model_name under x-stainless-naming is clear and consistent with vendor-extension style. Good move to stabilize generated class names.


10358-10361: ✅ Unique Python names confirmed, generator compatibility pending

– Checked chat_completion_tool_union & chat_completion_tool_union_param under
components/schemas/CreateChatCompletionRequest/allOf/1/properties/tools/items;
no duplicates elsewhere in the schema.
– No other model_name or param_model_name collisions detected.

Next step: please verify that the Stainless code generator supports the Python keys
x-stainless-naming.python.model_name and x-stainless-naming.python.param_model_name
so these custom names are applied correctly.

@HavenDV HavenDV disabled auto-merge August 8, 2025 14:27
@HavenDV HavenDV merged commit 4935cd6 into main Aug 8, 2025
3 of 4 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202508081237 branch August 8, 2025 14:27
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