Skip to content

docs(agents): add request-path diagram to the HTTP APIs how-to - #143

Open
devopssquaddev wants to merge 2 commits into
mainfrom
chore/docs-http-apis-diagram
Open

devopssquaddev wants to merge 2 commits into
mainfrom
chore/docs-http-apis-diagram

Conversation

@devopssquaddev

Copy link
Copy Markdown
Owner

Adds one sequence diagram to docs/http-apis.md (Call HTTP APIs without giving agents the key).

It answers one question: where is the API key added, and where is a call refused?

  • Agent calls $ZELKOR_API_GITHUB_URL with no key → sidecar adds the agent's gateway key → gateway relay checks the key (401) and the method/path rules (403) → swaps in the credential from the github-api Secret in the platform namespace → api.github.com.
  • The response returns through the gateway and the sidecar, so the diagram shows the agent pod never reaches the internet directly.

Persona review (Agent developer, Platform, Architect): pass after fixing the response path. Mermaid rendering not checked locally; please eyeball the GitHub preview.

Docs only; no chart, image or behaviour change.

🤖 Generated with Claude Code

One sequence figure answers where the API key is added and where a
call is refused (401 without the agent key, 403 outside the rules).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅

View logs ↗
No Preview URL. Enable ↗ bfbe3af 2026-11-18T10:09:50.394Z Visit the dashboard ↗
  • Build: Success ✅

View logs ↗
No Preview URL. Enable ↗ 1bdaad4 2026-11-18T10:02:44.472Z Visit the dashboard ↗

…relay

It is an HTTPRoute plus SecurityPolicy on the shared Envoy gateway, not a
separate workload; "relay" suggested one.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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