diff --git a/.changeset/neat-coats-sell.md b/.changeset/neat-coats-sell.md index 8021e8ec18..80c9ba111c 100644 --- a/.changeset/neat-coats-sell.md +++ b/.changeset/neat-coats-sell.md @@ -2,7 +2,7 @@ '@backstage/create-app': patch --- -This change adds an API endpoint for requesting a catalog refresh at `/refresh`, which is activated if a `CatalogProcessingEngine` is passed to `createRouter`. +This change adds an API endpoint for requesting a catalog refresh at `/refresh`, which is activated if a `RefreshService` is passed to `createRouter`. The creation of the router has been abstracted behind the `CatalogBuilder` to simplify usage and future changes. The following **changes are required** to your `catalog.ts` for the refresh endpoint to function. ```diff diff --git a/.changeset/red-lizards-accept.md b/.changeset/red-lizards-accept.md index 9314a35f7f..74c3a76db5 100644 --- a/.changeset/red-lizards-accept.md +++ b/.changeset/red-lizards-accept.md @@ -2,6 +2,6 @@ '@backstage/plugin-catalog-backend': minor --- -Add API endpoint for requesting a catalog refresh at `/refresh`, which is activated if a `CatalogProcessingEngine` is passed to `createRouter`. +Add API endpoint for requesting a catalog refresh at `/refresh`, which is activated if a `RefreshService` is passed to `createRouter`. -The `CatalogProcessingEngine` interface has also received a new `refresh` method, meaning this is a breaking change if you have a custom implementation of it. The new method is used to trigger a refresh of an entity in an as localized was as possible, usually by refreshing the parent location. +The new method is used to trigger a refresh of an entity in an as localized was as possible, usually by refreshing the parent location.