paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 41 Packages Projects Releases Wiki Activity

Merge pull request #33365 from backstage/rugvip/opaque-api-ref-type

Browse Source 
frontend-plugin-api: convert ApiRef to an opaque type
This commit is contained in:
Patrik Oldsberg
2026-03-17 12:15:05 +01:00
committed by GitHub
parent 3048708aed ac560a24cb
commit 38bca59990
45 changed files with 725 additions and 199 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/api-ref-plugin-owner-app.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/frontend-app-api': patch
---
Frontend apps now respect an explicit `pluginId` on `ApiRef`s when deciding which plugin owns an API factory.
.changeset/api-ref-plugin-owner-core.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/core-plugin-api': patch
---
Updated `createApiRef` to preserve the direct config call without deprecation warnings while staying compatible with the new frontend API ref typing.
.changeset/opaque-api-ref-type.md
+7
View File
@@ -0,0 +1,7 @@
---
'@backstage/frontend-plugin-api': patch
---
Added a builder form for `createApiRef` in the new frontend system and deprecated the direct `createApiRef({ ... })` call in favor of `createApiRef().with({ ... })`. The builder form now also preserves literal API ref IDs in the resulting `ApiRef` type.
The `createApiRef().with({ ... })` form can also use an explicit `pluginId` to declare API ownership without encoding the plugin ID into the API ref ID, while keeping that metadata internal to runtime handling.