Skip to content

[codex] Align public agent API docs#202

Merged
blove merged 1 commit into
mainfrom
codex/docs-api-truth-pass
May 7, 2026
Merged

[codex] Align public agent API docs#202
blove merged 1 commit into
mainfrom
codex/docs-api-truth-pass

Conversation

@blove
Copy link
Copy Markdown
Contributor

@blove blove commented May 7, 2026

Summary

  • Align the root README and agent API docs with the current runtime-neutral Agent and LangGraph adapter APIs.
  • Document submit/resume/regenerate semantics, provideAgent defaults, FetchStreamTransport, and MockAgentTransport using current call shapes.
  • Regenerate checked-in API JSON for agent/chat/ag-ui and add a CI drift check after API generation.
  • Remove the unused messagesKey option from AgentOptions so generated docs no longer advertise unsupported configuration.

Verification

  • npm run generate-api-docs
  • npm run generate-api-docs && git diff --exit-code -- apps/website/content/docs/*/api/api-docs.json
  • npx nx run-many -t test --projects=chat,langgraph,ag-ui --skip-nx-cache
  • npx nx lint website --skip-nx-cache && npx nx build website --skip-nx-cache
  • npx nx run-many -t build --projects=chat,langgraph,ag-ui --configuration=production --skip-nx-cache
  • npx nx run-many -t lint --projects=chat,langgraph,ag-ui --skip-nx-cache
  • git diff --check

Known pre-existing warnings remain in website/langgraph/ag-ui/chat lint output and ng-packagr still reports the existing @ngaf/chat export-condition warnings.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 7, 2026

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

Project Deployment Actions Updated (UTC)
cacheplane Ready Ready Preview, Comment May 7, 2026 4:47pm

Request Review

@blove blove merged commit 80a0e9e into main May 7, 2026
14 checks passed
@blove blove deleted the codex/docs-api-truth-pass branch May 7, 2026 16:51
blove added a commit that referenced this pull request May 7, 2026
…arden gate (#207)

- libs/langgraph: declare `regenerate(index)` on the public LangGraphAgent
  surface (it was implemented + tested but missing from agent.types.ts, so
  the chat-message-actions JSDoc pointer to `agent.regenerate(index)` was
  technically referencing an undeclared method).
- CHANGELOG: backfill 0.0.28 entry documenting the silent removal of
  AgentOptions.messagesKey from PR #202 (was labeled `docs:`).
- docs/superpowers/plans: add post-PR #203 path-note banners to three
  plans that still reference the deleted apps/website/public/api-docs.json
  (now generated per-library under content/docs/{lib}/api/).
- ci: drop the hand-maintained libs allow-list in the examples-deploy gate
  in favor of `^libs/`. The previous list silently broke whenever a new
  publishable lib was added; cost of a spurious example rebuild is far
  cheaper than a missed deploy.

Co-authored-by: Claude Opus 4.7 <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