Skip to content

docs: audit the API guide pages against the code - #119

Merged
pavancharak merged 1 commit into
mainfrom
docs/audit-api-guide
Oct 2, 2026
Merged

pavancharak merged 1 commit into
mainfrom
docs/audit-api-guide

Conversation

@pavancharak

Copy link
Copy Markdown
Owner

What

Page by page audit, batch 2: the REST API guide pages, checked against the code and against the in process app (every response quoted was captured on 2026-10-02).

  • Idempotency and nonces: a table of what to read after a 409 (a refused request has a Refusal Record at GET /refusal/{id} and no Trust Record); a warning to read before sending again after a timeout (G-84, client timeout 120 s); the third replay defense, a human approval accepted once (403 POLICY_DENIED); nonces are in Postgres outside tests, so the old "per process" warning is gone.
  • Error handling: which errors carry a code and which do not, with the real messages; branch on status then code. "No connector registered" is now 503 CONNECTOR_NOT_REGISTERED, so that gap is removed. The incomplete body bare 500 is still real (missing metadata, intent or policy), recorded as G-87 (fix not built).
  • Introduction: 45 paths and 48 operations (was 26), every sidebar group, version without a key via /api-manifest.json (production /version needs a key).
  • The same stale facts fixed in deploy patterns (nonce store), execution pipeline and connector development guide (503 code), other languages (path count).

Found for later

  • The error catalog has no rows for CAPABILITY_NOT_BOUND and POLICY_VERSION_UNAVAILABLE, which routes return. Next audit page.
  • G-87 fix: a 400 naming the missing object.

🤖 Generated with Claude Code

Checked against the code and the in process app on 2026-10-02.

- Idempotency and nonces: what to read after a 409 (refused requests have
  a Refusal Record at GET /refusal/{id}, no Trust Record); read before
  sending again after a timeout (G-84); the third replay defense, a human
  approval accepted once (403 POLICY_DENIED); nonces are in Postgres, not
  per process.
- Error handling: which errors carry a code and which do not, captured
  messages; "no connector registered" is now 503 CONNECTOR_NOT_REGISTERED,
  not a gap; the incomplete body bare 500 remains, recorded as G-87.
- Introduction: 45 paths and 48 operations, every sidebar group, version
  via /api-manifest.json without a key.
- Same stale facts fixed in deploy patterns, execution pipeline, connector
  development guide and other languages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
parmanasystems 🟢 Ready View Preview Oct 2, 2026, 9:55 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@vercel

vercel Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
parmana-api-real Ready Ready Preview Oct 2, 2026 9:56am UTC
parmana-sandbox Ready Ready Preview Oct 2, 2026 9:56am UTC

This branch was successfully deployed

3 active deployments
Preview – parmana-api-real — 02d2f8b6 Deployed Oct 2, 2026 by vercel[bot]
Preview – parmana-sandbox — 02d2f8b6 Deployed Oct 2, 2026 by vercel[bot]
staging - docs/site — 02d2f8b6 Deployed Oct 2, 2026 by mintlify[bot]
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