Skip to content

docs(configuration): note url accepts base URL or full /responses endpoint - #623

Merged
lizhengfeng101 merged 1 commit into
alibaba:mainfrom
FenjuFu:docs/responses-url-flexibility
Jul 31, 2026
Merged

docs(configuration): note url accepts base URL or full /responses endpoint#623
lizhengfeng101 merged 1 commit into
alibaba:mainfrom
FenjuFu:docs/responses-url-flexibility

Conversation

@FenjuFu

@FenjuFu FenjuFu commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

What

Follow-up to #562 as suggested by @lizhengfeng101 in #563.

#562 already documented the openai-responses protocol across all three locales. This adds the one incremental clarification #563 had that #562 lacked: for openai-responses, the url field accepts either the API base URL or the full /responses endpoint.

Added one sentence right after the openai-responses example in en, zh, and ja.

Why it's accurate

internal/llm/responses_client.goensureResponsesEndpoint normalizes both forms. Its own contract comment states:

https://api.openai.com/v1             -> https://api.openai.com/v1/responses
https://api.openai.com/v1/            -> https://api.openai.com/v1/responses
https://api.openai.com/v1/responses   -> https://api.openai.com/v1/responses

So a user can supply either shape and it resolves the same way — worth stating so people don't guess.

Scope

Docs-only, +2 lines per locale (the sentence + a blank line), no other changes. Rebased on current main so it sits cleanly on top of #562.

Refs #556, #563

…point

Follow-up to alibaba#562 (which documented the openai-responses protocol). Adds
the one clarification alibaba#562 lacked: for openai-responses, the `url` field
accepts either the API base URL or the full `/responses` endpoint, since
ensureResponsesEndpoint normalizes both forms. Added in en/zh/ja.

Signed-off-by: FenjuFu <92919259+FenjuFu@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

OpenCodeReview: No supported files changed.

@lizhengfeng101 lizhengfeng101 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@lizhengfeng101
lizhengfeng101 merged commit 75589cf into alibaba:main Jul 31, 2026
10 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.

2 participants