1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-28 00:17:12 +01:00

docs: delete old unleash-context doc.

Similar to the activation strategy page: this seems to be deprecated
and was not listed in the sidebar. There is also a newer, more fleshed
out version that _does_ appear in the sidebar instead.
This commit is contained in:
Thomas Heartman 2021-11-24 11:27:55 +01:00
parent b9325c89fb
commit eadf118759

View File

@ -1,21 +0,0 @@
---
id: unleash_context
title: Unleash Context
---
To standardise a few activation strategies, we also needed to standardise the Unleash context, which contains fields that vary per request, required to implement the activation strategies.
The unleash context is defined by these fields:
- userId: String,
- sessionId: String,
- remoteAddress: String,
- properties: Map<String, String>
- appName: String
- environment: String
All fields are optional, but if they are not set you will not be able to use certain activation strategies.
E.g., the `userWithId` strategy obviously depends on the `userId` field.
The `properties` field is more generic and can be used to provide more arbitrary data to strategies. Typical usage is to add more metadata. For instance, the `betaUser` strategy may read a field from `properties` to check whether the current user is a beta user.