diff --git a/src/lib/openapi/util/openapi-tags.ts b/src/lib/openapi/util/openapi-tags.ts index b9613b12cd..2ab53d95c6 100644 --- a/src/lib/openapi/util/openapi-tags.ts +++ b/src/lib/openapi/util/openapi-tags.ts @@ -68,7 +68,7 @@ const OPENAPI_TAGS = [ { name: 'Frontend API', description: - 'API for connecting client-side (frontend) applications to Unleash.', + 'The [Frontend API](https://docs.getunleash.io/reference/front-end-api) is used for connecting client-side (frontend) applications to Unleash.', }, { name: 'Import/Export', diff --git a/website/docs/reference/front-end-api.md b/website/docs/reference/front-end-api.md index 6593a5c46c..1cae0fe138 100644 --- a/website/docs/reference/front-end-api.md +++ b/website/docs/reference/front-end-api.md @@ -10,7 +10,7 @@ title: Frontend API ## Overview -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. +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. Compared to Unleash Edge, the Frontend API has advantages and limitations: @@ -19,14 +19,14 @@ Compared to Unleash Edge, the Frontend API has advantages and limitations: - Clients function the same way as they would with Unleash Edge. **Drawbacks:** -- Limited scalability—it can’t handle high request volumes like Unleash Edge. +- Limited scalability—it can’t handle high request volumes like Unleash Edge. - 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). ## Configure the Frontend API ### Configure cross-origin resource sharing (CORS) -For web and hybrid mobile apps, allow traffic from your application’s domains. To update CORS settings in the Unleash UI, go to **Admin > CORS**. Alternatively, you can update CORS using the Admin API. +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). ### Configure the API URL @@ -34,8 +34,8 @@ Point your application to the correct API endpoint: `/api ### Generate an API token -Your application needs a frontend [token](../reference/api-tokens-and-client-keys.mdx#frontend-tokens) to interact with the Frontend API. +Your application needs a [frontend token](../reference/api-tokens-and-client-keys.mdx#frontend-tokens) to interact with the Frontend API. ### Configure the refresh interval for tokens -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. +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. diff --git a/website/docs/reference/rbac.md b/website/docs/reference/rbac.md index c31f65dc9a..5fce020d09 100644 --- a/website/docs/reference/rbac.md +++ b/website/docs/reference/rbac.md @@ -92,7 +92,7 @@ You can assign the following root permissions: |---------------------|------------------------------------| | Change instance banners | Change instance [banners](./banners). | | Change maintenance mode state | Change [maintenance mode](./maintenance-mode) state. | -| Update CORS settings | Update [CORS settings](./front-end-api#cors). | +| Update CORS settings | Update [CORS settings](./front-end-api#configure-cross-origin-resource-sharing-cors). | | Read instance logs and login history | Read instance logs and [login history](./login-history.md). | #### Integration permissions diff --git a/website/docs/understanding-unleash/unleash-overview.md b/website/docs/understanding-unleash/unleash-overview.md index 6ebffc236f..428b96d59d 100644 --- a/website/docs/understanding-unleash/unleash-overview.md +++ b/website/docs/understanding-unleash/unleash-overview.md @@ -2,7 +2,7 @@ title: Unleash architecture --- -Unleash is designed for privacy, speed, and resilience, enabling feature flag evaluations to happen locally within your applications. This architecture provides: +Unleash is designed for privacy, speed, and resilience, enabling feature flag evaluations to happen locally within your applications. The architecture provides: - **Fast feature flag evaluations**: Feature flags are evaluated within the [SDKs](/reference/sdks) running in your application, making evaluations incredibly fast (nanoseconds). - **High reliability**: There is no dependency on network calls during evaluation, providing high reliability. - **Privacy and security**: No user data is shared with the Unleash instance, ensuring [privacy and security](/understanding-unleash/data-collection). diff --git a/website/docs/using-unleash/troubleshooting/cors.md b/website/docs/using-unleash/troubleshooting/cors.md index eaa6751bde..57f1e217f2 100644 --- a/website/docs/using-unleash/troubleshooting/cors.md +++ b/website/docs/using-unleash/troubleshooting/cors.md @@ -2,5 +2,5 @@ title: My requests are being blocked by CORS --- -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. +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. 1. When receiving "**No 'Access-Control-Policy' header is present on the requested resource**", using the command `curl -I https:///` will allow us to verify that the response includes the header `Access-Control-Allow-Origin: *`. \ No newline at end of file diff --git a/website/static/img/unleash-admin-ui.png b/website/static/img/unleash-admin-ui.png index 98c364fa71..8b1d04783a 100644 Binary files a/website/static/img/unleash-admin-ui.png and b/website/static/img/unleash-admin-ui.png differ