Skip to content

Commit 4d0439e

Browse files
committed
Fix image and broken anchors
1 parent bd98ef5 commit 4d0439e

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

src/lib/openapi/util/openapi-tags.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ const OPENAPI_TAGS = [
6868
{
6969
name: 'Frontend API',
7070
description:
71-
'API for connecting client-side (frontend) applications to Unleash.',
71+
'The [Frontend API](https://docs.getunleash.io/reference/front-end-api) is used for connecting client-side (frontend) applications to Unleash.',
7272
},
7373
{
7474
name: 'Import/Export',

website/docs/reference/front-end-api.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: Frontend API
1010

1111
## Overview
1212

13-
The Unleash [Frontend API](/reference/api/unleash/frontend-api) simplifies connecting client-side applications to Unleash. It shares the same API as [Unleash Edge](https://docs.getunleash.io/reference/unleash-edge), but is best suited for development, or low-traffic applications, and internal dashboards. You can start development with the Frontend API and transition to Unleash Edge when needed.
13+
The Unleash [Frontend API](/reference/api/unleash/frontend-api) simplifies connecting client-side applications to Unleash. It shares the same API as [Unleash Edge](https://docs.getunleash.io/reference/unleash-edge) but is best suited for development environments, low-traffic applications, or internal dashboards. You can start development with the Frontend API and transition to Unleash Edge when needed.
1414

1515
Compared to Unleash Edge, the Frontend API has advantages and limitations:
1616

@@ -19,23 +19,23 @@ Compared to Unleash Edge, the Frontend API has advantages and limitations:
1919
- Clients function the same way as they would with Unleash Edge.
2020

2121
**Drawbacks:**
22-
- Limited scalability—it can’t handle high request volumes like Unleash Edge.
22+
- Limited scalability—it can’t handle high request volumes like Unleash Edge.
2323
- Sends application usage metrics to your Unleash instance, which may be a privacy concern (though Unleash only stores this data in a short-term runtime cache).
2424

2525
## Configure the Frontend API
2626

2727
### Configure cross-origin resource sharing (CORS)
2828

29-
For web and hybrid mobile apps, allow traffic from your applications domains. To update CORS settings in the Unleash UI, go to **Admin > CORS**. Alternatively, you can update CORS using the Admin API.
29+
For web and hybrid mobile apps, allow traffic from your application's domains. To update CORS settings in the Unleash Admin UI, go to **Admin > CORS origins**. Alternatively, you can update CORS using the [Admin API](/reference/api/unleash/set-cors).
3030

3131
### Configure the API URL
3232

3333
Point your application to the correct API endpoint: `<your-unleash-instance>/api/frontend`.
3434

3535
### Generate an API token
3636

37-
Your application needs a frontend [token](../reference/api-tokens-and-client-keys.mdx#frontend-tokens) to interact with the Frontend API.
37+
Your application needs a [frontend token](../reference/api-tokens-and-client-keys.mdx#frontend-tokens) to interact with the Frontend API.
3838

3939
### Configure the refresh interval for tokens
4040

41-
Feature flag updates occur at a default refresh interval of 10 seconds plus a random offset (010 seconds) to prevent simultaneous database queries. You can customize the refresh interval using the `FRONTEND_API_REFRESH_INTERVAL_MS` environment variable or the `frontendApi.refreshIntervalInMs` configuration option in the SDK.
41+
Feature flag updates occur at a default refresh interval of 10 seconds plus a random offset (0-10 seconds) to prevent simultaneous database queries. You can customize the refresh interval using the `FRONTEND_API_REFRESH_INTERVAL_MS` environment variable or the `frontendApi.refreshIntervalInMs` configuration option in the SDK.

website/docs/reference/rbac.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ You can assign the following root permissions:
9292
|---------------------|------------------------------------|
9393
| Change instance banners | Change instance [banners](./banners). |
9494
| Change maintenance mode state | Change [maintenance mode](./maintenance-mode) state. |
95-
| Update CORS settings | Update [CORS settings](./front-end-api#cors). |
95+
| Update CORS settings | Update [CORS settings](./front-end-api#configure-cross-origin-resource-sharing-cors). |
9696
| Read instance logs and login history | Read instance logs and [login history](./login-history.md). |
9797

9898
#### Integration permissions

website/docs/understanding-unleash/unleash-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Unleash architecture
33
---
44

5-
Unleash is designed for privacy, speed, and resilience, enabling feature flag evaluations to happen locally within your applications. This architecture provides:
5+
Unleash is designed for privacy, speed, and resilience, enabling feature flag evaluations to happen locally within your applications. The architecture provides:
66
- **Fast feature flag evaluations**: Feature flags are evaluated within the [SDKs](/reference/sdks) running in your application, making evaluations incredibly fast (nanoseconds).
77
- **High reliability**: There is no dependency on network calls during evaluation, providing high reliability.
88
- **Privacy and security**: No user data is shared with the Unleash instance, ensuring [privacy and security](/understanding-unleash/data-collection).

website/docs/using-unleash/troubleshooting/cors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
title: My requests are being blocked by CORS
33
---
44

5-
1. Make sure you've configured CORS access in Unleash admin UI settings as defined in the [Unleash CORS Policy docs](/reference/front-end-api#cors). These settings can be changed in the Unleash Dashboard under **Settings -> CORS Origins** or by using the [API](/reference/api/unleash/set-ui-config). Allowing all origins (using a single asterisk) will address this matter and is a great starting point when troubleshooting the behavior.
5+
1. Make sure you've configured CORS access in Unleash admin UI settings as defined in the [Unleash CORS Policy docs](/reference/front-end-api#configure-cross-origin-resource-sharing-cors). These settings can be changed in the Unleash Dashboard under **Settings -> CORS Origins** or by using the [API](/reference/api/unleash/set-ui-config). Allowing all origins (using a single asterisk) will address this matter and is a great starting point when troubleshooting the behavior.
66
1. When receiving "**No 'Access-Control-Policy' header is present on the requested resource**", using the command `curl -I https://<host>/<endpoint>` will allow us to verify that the response includes the header `Access-Control-Allow-Origin: *`.
-35.6 KB
Loading

0 commit comments

Comments
 (0)