Skip to content

Commit fe7ef04

Browse files
igorlukaninovr
authored andcommitted
docs: USER_CONTEXT update
1 parent 8cf624d commit fe7ef04

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

DEPRECATION.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ features:
4646
| Deprecated | [`checkAuthMiddleware`](#checkauthmiddleware) | v0.26.0 | v0.36.0 |
4747
| Removed | [Node.js 10](#nodejs-10) | v0.26.0 | v0.29.0 |
4848
| Removed | [Node.js 15](#nodejs-15) | v0.26.0 | v0.32.0 |
49-
| Deprecated | [`USER_CONTEXT`](#user_context) | v0.26.0 | |
49+
| Deprecated | [`USER_CONTEXT`](#user_context) | v0.26.0 | v0.36.0 |
5050
| Deprecated | [`authInfo`](#authinfo) | v0.26.0 | |
5151
| Deprecated | [Prefix Redis environment variables with `CUBEJS_`](#prefix-redis-environment-variables-with-cubejs_) | v0.27.0 | v0.36.0 |
5252
| Removed | [Node.js 12](#nodejs-12) | v0.29.0 | v0.32.0 |
@@ -56,6 +56,7 @@ features:
5656
| Removed | [Serverless Deployments](#serverless-deployments) | v0.31.64 | v0.35.0 |
5757
| Removed | [Node.js 14](#nodejs-14) | v0.32.0 | v0.35.0 |
5858
| Removed | [Using Redis for in-memory cache and queue](#using-redis-for-in-memory-cache-and-queue) | v0.32.0 | v0.36.0 |
59+
| Deprecated | [`SECURITY_CONTEXT`](#security_context) | v0.33.0 | |
5960
| Deprecated | [`running_total` measure type](#running_total-measure-type) | v0.33.39 | |
6061
| Removed | [Node.js 16](#nodejs-16) | v0.35.0 | v0.36.0 |
6162
| Removed | [MySQL-based SQL API](#mysql-based-sql-api) | v0.35.0 | v0.35.0 |
@@ -205,7 +206,7 @@ no more updates. Please upgrade to Node.js 12 or higher.
205206

206207
### `USER_CONTEXT`
207208

208-
**Deprecated in Release: v0.26.0**
209+
**Removed in Release: v0.36.0**
209210

210211
`USER_CONTEXT` has been renamed to `SECURITY_CONTEXT`.
211212

@@ -337,6 +338,14 @@ Cube Store is now the default cache and queue engine, [replacing
337338
Redis](https://cube.dev/blog/replacing-redis-with-cube-store). Please migrate to
338339
[Cube Store](https://cube.dev/blog/how-you-win-by-using-cube-store-part-1).
339340
341+
### `SECURITY_CONTEXT`
342+
343+
**Deprecated in Release: v0.33.0**
344+
345+
The `SECURITY_CONTEXT` context variable is deprecated. Use
346+
[`query_rewrite`](https://cube.dev/docs/reference/configuration/config#query_rewrite)
347+
instead.
348+
340349
### `running_total` measure type
341350
342351
**Deprecated in Release: v0.33.39**

docs/pages/reference/cli.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ practices._
105105
### Usage
106106

107107
```bash{promptUser: user}
108-
npx cubejs-cli token -e TOKEN-EXPIRY -s SECRET -p FOO=BAR -u BAZ=QUX
108+
npx cubejs-cli token -e TOKEN-EXPIRY -s SECRET -p FOO=BAR
109109
```
110110

111111
### Flags
@@ -115,7 +115,6 @@ npx cubejs-cli token -e TOKEN-EXPIRY -s SECRET -p FOO=BAR -u BAZ=QUX
115115
| -e, --expiry           | Token expiry. Set to 0 for no expiry (default: "30 days") | `1 day`, `30 days`         |
116116
| -s, --secret | Cube app secret. Also can be set via environment variable `CUBEJS_API_SECRET` | - |
117117
| -p, --payload | Token Payload | `foo=bar`, `userId=2` |
118-
| -u, --user-context | Token USER_CONTEXT Payload | `baz=qux`, `companyId=5` |
119118

120119
### Example
121120

docs/pages/reference/data-model/context-variables.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -734,7 +734,7 @@ cube(`users`, {
734734
<WarningBox>
735735
736736
`SECURITY_CONTEXT` is deprecated and may be removed in the upcoming versions.
737-
Use [`queryRewrite`][ref-config-queryrewrite] instead.
737+
Use [`query_rewrite`][ref-config-queryrewrite] instead.
738738
739739
</WarningBox>
740740
@@ -809,7 +809,7 @@ cube(`orders`, {
809809
```
810810
811811
[ref-config-ext-ctx]: /reference/configuration/config#extendcontext
812-
[ref-config-queryrewrite]: /reference/configuration/config#queryrewrite
812+
[ref-config-queryrewrite]: /reference/configuration/config#query_rewrite
813813
[ref-config-req-ctx]: /reference/configuration/config#requestcontext
814814
[ref-recipe-control-access-cubes-views]:
815815
/guides/recipes/access-control/controlling-access-to-cubes-and-views

0 commit comments

Comments
 (0)