fix(website): mark default-valued params as optional in api-docs generator#631
Merged
Conversation
…rator
TypeDoc only sets the `isOptional` flag for `?`-marked params, not for
params with a default value (e.g. `mockAgent(opts: MockAgentOptions = {})`),
so those were rendered as required. Treat `defaultValue !== undefined` as
optional too. Regenerated: 14 default-valued params across 5 libs now show
optional (e.g. mockAgent `opts`); diff is optional-flags only.
Closes the follow-up flagged during the chat + ag-ui docs technical reviews.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
blove
added a commit
that referenced
this pull request
Jun 9, 2026
…rator (#631) TypeDoc only sets the `isOptional` flag for `?`-marked params, not for params with a default value (e.g. `mockAgent(opts: MockAgentOptions = {})`), so those were rendered as required. Treat `defaultValue !== undefined` as optional too. Regenerated: 14 default-valued params across 5 libs now show optional (e.g. mockAgent `opts`); diff is optional-flags only. Closes the follow-up flagged during the chat + ag-ui docs technical reviews. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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
Closes the follow-up flagged during the chat + ag-ui docs technical reviews. TypeDoc only sets the
isOptionalflag for?-marked params, not for params with a default value (e.g.mockAgent(opts: MockAgentOptions = {})), so the generated API reference rendered those as required.Fix: in
generate-api-docs.ts, a parameter is optional ifisOptionalor it has adefaultValue.Regenerated all libs: 14 default-valued params across 5 libs now correctly show optional (e.g.
mockAgentopts, and similar= {}/= []params). The generated-JSON diff isoptional-flag flips only — no signature, type, name, or structure change.Test Plan
eslintclean on the generator.npm run generate-api-docssucceeds for all 7 libs."optional": false→truelines changed;mockAgent.optsnowoptional: true.🤖 Generated with Claude Code