Skip to content

Conversation

@Jeffwan
Copy link
Collaborator

@Jeffwan Jeffwan commented Oct 19, 2025

Pull Request Description

I notice the error response format is completely incompatible. after checking https://github.com/openai/openai-openapi/tree/master?tab=readme-ov-file

  • Gateway is missing required fields: type, param
  • Gateway uses HTTP status code (int) for code instead of error code string
  • 401 errors return invalid JSON: {"error":"unauthorized"}
  • Error responses don't match OpenAI format. This affects: authentication errors, validation errors, rate limits, server errors, routing

Related Issues

Resolves: #1677, part of #846

Important: Before submitting, please complete the description above and review the checklist below.


Contribution Guidelines (Expand for Details)

We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:

Pull Request Title Format

Your PR title should start with one of these prefixes to indicate the nature of the change:

  • [Bug]: Corrections to existing functionality
  • [CI]: Changes to build process or CI pipeline
  • [Docs]: Updates or additions to documentation
  • [API]: Modifications to aibrix's API or interface
  • [CLI]: Changes or additions to the Command Line Interface
  • [Misc]: For changes not covered above (use sparingly)

Note: For changes spanning multiple categories, use multiple prefixes in order of importance.

Submission Checklist

  • PR title includes appropriate prefix(es)
  • Changes are clearly explained in the PR description
  • New and existing tests pass successfully
  • Code adheres to project style and best practices
  • Documentation updated to reflect changes (if applicable)
  • Thorough testing completed, no regressions introduced

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @Jeffwan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the Gateway API's error handling by making its error responses fully compatible with the OpenAI API specification. The changes involve introducing a structured approach to error generation, including new constants for error types and codes, and modifying existing functions to consistently produce detailed JSON error payloads that include 'type', 'code', and 'param' fields. This ensures better interoperability and a more predictable error experience for clients interacting with the gateway.

Highlights

  • OpenAI Error Format Compatibility: The Gateway API's error responses are now aligned with the OpenAI API specification, including 'type', 'code', and 'param' fields for richer error details.
  • Standardized Error Types and Codes: New constants for 'ErrorType' (e.g., 'invalid_request_error', 'authentication_error') and 'ErrorCode' (e.g., 'invalid_api_key', 'model_not_found') have been introduced to categorize errors consistently.
  • Refactored Error Generation: Core error response functions ('generateErrorResponse', 'buildErrorResponse') have been updated to accept and utilize 'errorCode' and 'param' arguments, ensuring consistent error formatting across the gateway.
  • Improved Error Messages: Specific error scenarios, such as unauthorized access (401), rate limits (429), and model not found, now return more precise and OpenAI-compliant messages and codes.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request makes important changes to align the gateway's error responses with the OpenAI API format, which is a great improvement for client compatibility. The approach of centralizing error generation logic in util.go is solid.

My review focuses on ensuring the new error format is fully compliant with OpenAI's standards. I've found a few areas where the error types and codes could be more accurate. I've also noted a minor issue with error handling in the JSON serialization logic. The suggested changes should help make the error handling more robust and fully compliant.

@Jeffwan Jeffwan force-pushed the jiaxin/openai-compatible-gateway branch from bac7ebd to acf06c1 Compare October 19, 2025 05:53
@Jeffwan Jeffwan force-pushed the jiaxin/openai-compatible-gateway branch from acf06c1 to 799343a Compare October 19, 2025 06:18
@Jeffwan
Copy link
Collaborator Author

Jeffwan commented Oct 19, 2025

this one has enough test coverage, I will merge it directly to unblock coming PRs.

@Jeffwan Jeffwan merged commit a0f35d4 into vllm-project:main Oct 19, 2025
14 checks passed
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.

Switch all interface testing to openAI sdk

1 participant