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

chore: enhance changeset definition to call out all new breaking changes

Browse Source 
Signed-off-by: Alec Jacobs <cajacobs5401@gmail.com>
This commit is contained in:
Alec Jacobs
2022-06-03 17:42:49 -07:00
parent f22f6050b4
commit 24511a3beb
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/weak-bananas-deliver.md
+11 -1
View File
@@ -5,9 +5,19 @@
Introduces a new annotation `pagerduty.com/service-id` that can be used instead of the `pagerduty.com/integration-key` annotation.
_Note: If both annotations are specified on a given Entity, then the `pagerduty.com/integration-key` annotation will be prefered_
**BREAKING** The `PagerDutyClient.fromConfig` static method now expects a `FetchApi` compatible object as a third argument.
**BREAKING** The `PagerDutyClient.fromConfig` static method now expects a `FetchApi` compatible object and has been refactored to
accept 2 arguments: config and ClientApiDependencies
The `PagerDutyClient` now relies on a `fetchApi` being available to execute `fetch` requests.
**BREAKING** A new query method `getServiceByEntity` that is used to query for Services by either the `integrationKey` or `serviceId`
annotation values if they are defined. The `integrationKey` value is preferred currently over `serviceId`. As such, the previous
`getServiceByIntegrationKey` method has been removed.
**BREAKING** The return values for each Client query method has been changed to return an object instead of raw values.
For example, the `getIncidentsByServiceId` query method now returns an object in the shape of `{ incidents: Incident[] }`
instead of just `Incident[]`.
This same pattern goes for `getChangeEventsByServiceId` and `getOnCallByPolicyId` functions.
In addition, various enhancements/bug fixes were introduced:
- The `PagerDutyCard` component now wraps error and loading messages with an `InfoCard` to contain errors/messages. This enforces a consistent experience on the EntityPage