From 43f6a60e393b72a50c135194e87cc04c3b3d8979 Mon Sep 17 00:00:00 2001 From: Igor Lukanin Date: Thu, 12 Sep 2024 12:58:28 +0200 Subject: [PATCH] docs: USER_CONTEXT update --- DEPRECATION.md | 13 +++++++++++-- docs/pages/reference/cli.mdx | 3 +-- .../reference/data-model/context-variables.mdx | 4 ++-- 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/DEPRECATION.md b/DEPRECATION.md index 0b819ed0feeb8..97c05dd0fb93e 100644 --- a/DEPRECATION.md +++ b/DEPRECATION.md @@ -46,7 +46,7 @@ features: | Deprecated | [`checkAuthMiddleware`](#checkauthmiddleware) | v0.26.0 | v0.36.0 | | Removed | [Node.js 10](#nodejs-10) | v0.26.0 | v0.29.0 | | Removed | [Node.js 15](#nodejs-15) | v0.26.0 | v0.32.0 | -| Deprecated | [`USER_CONTEXT`](#user_context) | v0.26.0 | | +| Deprecated | [`USER_CONTEXT`](#user_context) | v0.26.0 | v0.36.0 | | Deprecated | [`authInfo`](#authinfo) | v0.26.0 | | | Deprecated | [Prefix Redis environment variables with `CUBEJS_`](#prefix-redis-environment-variables-with-cubejs_) | v0.27.0 | v0.36.0 | | Removed | [Node.js 12](#nodejs-12) | v0.29.0 | v0.32.0 | @@ -56,6 +56,7 @@ features: | Removed | [Serverless Deployments](#serverless-deployments) | v0.31.64 | v0.35.0 | | Removed | [Node.js 14](#nodejs-14) | v0.32.0 | v0.35.0 | | Removed | [Using Redis for in-memory cache and queue](#using-redis-for-in-memory-cache-and-queue) | v0.32.0 | v0.36.0 | +| Deprecated | [`SECURITY_CONTEXT`](#security_context) | v0.33.0 | | | Deprecated | [`running_total` measure type](#running_total-measure-type) | v0.33.39 | | | Removed | [Node.js 16](#nodejs-16) | v0.35.0 | v0.36.0 | | 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. ### `USER_CONTEXT` -**Deprecated in Release: v0.26.0** +**Removed in Release: v0.36.0** `USER_CONTEXT` has been renamed to `SECURITY_CONTEXT`. @@ -337,6 +338,14 @@ Cube Store is now the default cache and queue engine, [replacing Redis](https://cube.dev/blog/replacing-redis-with-cube-store). Please migrate to [Cube Store](https://cube.dev/blog/how-you-win-by-using-cube-store-part-1). +### `SECURITY_CONTEXT` + +**Deprecated in Release: v0.33.0** + +The `SECURITY_CONTEXT` context variable is deprecated. Use +[`query_rewrite`](https://cube.dev/docs/reference/configuration/config#query_rewrite) +instead. + ### `running_total` measure type **Deprecated in Release: v0.33.39** diff --git a/docs/pages/reference/cli.mdx b/docs/pages/reference/cli.mdx index e8ab6feeb3a79..1950069eb773b 100644 --- a/docs/pages/reference/cli.mdx +++ b/docs/pages/reference/cli.mdx @@ -105,7 +105,7 @@ practices._ ### Usage ```bash{promptUser: user} -npx cubejs-cli token -e TOKEN-EXPIRY -s SECRET -p FOO=BAR -u BAZ=QUX +npx cubejs-cli token -e TOKEN-EXPIRY -s SECRET -p FOO=BAR ``` ### Flags @@ -115,7 +115,6 @@ npx cubejs-cli token -e TOKEN-EXPIRY -s SECRET -p FOO=BAR -u BAZ=QUX | -e, --expiry           | Token expiry. Set to 0 for no expiry (default: "30 days") | `1 day`, `30 days`         | | -s, --secret | Cube app secret. Also can be set via environment variable `CUBEJS_API_SECRET` | - | | -p, --payload | Token Payload | `foo=bar`, `userId=2` | -| -u, --user-context | Token USER_CONTEXT Payload | `baz=qux`, `companyId=5` | ### Example diff --git a/docs/pages/reference/data-model/context-variables.mdx b/docs/pages/reference/data-model/context-variables.mdx index 9ae64909c67ae..c150d137beca3 100644 --- a/docs/pages/reference/data-model/context-variables.mdx +++ b/docs/pages/reference/data-model/context-variables.mdx @@ -734,7 +734,7 @@ cube(`users`, { `SECURITY_CONTEXT` is deprecated and may be removed in the upcoming versions. -Use [`queryRewrite`][ref-config-queryrewrite] instead. +Use [`query_rewrite`][ref-config-queryrewrite] instead. @@ -809,7 +809,7 @@ cube(`orders`, { ``` [ref-config-ext-ctx]: /reference/configuration/config#extendcontext -[ref-config-queryrewrite]: /reference/configuration/config#queryrewrite +[ref-config-queryrewrite]: /reference/configuration/config#query_rewrite [ref-config-req-ctx]: /reference/configuration/config#requestcontext [ref-recipe-control-access-cubes-views]: /guides/recipes/access-control/controlling-access-to-cubes-and-views