From 36dfdb3bbc71bec2c7158985e5105c761536f78b Mon Sep 17 00:00:00 2001 From: Tiago Barbosa Date: Thu, 22 Feb 2024 14:48:04 +0000 Subject: [PATCH] docs: add support for REST API url override Signed-off-by: Tiago Barbosa --- docs/advanced/configure-api-url.md | 14 ++++++++++++++ docs/release-notes/backend.md | 21 ++++++++++++++++++++- docs/release-notes/frontend.md | 23 ++++++++++++++++++++++- mkdocs.yml | 1 + overrides/main.html | 2 +- 5 files changed, 58 insertions(+), 3 deletions(-) create mode 100644 docs/advanced/configure-api-url.md diff --git a/docs/advanced/configure-api-url.md b/docs/advanced/configure-api-url.md new file mode 100644 index 0000000..6eb1cd6 --- /dev/null +++ b/docs/advanced/configure-api-url.md @@ -0,0 +1,14 @@ +# Custom REST API URL + +The default URL used for REST API requests is `https://api.pagerduty.com`. It is possible to override this URL through configuration. Add the following configuration to `app-config.yaml`: + +```yaml +pagerDuty: + apiBaseUrl: 'https://api.eu.pagerduty.com' +``` + +!!! note + **PagerDuty accounts based in Europe use a different URL** so you need to override it here if that is your case. + + EU-based accounts: 'https://api.eu.pagerduty.com' + US-based accounts: 'https://api.pagerduty.com' \ No newline at end of file diff --git a/docs/release-notes/backend.md b/docs/release-notes/backend.md index 3c26043..51dda7d 100644 --- a/docs/release-notes/backend.md +++ b/docs/release-notes/backend.md @@ -1,5 +1,24 @@ # Release notes for Backend plugin +## > 0.4.3 + +[GitHub release](https://github.com/PagerDuty/backstage-plugin-backend/releases/tag/0.4.3) + +### Summary + +This release resolves an issue reported in backstage-plugin ([#74](https://github.com/PagerDuty/backstage-plugin/issues/74)) which prevents users from overriding the REST API base url (e.g. for EU based accounts). This feature was possible through the Backstage proxy configuration. + +With this, users will be able to add a new configuration to the PagerDuty plugin in `app-config.yaml` like the example below. + +```yaml +pagerDuty: + apiBaseUrl: https://api.eu.pagerduty.com #defaults to https://api.pagerduty.com +``` + +### Changes + +- fix: adding support for API base url override + ## > 0.4.2 [GitHub release](https://github.com/PagerDuty/backstage-plugin-backend/releases/tag/0.4.2) @@ -10,7 +29,7 @@ This release introduces a security patch to a third-party dependency. ### Changes -- build(deps): Bump ip from 2.0.0 to 2.0.1 (#29) by @dependabot +- build(deps): Bump ip from 2.0.0 to 2.0.1 ## > 0.4.1 diff --git a/docs/release-notes/frontend.md b/docs/release-notes/frontend.md index dc8af09..bbe3d64 100644 --- a/docs/release-notes/frontend.md +++ b/docs/release-notes/frontend.md @@ -1,5 +1,26 @@ # Release notes for Frontend plugin +## > 0.9.2 + +[GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.9.2) + +### Summary + +This release resolves an issue reported in backstage-plugin (#74) which prevents users from overriding the REST API base url (e.g. for EU based accounts). This feature was possible through the Backstage proxy configuration. + +With this, users will be able to add a new configuration to the PagerDuty plugin in `app-config.yaml` like the example below. + +```yaml +pagerDuty: + apiBaseUrl: https://api.eu.pagerduty.com #defaults to https://api.pagerduty.com +``` + +This feature in mainly implemented in `@pagerduty/backstage-plugin-backend` but this release updates the plugin config schema accordingly. + +### Changes + +- fix: updating config schema to allow overriding of api base url + ## > 0.9.1 [GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.9.1) @@ -10,7 +31,7 @@ This release introduces a security patch to a third-party dependency. ### Changes -- build(deps): Bump ip from 2.0.0 to 2.0.1 (#29) by @dependabot +- build(deps): Bump ip from 2.0.0 to 2.0.1 ## > 0.9.0 diff --git a/mkdocs.yml b/mkdocs.yml index a3c896c..ea9ff0a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -71,6 +71,7 @@ nav: - Configuring Backstage: getting-started/backstage.md - Capabilities: capabilities.md - Advanced: + - Configure REST API url: advanced/configure-api-url.md - Configure Events url: advanced/configure-events-url.md - Enable read-only mode: advanced/enable-read-only-mode.md - Create an homepage component: advanced/homepage-component.md diff --git a/overrides/main.html b/overrides/main.html index 4d06688..3fe8b07 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -3,7 +3,7 @@ {% block announce %}

- 🎉 New release! Checkout the latest versions for Frontend(0.9.1), Backend(0.4.2) and Common(0.1.1) + 🎉 New release! Checkout the latest versions for Frontend(0.9.2), Backend(0.4.3) and Common(0.1.1)

{% endblock %} \ No newline at end of file