Skip to content

Commit

Permalink
docs: add support for REST API url override
Browse files Browse the repository at this point in the history
Signed-off-by: Tiago Barbosa <[email protected]>
  • Loading branch information
t1agob committed Feb 22, 2024
1 parent af22029 commit 36dfdb3
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 3 deletions.
14 changes: 14 additions & 0 deletions docs/advanced/configure-api-url.md
Original file line number Diff line number Diff line change
@@ -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'
21 changes: 20 additions & 1 deletion docs/release-notes/backend.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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
Expand Down
23 changes: 22 additions & 1 deletion docs/release-notes/frontend.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% block announce %}
<div>
<p>
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/release-notes/frontend/#091">0.9.1</a>), Backend(<a href="/release-notes/backend/#042">0.4.2</a>) and Common(<a href="/release-notes/common/#011">0.1.1</a>) </span>
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/release-notes/frontend/#092">0.9.2</a>), Backend(<a href="/release-notes/backend/#043">0.4.3</a>) and Common(<a href="/release-notes/common/#011">0.1.1</a>) </span>
</p>
</div>
{% endblock %}

0 comments on commit 36dfdb3

Please sign in to comment.