docs: add API authentication guidance to bugfix tutorial#89
docs: add API authentication guidance to bugfix tutorial#89jwm4 merged 1 commit intoambient-code:mainfrom
Conversation
The tutorial's automation section documented the curl request schema correctly but gave no guidance on obtaining the API URL or token, or which endpoint to use. Users hitting the browser UI URL would get 401 errors because the OAuth proxy strips bearer tokens. Add a prerequisites section with concrete instructions for ACP_API_URL (including the UAT environment URL), ACP_PROJECT, and ACP_TOKEN. Clarify that the backend route must be used instead of the browser UI URL, and add a note to the GitHub Action section about storing secrets. Ref: RHOAIENG-55622 Made-with: Cursor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
Cache: Disabled due to data retention organization setting Knowledge base: Disabled due to data retention organization setting WalkthroughUpdated the automation section of the tutorial documentation to provide REST API configuration details, replacing the generic "How it works" heading with "Using the REST API." Added documentation for required environment variables ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Summary
concrete instructions for obtaining
ACP_API_URL,ACP_PROJECT, andACP_TOKENstrips bearer tokens) and that the backend route must be used instead
and token as repository secrets
Context
Discovered while testing the tutorial's curl example end-to-end. The request
schema was correct, but users had no way to know which URL to use or how to
get a token. The browser UI URL returns
401 User token requiredbecause theOAuth proxy authenticates the token but strips it before forwarding to the
backend. The backend route (
backend-route-ambient-code.*) bypasses the proxyand works with bearer tokens directly.
See RHOAIENG-55622 for
the related work to add workflow support to the public API.
Test plan
Made with Cursor