docs(ai-llm-proxy): add sidecar README - #557
Open
LukasHirt wants to merge 1 commit into
Open
Conversation
… requirement Fixes #556. The ai-llm-proxy sidecar had no README of its own; its same-origin requirement, single supported route, and error meanings were undocumented, which led to confusing 404/403 responses when users pointed extensions at the proxy directly instead of through a same-origin reverse proxy. Signed-off-by: Lukas Hirt <info@hirt.cz>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
packages/ai-llm-proxy/README.md, the sidecar's first README, documenting its request flow, the single supported route (POST /v1/chat/completions), the same-origin requirement (with a Traefik and a generic nginx example), the full env var table, and a troubleshooting table mapping each error response to its cause.Why
Fixes #556.
ai-llm-proxyhad no README of its own. Its same-origin enforcement (Originmust matchOCIS_URL) and its single-route scope (no models-list endpoint) were undocumented, so pointing an extension'sllm.endpointstraight at the proxy's own host:port produced confusing 404/403 responses that looked like a broken extension rather than a config issue.Test plan
packages/ai-llm-proxy/src/index.ts(route matching, origin check, env var defaults).