Skip to content

[Snyk] Security upgrade @backstage/plugin-api-docs from 0.10.2 to 0.12.0#3120

Open
diegoluisi wants to merge 2 commits into
mainfrom
snyk-fix-4b9b5570ca17b7c909b27528ac65acd5
Open

[Snyk] Security upgrade @backstage/plugin-api-docs from 0.10.2 to 0.12.0#3120
diegoluisi wants to merge 2 commits into
mainfrom
snyk-fix-4b9b5570ca17b7c909b27528ac65acd5

Conversation

@diegoluisi

Copy link
Copy Markdown
Contributor

snyk-top-banner

Snyk has created this PR to fix 1 vulnerabilities in the yarn dependencies of this project.

Snyk changed the following file(s):

  • app/packages/app/package.json

Note for zero-installs users

If you are using the Yarn feature zero-installs that was introduced in Yarn V2, note that this PR does not update the .yarn/cache/ directory meaning this code cannot be pulled and immediately developed on as one would expect for a zero-install project - you will need to run yarn to update the contents of the ./yarn/cache directory.
If you are not using zero-install you can ignore this as your flow should likely be unchanged.

⚠️ Warning
Failed to update the yarn.lock, please update manually before merging.

Vulnerabilities that will be fixed with an upgrade:

Issue
high severity Allocation of Resources Without Limits or Throttling
SNYK-JS-WS-17988732

Breaking Change Risk

Merge Risk: High

Notice: This assessment is enhanced by AI.


Important

  • Check the changes in this PR to ensure they won't cause issues with your project.
  • Max score is 1000. Note that the real score may have changed since the PR was raised.
  • This PR was automatically created by Snyk using the credentials of a real user.

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open fix PRs.

For more information:
🧐 View latest project report
📜 Customise PR templates
🛠 Adjust project settings
📚 Read about Snyk's upgrade logic


Learn how to fix vulnerabilities with free interactive lessons:

🦉 Allocation of Resources Without Limits or Throttling

@diegoluisi

Copy link
Copy Markdown
Contributor Author

Merge Risk: High

This upgrade migrates the @backstage/plugin-api-docs to the new Declarative Frontend System. This is a breaking change that requires updates to how the plugin is integrated into your Backstage application.

Breaking Changes:

  • Plugin Integration: The plugin no longer exposes a page component to be added to routes directly. Instead, it exports apiDocsPlugin, an extension that must be registered with the app.
  • Configuration: The method for configuring the plugin in your application's App.tsx has changed. You must now import apiDocsPlugin and add it to the features array of the createApp function.

Recommendation:
Update your application's frontend setup by removing the explicit route for the API Docs page and instead including the apiDocsPlugin in the features list for your app. This change is part of a broader migration across the Backstage ecosystem to a new composability API.

Source: Backstage documentation

Notice 🤖: This content was augmented using artificial intelligence. AI-generated content may contain errors and should be reviewed for accuracy before use.

@diegoluisi
diegoluisi requested a review from a team as a code owner July 20, 2026 18:03
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.

2 participants