[Docs] Remove mentions of v2

FoalTS · May 30, 2022 · 960f284 · 960f284
1 parent 16f24c5
commit 960f284
Show file tree

Hide file tree

Showing 33 changed files with 1 addition and 87 deletions.
diff --git a/docs/docs/api-section/graphql.md b/docs/docs/api-section/graphql.md
@@ -228,8 +228,6 @@ export class RootResolverService {
 
 ## GraphiQL
 
-> *This feature is available from version 2.3 onwards.*
-
 ![GraphiQL](./images/graphiql.png)
 
 You can generate a `GraphiQL` page with the `GraphiQLController` class by installing the following package.

diff --git a/docs/docs/architecture/configuration.md b/docs/docs/architecture/configuration.md
@@ -284,8 +284,6 @@ Just like the configuration files in the `config/` directory, the `.env` files c
 
 ### Using `*.local` files
 
-> *This feature is available from version 2.3 onwards.*
-
 In case you want to have two `.env` files, one to define the default env vars needed by the application and another to override these values on your local machine, you can use a `.env.local` file.
 
 If a variable is defined in both files, the value in the `.env.local` file will take precedence.

diff --git a/docs/docs/authentication-and-access-control/session-tokens.md b/docs/docs/authentication-and-access-control/session-tokens.md
@@ -480,8 +480,6 @@ export class AuthController {
 
 ## Reading User Information on the Client (cookies)
 
-> *This feature is available from version 2.2 onwards.*
-
 When building a SPA with cookie-based authentication, it can sometimes be difficult to know if the user is logged in or to obtain certain information about the user (`isAdmin`, etc).
 
 Since the authentication token is stored in a cookie with the `httpOnly` directive set to `true` (to mitigate XSS attacks), the front-end application has no way of knowing if a user is logged in, except by making an additional request to the server.

diff --git a/docs/docs/authentication-and-access-control/social-auth.md b/docs/docs/authentication-and-access-control/social-auth.md
@@ -367,14 +367,10 @@ export class GithubProvider extends AbstractProvider<GithubAuthParameter, Github
 
 ### Sending the Client Credentials in an Authorization Header
 
-> *This feature is available from version 2.9 onwards.*
-
 When requesting the token endpoint, the provider sends the client ID and secret as a query parameter by default. If you want to send them in an `Authorization` header using the *basic* scheme, you can do so by setting the `useAuthorizationHeaderForTokenEndpoint` property to `true`.
 
 ### Enabling Code Flow with PKCE
 
-> *This feature is available from version 2.9 onwards.*
-
 If you want to enable code flow with PKCE, you can do so by setting the `usePKCE` property to `true`.
 
 > By default, the provider will perform a SHA256 hash to generate the code challenge. If you wish to use the plaintext code verifier string as code challenge, you can do so by setting the `useCodeVerifierAsCodeChallenge` property to `true`.
@@ -553,8 +549,6 @@ const { userInfo } = await this.linkedin.getUserInfo(ctx, {
 
 ### Twitter
 
-> *This feature is available from version 2.9 onwards.*
-
 |Service name| Default scopes | Available scopes |
 |---|---|---|
 | `TwitterProvider` | `users.read tweet.read` | [API documentation](https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me) |

diff --git a/docs/docs/common/conversions.md b/docs/docs/common/conversions.md
@@ -18,8 +18,6 @@ const foo = convertBase64ToBase64url('bar');
 
 ## Base64URL to Base64
 
-> *This feature is available from version 2.3 onwards.*
-
 This function converts a base64URL-encoded string into a base64-encoded string. 
 
 It replaces the characters `-` and `_` with `+` and `/` and adds the `=` padding character(s) if any.
@@ -32,8 +30,6 @@ const foo = convertBase64urlToBase64('bar');
 
 ## Stream to Buffer
 
-> *This feature is available from version 2.3 onwards.*
-
 This function converts a stream of buffers into a concatenated buffer. It returns a promise.
 
 If the stream emits an error, the promise is rejected with the emitted error.

diff --git a/docs/docs/cookbook/not-found-page.md b/docs/docs/cookbook/not-found-page.md
@@ -27,8 +27,6 @@ class AppController {
 
 In case you want to intercept all HTTP verbs (POST, PUT, etc), you can also use the `@All` decorator for this.
 
-> *This feature is available from version 2.1 onwards.*
-
 ```typescript
 import { All, HttpResponseNotFound } from '@foal/core';
 

diff --git a/docs/docs/security/csrf-protection.md b/docs/docs/security/csrf-protection.md
@@ -526,8 +526,6 @@ module.exports = {
 
 ### Disable CSRF protection on a specific route
 
-> *This feature is available from version 2.1 onwards.*
-
 In case the CSRF protection is enabled globally and you want to disable it for a specific route, you can use the `csrf` option for that.
 
 ```typescript

diff --git a/docs/docs/websockets.md b/docs/docs/websockets.md
@@ -3,8 +3,6 @@ title: Real-Time Communication
 sidebar_label: WebSockets
 ---
 
-> *This feature is available from version 2.8 onwards.*
-
 Foal allows you to establish two-way interactive communication between your server(s) and your clients. For this, it uses the [socket.io v4](https://socket.io/) library which is primarily based on the **WebSocket** protocol. It supports disconnection detection and automatic reconnection and works with proxies and load balancers.
 
 ## Get Started

diff --git a/docs/i18n/es/docusaurus-plugin-content-docs/current/api-section/graphql.md b/docs/i18n/es/docusaurus-plugin-content-docs/current/api-section/graphql.md
@@ -228,8 +228,6 @@ export class RootResolverService {
 
 ## GraphiQL
 
-> *This feature is available from version 2.3 onwards.*
-
 ![GraphiQL](./images/graphiql.png)
 
 You can generate a `GraphiQL` page with the `GraphiQLController` class by installing the following package.

diff --git a/docs/i18n/es/docusaurus-plugin-content-docs/current/architecture/configuration.md b/docs/i18n/es/docusaurus-plugin-content-docs/current/architecture/configuration.md
@@ -284,8 +284,6 @@ Just like the configuration files in the `config/` directory, the `.env` files c
 
 ### Using `*.local` files
 
-> *This feature is available from version 2.3 onwards.*
-
 In case you want to have two `.env` files, one to define the default env vars needed by the application and another to override these values on your local machine, you can use a `.env.local` file.
 
 If a variable is defined in both files, the value in the `.env.local` file will take precedence.

diff --git a/...plugin-content-docs/current/authentication-and-access-control/session-tokens.md b/...plugin-content-docs/current/authentication-and-access-control/session-tokens.md
@@ -478,8 +478,6 @@ export class AuthController {
 
 ## Reading User Information on the Client (cookies)
 
-> *This feature is available from version 2.2 onwards.*
-
 When building a SPA with cookie-based authentication, it can sometimes be difficult to know if the user is logged in or to obtain certain information about the user (`isAdmin`, etc).
 
 Since the authentication token is stored in a cookie with the `httpOnly` directive set to `true` (to mitigate XSS attacks), the front-end application has no way of knowing if a user is logged in, except by making an additional request to the server.

diff --git a/...us-plugin-content-docs/current/authentication-and-access-control/social-auth.md b/...us-plugin-content-docs/current/authentication-and-access-control/social-auth.md
@@ -367,13 +367,10 @@ export class GithubProvider extends AbstractProvider<GithubAuthParameter, Github
 
 ### Sending the Client Credentials in an Authorization Header
 
-> *This feature is available from version 2.9 onwards.*
-
 When requesting the token endpoint, the provider sends the client ID and secret as a query parameter by default. If you want to send them in an `Authorization` header using the *basic* scheme, you can do so by setting the `useAuthorizationHeaderForTokenEndpoint` property to `true`.
 
 ### Enabling Code Flow with PKCE
 
-> *This feature is available from version 2.9 onwards.*
 
 If you want to enable code flow with PKCE, you can do so by setting the `usePKCE` property to `true`.
 
@@ -553,8 +550,6 @@ const { userInfo } = await this.linkedin.getUserInfo(ctx, {
 
 ### Twitter
 
-> *This feature is available from version 2.9 onwards.*
-
 |Service name| Default scopes | Available scopes |
 |---|---|---|
 | `TwitterProvider` | `users.read tweet.read` | [API documentation](https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me) |

diff --git a/docs/i18n/es/docusaurus-plugin-content-docs/current/common/conversions.md b/docs/i18n/es/docusaurus-plugin-content-docs/current/common/conversions.md
@@ -18,8 +18,6 @@ const foo = convertBase64ToBase64url('bar');
 
 ## Base64URL to Base64
 
-> *This feature is available from version 2.3 onwards.*
-
 This function converts a base64URL-encoded string into a base64-encoded string. 
 
 It replaces the characters `-` and `_` with `+` and `/` and adds the `=` padding character(s) if any.
@@ -32,8 +30,6 @@ const foo = convertBase64urlToBase64('bar');
 
 ## Stream to Buffer
 
-> *This feature is available from version 2.3 onwards.*
-
 This function converts a stream of buffers into a concatenated buffer. It returns a promise.
 
 If the stream emits an error, the promise is rejected with the emitted error.

diff --git a/docs/i18n/es/docusaurus-plugin-content-docs/current/cookbook/not-found-page.md b/docs/i18n/es/docusaurus-plugin-content-docs/current/cookbook/not-found-page.md
@@ -27,8 +27,6 @@ class AppController {
 
 In case you want to intercept all HTTP verbs (POST, PUT, etc), you can also use the `@All` decorator for this.
 
-> *This feature is available from version 2.1 onwards.*
-
 ```typescript
 import { All, HttpResponseNotFound } from '@foal/core';
 

diff --git a/docs/i18n/es/docusaurus-plugin-content-docs/current/security/csrf-protection.md b/docs/i18n/es/docusaurus-plugin-content-docs/current/security/csrf-protection.md
@@ -529,8 +529,6 @@ module.exports = {
 
 ### Disable CSRF protection on a specific route
 
-> *This feature is available from version 2.1 onwards.*
-
 In case the CSRF protection is enabled globally and you want to disable it for a specific route, you can use the `csrf` option for that.
 
 ```typescript

diff --git a/docs/i18n/es/docusaurus-plugin-content-docs/current/websockets.md b/docs/i18n/es/docusaurus-plugin-content-docs/current/websockets.md
@@ -3,8 +3,6 @@ title: Comunicación en Tiempo Real
 sidebar_label: WebSockets
 ---
 
-> *This feature is available from version 2.8 onwards.*
-
 Foal allows you to establish two-way interactive communication between your server(s) and your clients. For this, it uses the [socket.io v4](https://socket.io/) library which is primarily based on the **WebSocket** protocol. It supports disconnection detection and automatic reconnection and works with proxies and load balancers.
 
 ## Get Started

diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/api-section/graphql.md b/docs/i18n/fr/docusaurus-plugin-content-docs/current/api-section/graphql.md
@@ -228,8 +228,6 @@ export class RootResolverService {
 
 ## GraphiQL
 
-> *This feature is available from version 2.3 onwards.*
-
 ![GraphiQL](./images/graphiql.png)
 
 You can generate a `GraphiQL` page with the `GraphiQLController` class by installing the following package.

diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/architecture/configuration.md b/docs/i18n/fr/docusaurus-plugin-content-docs/current/architecture/configuration.md
@@ -284,8 +284,6 @@ Just like the configuration files in the `config/` directory, the `.env` files c
 
 ### Using `*.local` files
 
-> *This feature is available from version 2.3 onwards.*
-
 In case you want to have two `.env` files, one to define the default env vars needed by the application and another to override these values on your local machine, you can use a `.env.local` file.
 
 If a variable is defined in both files, the value in the `.env.local` file will take precedence.

diff --git a/...plugin-content-docs/current/authentication-and-access-control/session-tokens.md b/...plugin-content-docs/current/authentication-and-access-control/session-tokens.md
@@ -478,7 +478,6 @@ export class AuthController {
 
 ## Reading User Information on the Client (cookies)
 
-> *This feature is available from version 2.2 onwards.*
 
 When building a SPA with cookie-based authentication, it can sometimes be difficult to know if the user is logged in or to obtain certain information about the user (`isAdmin`, etc).
 

diff --git a/...us-plugin-content-docs/current/authentication-and-access-control/social-auth.md b/...us-plugin-content-docs/current/authentication-and-access-control/social-auth.md
@@ -368,14 +368,10 @@ export class GithubProvider extends AbstractProvider<GithubAuthParameter, Github
 
 ### Sending the Client Credentials in an Authorization Header
 
-> *This feature is available from version 2.9 onwards.*
-
 When requesting the token endpoint, the provider sends the client ID and secret as a query parameter by default. If you want to send them in an `Authorization` header using the *basic* scheme, you can do so by setting the `useAuthorizationHeaderForTokenEndpoint` property to `true`.
 
 ### Enabling Code Flow with PKCE
 
-> *This feature is available from version 2.9 onwards.*
-
 If you want to enable code flow with PKCE, you can do so by setting the `usePKCE` property to `true`.
 
 > By default, the provider will perform a SHA256 hash to generate the code challenge. If you wish to use the plaintext code verifier string as code challenge, you can do so by setting the `useCodeVerifierAsCodeChallenge` property to `true`.
@@ -554,8 +550,6 @@ const { userInfo } = await this.linkedin.getUserInfo(ctx, {
 
 ### Twitter
 
-> *This feature is available from version 2.9 onwards.*
-
 |Service name| Default scopes | Available scopes |
 |---|---|---|
 | `TwitterProvider` | `users.read tweet.read` | [API documentation](https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me) |

diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/common/conversions.md b/docs/i18n/fr/docusaurus-plugin-content-docs/current/common/conversions.md
@@ -18,8 +18,6 @@ const foo = convertBase64ToBase64url('bar');
 
 ## Base64URL to Base64
 
-> *This feature is available from version 2.3 onwards.*
-
 This function converts a base64URL-encoded string into a base64-encoded string. 
 
 It replaces the characters `-` and `_` with `+` and `/` and adds the `=` padding character(s) if any.
@@ -32,8 +30,6 @@ const foo = convertBase64urlToBase64('bar');
 
 ## Stream to Buffer
 
-> *This feature is available from version 2.3 onwards.*
-
 This function converts a stream of buffers into a concatenated buffer. It returns a promise.
 
 If the stream emits an error, the promise is rejected with the emitted error.

diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/cookbook/not-found-page.md b/docs/i18n/fr/docusaurus-plugin-content-docs/current/cookbook/not-found-page.md
@@ -27,8 +27,6 @@ class AppController {
 
 In case you want to intercept all HTTP verbs (POST, PUT, etc), you can also use the `@All` decorator for this.
 
-> *This feature is available from version 2.1 onwards.*
-
 ```typescript
 import { All, HttpResponseNotFound } from '@foal/core';
 

diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/security/csrf-protection.md b/docs/i18n/fr/docusaurus-plugin-content-docs/current/security/csrf-protection.md
@@ -529,8 +529,6 @@ module.exports = {
 
 ### Disable CSRF protection on a specific route
 
-> *This feature is available from version 2.1 onwards.*
-
 In case the CSRF protection is enabled globally and you want to disable it for a specific route, you can use the `csrf` option for that.
 
 ```typescript

diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/websockets.md b/docs/i18n/fr/docusaurus-plugin-content-docs/current/websockets.md
@@ -3,8 +3,6 @@ title: Communication en Temps Réel
 sidebar_label: WebSockets
 ---
 
-> *This feature is available from version 2.8 onwards.*
-
 Foal allows you to establish two-way interactive communication between your server(s) and your clients. For this, it uses the [socket.io v4](https://socket.io/) library which is primarily based on the **WebSocket** protocol. It supports disconnection detection and automatic reconnection and works with proxies and load balancers.
 
 ## Get Started

diff --git a/docs/i18n/id/docusaurus-plugin-content-docs/current/api-section/graphql.md b/docs/i18n/id/docusaurus-plugin-content-docs/current/api-section/graphql.md
@@ -228,8 +228,6 @@ export class RootResolverService {
 
 ## GraphiQL
 
-> *This feature is available from version 2.3 onwards.*
-
 ![GraphiQL](./images/graphiql.png)
 
 You can generate a `GraphiQL` page with the `GraphiQLController` class by installing the following package.

diff --git a/docs/i18n/id/docusaurus-plugin-content-docs/current/architecture/configuration.md b/docs/i18n/id/docusaurus-plugin-content-docs/current/architecture/configuration.md
@@ -284,8 +284,6 @@ Just like the configuration files in the `config/` directory, the `.env` files c
 
 ### Using `*.local` files
 
-> *This feature is available from version 2.3 onwards.*
-
 In case you want to have two `.env` files, one to define the default env vars needed by the application and another to override these values on your local machine, you can use a `.env.local` file.
 
 If a variable is defined in both files, the value in the `.env.local` file will take precedence.

diff --git a/...plugin-content-docs/current/authentication-and-access-control/session-tokens.md b/...plugin-content-docs/current/authentication-and-access-control/session-tokens.md
@@ -478,8 +478,6 @@ export class AuthController {
 
 ## Reading User Information on the Client (cookies)
 
-> *This feature is available from version 2.2 onwards.*
-
 When building a SPA with cookie-based authentication, it can sometimes be difficult to know if the user is logged in or to obtain certain information about the user (`isAdmin`, etc).
 
 Since the authentication token is stored in a cookie with the `httpOnly` directive set to `true` (to mitigate XSS attacks), the front-end application has no way of knowing if a user is logged in, except by making an additional request to the server.

diff --git a/...us-plugin-content-docs/current/authentication-and-access-control/social-auth.md b/...us-plugin-content-docs/current/authentication-and-access-control/social-auth.md
@@ -368,14 +368,10 @@ export class GithubProvider extends AbstractProvider<GithubAuthParameter, Github
 
 ### Sending the Client Credentials in an Authorization Header
 
-> *This feature is available from version 2.9 onwards.*
-
 When requesting the token endpoint, the provider sends the client ID and secret as a query parameter by default. If you want to send them in an `Authorization` header using the *basic* scheme, you can do so by setting the `useAuthorizationHeaderForTokenEndpoint` property to `true`.
 
 ### Enabling Code Flow with PKCE
 
-> *This feature is available from version 2.9 onwards.*
-
 If you want to enable code flow with PKCE, you can do so by setting the `usePKCE` property to `true`.
 
 > By default, the provider will perform a SHA256 hash to generate the code challenge. If you wish to use the plaintext code verifier string as code challenge, you can do so by setting the `useCodeVerifierAsCodeChallenge` property to `true`.
@@ -554,8 +550,6 @@ const { userInfo } = await this.linkedin.getUserInfo(ctx, {
 
 ### Twitter
 
-> *This feature is available from version 2.9 onwards.*
-
 |Service name| Default scopes | Available scopes |
 |---|---|---|
 | `TwitterProvider` | `users.read tweet.read` | [API documentation](https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me) |

diff --git a/docs/i18n/id/docusaurus-plugin-content-docs/current/common/conversions.md b/docs/i18n/id/docusaurus-plugin-content-docs/current/common/conversions.md
@@ -18,8 +18,6 @@ const foo = convertBase64ToBase64url('bar');
 
 ## Base64URL to Base64
 
-> *This feature is available from version 2.3 onwards.*
-
 This function converts a base64URL-encoded string into a base64-encoded string. 
 
 It replaces the characters `-` and `_` with `+` and `/` and adds the `=` padding character(s) if any.
@@ -32,8 +30,6 @@ const foo = convertBase64urlToBase64('bar');
 
 ## Stream to Buffer
 
-> *This feature is available from version 2.3 onwards.*
-
 This function converts a stream of buffers into a concatenated buffer. It returns a promise.
 
 If the stream emits an error, the promise is rejected with the emitted error.

diff --git a/docs/i18n/id/docusaurus-plugin-content-docs/current/cookbook/not-found-page.md b/docs/i18n/id/docusaurus-plugin-content-docs/current/cookbook/not-found-page.md
@@ -27,8 +27,6 @@ class AppController {
 
 In case you want to intercept all HTTP verbs (POST, PUT, etc), you can also use the `@All` decorator for this.
 
-> *This feature is available from version 2.1 onwards.*
-
 ```typescript
 import { All, HttpResponseNotFound } from '@foal/core';
 

diff --git a/docs/i18n/id/docusaurus-plugin-content-docs/current/security/csrf-protection.md b/docs/i18n/id/docusaurus-plugin-content-docs/current/security/csrf-protection.md
@@ -529,8 +529,6 @@ module.exports = {
 
 ### Disable CSRF protection on a specific route
 
-> *This feature is available from version 2.1 onwards.*
-
 In case the CSRF protection is enabled globally and you want to disable it for a specific route, you can use the `csrf` option for that.
 
 ```typescript

diff --git a/docs/i18n/id/docusaurus-plugin-content-docs/current/websockets.md b/docs/i18n/id/docusaurus-plugin-content-docs/current/websockets.md
@@ -3,8 +3,6 @@ title: Real-Time Communication
 sidebar_label: WebSockets
 ---
 
-> *This feature is available from version 2.8 onwards.*
-
 Foal allows you to establish two-way interactive communication between your server(s) and your clients. For this, it uses the [socket.io v4](https://socket.io/) library which is primarily based on the **WebSocket** protocol. It supports disconnection detection and automatic reconnection and works with proxies and load balancers.
 
 ## Get Started

diff --git a/packages/examples/src/app/controllers/auth.controller.ts b/packages/examples/src/app/controllers/auth.controller.ts
@@ -75,7 +75,7 @@ export class AuthController {
   }
 
   @Get('/signin/twitter')
-  redirectToTwittern() {
+  redirectToTwitter() {
     return this.twitter.redirect();
   }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -478,7 +478,6 @@ export class AuthController {

		## Reading User Information on the Client (cookies)

		> This feature is available from version 2.2 onwards.

		When building a SPA with cookie-based authentication, it can sometimes be difficult to know if the user is logged in or to obtain certain information about the user (`isAdmin`, etc).

Expand Down