Skip to content

build: upgrade API Extractor - #10230

Open
dlarocque wants to merge 5 commits into
dl/prunedts-tsmorphfrom
dl/api-extractor
Open

build: upgrade API Extractor#10230
dlarocque wants to merge 5 commits into
dl/prunedts-tsmorphfrom
dl/api-extractor

Conversation

@dlarocque

@dlarocque dlarocque commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Upgrades from a custom 2019 fork (api-extractor-me@0.1.2) to the latest version of @microsoft/api-extractor (7.58.12). Restores multi-entry-point devsite reference documentation without requiring a custom API Extractor fork or schema extensions.

Changes:

  • Removed additionalEntrypoints from firestore and messaging API extractor configs, since they are not supported by the official API extractor.
  • Added appendSecondaryEntryPointsToApiJson to run API extractor on secondary entry points and merge their ApiEntryPoint members into api.json files.

Reference Documentation Changes:

  • Removed 30 duplicate pages (CollectionReference, Timestamp, etc.) that the old fork generated. Modern API extractor understands import references, so duplicates are not necessary.
  • Regenerated a bunch of links

Validation: We should stage this documentation in devsite to validate the new links work correctly.

@changeset-bot

changeset-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 009f43e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@wiz-9635d3485b

wiz-9635d3485b Bot commented Jul 29, 2026

Copy link
Copy Markdown

Wiz Scan Summary

Scanner Findings
Vulnerability Finding Vulnerabilities 1 High 1 Medium
Data Finding Sensitive Data -
Secret Finding Secrets -
IaC Misconfiguration IaC Misconfigurations -
SAST Finding SAST Findings 4 Medium 9 Low
Software Management Finding Software Management Findings -
Total 1 High 5 Medium 9 Low

View scan details in Wiz

To detect these findings earlier in the dev lifecycle, try the Wiz Code extension for VS Code, JetBrains, or Visual Studio.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the API review files and regenerates the devsite documentation for several Firebase packages, including Auth, Firestore, Realtime Database, and Messaging. The changes include consolidating and renaming Firestore documentation paths and updating the updateProfile signature in Auth. The reviewer identified several issues in the generated documentation, such as incorrect parameter listings for updateProfile in auth.md, missing method references/placeholders in firestore.documentreference.md, firestore.documentdata.md, and firestore.firestoredataconverter.md, as well as minor typos in firestore.writebatch.md.

Comment thread docs-devsite/auth.md
Comment thread docs-devsite/auth.md
Comment thread docs-devsite/auth.md
Comment thread docs-devsite/firestore.documentreference.md Outdated
Comment thread docs-devsite/firestore.documentreference.md Outdated
Comment thread docs-devsite/firestore.documentdata.md Outdated
Comment thread docs-devsite/firestore_.firestoredataconverter.md
Comment thread docs-devsite/firestore_.firestoredataconverter.md
Comment thread docs-devsite/firestore.writebatch.md Outdated
Comment thread docs-devsite/firestore.writebatch.md Outdated
@dlarocque

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request migrates the API extraction and documentation generation process from the custom api-extractor-me package to the official @microsoft/api-extractor package. To support this migration, the configuration files (api-extractor.json) for the firestore and messaging packages have been updated to remove additionalEntryPoints, and the documentation generation script (docgen.ts) has been enhanced to programmatically merge secondary entry points into the main api.json files. Consequently, several generated documentation files for pipelines have been cleaned up or deleted, and links/types across the devsite documentation have been updated. Additionally, the updateProfile signature in the authentication API has been simplified to use an input parameter. I have no further feedback to provide as there are no review comments.

@dlarocque dlarocque changed the title upgrade api extractor build: upgrade API Extractor Jul 29, 2026
@dlarocque
dlarocque marked this pull request as ready for review July 29, 2026 20:06
@dlarocque
dlarocque requested review from a team and zwu52 as code owners July 29, 2026 20:06
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