Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-08-13 13:48:59 +02:00
Code Issues Projects Releases Wiki Activity

fix token type links

Browse Source
This commit is contained in:
Gastón Fournier 2025-07-29 16:57:17 +02:00
parent d22ebf6b8b
commit be34a9fa73
No known key found for this signature in database
GPG Key ID: AF45428626E17A8E
10 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/lib/openapi/spec/edge-token-schema.ts
View File

@ -7,7 +7,7 @@ export const edgeTokenSchema = {
additionalProperties: false,
required: ['token', 'projects', 'type'],
description:
'A representation of a client token, limiting access to [CLIENT](https://docs.getunleash.io/reference/api-tokens-and-client-keys#client-tokens) (used by serverside SDKs) or [FRONTEND](https://docs.getunleash.io/reference/api-tokens-and-client-keys#frontend-tokens) (used by proxy SDKs)',
'A representation of a client token, limiting access to [CLIENT](https://docs.getunleash.io/reference/api-tokens-and-client-keys#backend-tokens) (used by serverside SDKs) or [FRONTEND](https://docs.getunleash.io/reference/api-tokens-and-client-keys#frontend-tokens) (used by proxy SDKs)',
properties: {
projects: {
description:
@ -19,7 +19,7 @@ export const edgeTokenSchema = {
example: ['developerexperience', 'enterprisegrowth'],
},
type: {
description: `The [API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys)'s **type**. Unleash supports three different types of API tokens ([ADMIN](https://docs.getunleash.io/reference/api-tokens-and-client-keys#admin-tokens), [CLIENT](https://docs.getunleash.io/reference/api-tokens-and-client-keys#client-tokens), [FRONTEND](https://docs.getunleash.io/reference/api-tokens-and-client-keys#frontend-tokens)). They all have varying access, so when validating a token it's important to know what kind you're dealing with`,
description: `The [API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys)'s **type**. Unleash supports three different types of API tokens ([ADMIN](https://docs.getunleash.io/reference/api-tokens-and-client-keys#admin-tokens), [CLIENT](https://docs.getunleash.io/reference/api-tokens-and-client-keys#backend-tokens), [FRONTEND](https://docs.getunleash.io/reference/api-tokens-and-client-keys#frontend-tokens)). They all have varying access, so when validating a token it's important to know what kind you're dealing with`,
type: 'string',
enum: Object.values(ApiTokenType),
example: 'client',

4
website/docs/feature-flag-tutorials/java/implementing-feature-flags.mdx
View File

@ -157,7 +157,7 @@ In the main function of that file on line 21, set up the Unleash Client configur
Unleash unleash = new DefaultUnleash(config);
```
Read more on our [configuration examples in our Java SDK documentation](/reference/sdks/java#example-configurations).
Read more on our [configuration examples in our Java SDK documentation](https://docs.getunleash.io/reference/sdks/java#example-configurations).
The `unleashAPI` will point your app to your local Unleash instance.
@ -165,7 +165,7 @@ Replace the `<API_KEY>` string in the configuration’s apiKey with the API toke
While the app is running, it will log the enabled status of the endpoint flag we created in our Unleash instance.
You can check our [API token and client keys documentation](/reference/api-tokens-and-client-keys) for more specifics and see additional use cases in our [Backend SDK with Java](/reference/sdks/java) documentation.
You can check our [API token and client keys documentation](https://docs.getunleash.io/reference/api-tokens-and-client-keys) for more specifics and see additional use cases in our [Backend SDK with Java](https://docs.getunleash.io/reference/sdks/java) documentation.
To run the app, use the following command:

2
website/docs/feature-flag-tutorials/java/spring-boot-implementing-feature-flags.mdx
View File

@ -104,7 +104,7 @@ Select the ‘New API token’ button.
![Create a new API token in the API Access view for your Spring Boot application.](/img/tutorial-create-api-token.png)
Name the API token and select the “Backend SDK” token type since we’ll be doing our flag evaluation on the server using the Spring Boot SDK. You can read more about [Unleash API tokens](/reference/api-tokens-and-client-keys#client-tokens).
Name the API token and select the “Backend SDK” token type since we’ll be doing our flag evaluation on the server using the Spring Boot SDK. You can read more about [Unleash API tokens](/reference/api-tokens-and-client-keys#backend-tokens).
The token should have access to the “development” environment, as shown in the platform screenshot below.

2
website/docs/feature-flag-tutorials/javascript/implementing-feature-flags-js.md
View File

@ -163,7 +163,7 @@ Now, let's connect our project to Unleash so that you can toggle a feature flag
You'll need two things:
- The URL of your Unleash instance's API. It's `http://localhost:4242/api/` for your local version.
- A [client API token](/reference/api-tokens-and-client-keys#client-tokens). You can create one inside a project in **Settings > API access**.
- A [client API token](/reference/api-tokens-and-client-keys#backend-tokens). You can create one inside a project in **Settings > API access**.
You can now initialize your Unleash client as follows:

2
website/docs/how-to/how-to-run-the-unleash-proxy.mdx
View File

@ -30,7 +30,7 @@ If you're using a hosted version of Unleash, we can also run the proxy for you.
This is what you need before you can run the proxy:
- A running Unleash server to connect to. You'll need its API path (e.g. `https://app.unleash-hosted.com/demo/api`) to connect the proxy to it.
- A [client API token](../reference/api-tokens-and-client-keys#client-tokens) for the proxy to use.
- A [client API token](../reference/api-tokens-and-client-keys#backend-tokens) for the proxy to use.
- If you're running the Proxy via Docker: [the `docker` command line tool](https://www.docker.com/).
- If you're running the Proxy as a Node.js app: [Node.js and its command line tools](https://nodejs.org/).
- A [Proxy client key](../reference/api-tokens-and-client-keys#proxy-client-keys). This can be any arbitrary string (for instance: `proxy-client-key`). Use this key when connecting a client SDK to the Proxy.

2
website/docs/quickstart.mdx
View File

@ -88,7 +88,7 @@ unleash.on("synchronized", () => {
1. **Create an API token**
In the Unleash Admin UI, create a [client API token](/reference/api-tokens-and-client-keys#client-tokens) in **Admin settings > Access control > API access**.
In the Unleash Admin UI, create a [client API token](/reference/api-tokens-and-client-keys#backend-tokens) in **Admin settings > Access control > API access**.
2. **Get your Unleash API URL**
Find the base URL of your Unleash Cloud instance (for example, `https://us.app.unleash-hosted.com/some-instance-id`). Your API URL is this base URL with `/api` appended to it.

2
website/docs/reference/rbac.md
View File

@ -79,7 +79,7 @@ You can assign the following root permissions:
| Create frontend API tokens | Create frontend API tokens. |
| Update frontend API tokens | Update frontend API tokens. |
| Delete frontend API tokens | Delete frontend API tokens. |
| Read client API tokens | View [client API tokens](./api-tokens-and-client-keys#client-tokens). |
| Read client API tokens | View [client API tokens](./api-tokens-and-client-keys#backend-tokens). |
| Create client API tokens | Create client API tokens. |
| Update client API tokens | Update client API tokens. |
| Delete client API tokens | Delete client API tokens. |

2
website/docs/reference/sdks/index.mdx
View File

@ -16,7 +16,7 @@ Unleash provides official SDKs for a number of programming languages. Our commun
### Backend SDKs
Backend SDKs run in backend services. They communicate with Unleash or [Unleash Edge](./unleash-edge) using the [Client API](../understanding-unleash/unleash-overview#client-api) and require a [client token](./api-tokens-and-client-keys#client-tokens).
Backend SDKs run in backend services. They communicate with Unleash or [Unleash Edge](./unleash-edge) using the [Client API](../understanding-unleash/unleash-overview#client-api) and require a [client token](./api-tokens-and-client-keys#backend-tokens).
Backend SDKs perform the flag evaluation locally, meaning all user data is retained within the SDK.
Unleash offers the following backend SDKs:

2
website/docs/using-unleash/deploy/configuring-unleash.mdx
View File

@ -185,7 +185,7 @@ If emails fail to send or contain errors:
| :--------------------------------- | :-------------- | :--------------------------------------------------------------------------------------------------------- |
| `UNLEASH_DEFAULT_ADMIN_USERNAME` | `admin` | Sets the username for the initial admin user created on first startup. |
| `UNLEASH_DEFAULT_ADMIN_PASSWORD` | `unleash4all` | Sets the password for the initial admin user. **Change this for any non-local setup.** |
| `INIT_CLIENT_API_TOKENS` | N/A | Comma-separated list of [Client tokens](/reference/api-tokens-and-client-keys#client-tokens) to create on first startup (if no tokens exist in the database). |
| `INIT_CLIENT_API_TOKENS` | N/A | Comma-separated list of [Client tokens](/reference/api-tokens-and-client-keys#backend-tokens) to create on first startup (if no tokens exist in the database). |
| `INIT_FRONTEND_API_TOKENS` | N/A | Comma-separated list of [Frontend tokens](/reference/api-tokens-and-client-keys#frontend-tokens) to create on first startup (if no tokens exist in the database). |
### Server behavior

2
website/remote-content/sdks.js
View File

@ -102,7 +102,7 @@ const SDKS = (() => {
const getAdmonitions = (sdk) => {
const admonitions = {
[CLIENT_SIDE_SDK]: `To connect to Unleash from a frontend application, you'll need to use the [Unleash front-end API](/reference/front-end-api) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx)) or the [Unleash proxy](/reference/unleash-proxy) ([how do I create client keys?](/reference/api-tokens-and-client-keys#proxy-client-keys)).`,
[SERVER_SIDE_SDK]: `To connect to Unleash, you'll need your Unleash API url (e.g. \`https://<your-unleash>/api\`) and a [backend API token](/reference/api-tokens-and-client-keys.mdx#client-tokens) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx)).`,
[SERVER_SIDE_SDK]: `To connect to Unleash, you'll need your Unleash API url (e.g. \`https://<your-unleash>/api\`) and a [backend API token](/reference/api-tokens-and-client-keys.mdx#backend-tokens) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx)).`,
};
const wrap = (text) => `:::tip\n${text}\n:::`;