Skip to content

Commit

Permalink
fix: identyfication headers typo (#9244)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tymek authored Feb 6, 2025
1 parent 56c9584 commit 377e684
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion website/docs/reference/sdks/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Bootstrapping is also supported by the following front-end client SDKs:
To identify which frontend and backend SDK instances are connected to Unleash, the following headers must be attached to all requests made by the SDK to the server (`/api/client` for backend SDKs and `/api/frontend` for frontend SDKs):

- `unleash-connection-id`: A unique identifier for the current SDK instance, automatically generated using the idiomatic unique identifier generator for the specific programming ecosystem (for example, `randomUUID` from `crypto` in Node.js). This connection ID represents a long-lived connection between the SDK and the Unleash server. An SDK should generate a new connection ID each time an SDK instance is instantiated (for example, when calling `new Unleash()` in a Node SDK). The same connection ID should be used for each request when an SDK instance polls the API. Additionally, there is a legacy `unleash-instanceid` header that is not implemented by all SDKs and can be overwritten by the client, which is the main reason `unleash-connection-id` was introduced.
- `x-unleash-sdk`: Provides information about the language/framework and version of the SDK making the request. The format is the language/framework followed by a colon and the semantic version of the SDK (for example, `[email protected]` or `[email protected]`). Each SDK implementation should use a platform-idiomatic method to read the version from a package manager and update it with each version release.
- `unleash-sdk`: Provides information about the language/framework and version of the SDK making the request. The format is the language/framework followed by a colon and the semantic version of the SDK (for example, `[email protected]` or `[email protected]`). Each SDK implementation should use a platform-idiomatic method to read the version from a package manager and update it with each version release.
- `unleash-appname` (optional): Specifies the name of your application that is communicating with Unleash. This name is user-defined with some SDKs providing a default fallback value. For example, `billing-service`.

**Exceptions**: Backend SDKs used in short-lived request/response models (like Next.js server mode and PHP) should not provide the `unleash-connection-id` header.

0 comments on commit 377e684

Please sign in to comment.