diff --git a/docs/configuration-guides/allowlist.md b/docs/configuration-guides/allowlist.md index 5c238f4c..25adca12 100644 --- a/docs/configuration-guides/allowlist.md +++ b/docs/configuration-guides/allowlist.md @@ -33,7 +33,7 @@ docker run --rm -it --network api-firewall-network --network-alias api-firewall -e APIFW_URL= -e APIFW_SERVER_URL= \ -e APIFW_REQUEST_VALIDATION= -e APIFW_RESPONSE_VALIDATION= \ -e APIFW_ALLOW_IP_FILE=/opt/ip-allowlist.txt -e APIFW_ALLOW_IP_HEADER_NAME="X-Real-IP" \ - -p 8088:8088 wallarm/api-firewall:v0.8.6 + -p 8088:8088 wallarm/api-firewall:v0.9.1 ``` | Environment variable | Description | diff --git a/docs/configuration-guides/dns-cache-update.md b/docs/configuration-guides/dns-cache-update.md index 1f4db426..00a70b96 100644 --- a/docs/configuration-guides/dns-cache-update.md +++ b/docs/configuration-guides/dns-cache-update.md @@ -3,7 +3,7 @@ The DNS cache update feature allows you to make asynchronous DNS requests and cache results for a configured period of time. This feature could be useful when DNS load balancing is used. !!! info "Feature availability" - This feature and corresponding variables are supported only in the [`PROXY`](installation-guides/docker-container.md) API Firewall mode. + This feature and corresponding variables are supported only in the [`PROXY`](../installation-guides/docker-container.md) API Firewall mode. To configure the DNS cache update, use the following environment variables: diff --git a/docs/installation-guides/api-mode.md b/docs/installation-guides/api-mode.md index fd03af1e..633b69b9 100644 --- a/docs/installation-guides/api-mode.md +++ b/docs/installation-guides/api-mode.md @@ -38,7 +38,7 @@ Use the following command to run the API Firewall container: ``` docker run --rm -it -v :/var/lib/wallarm-api/1/wallarm_api.db \ - -e APIFW_MODE=API -p 8282:8282 wallarm/api-firewall:v0.8.6 + -e APIFW_MODE=API -p 8282:8282 wallarm/api-firewall:v0.9.1 ``` You can pass to the container the following variables: @@ -55,6 +55,7 @@ You can pass to the container the following variables: | `APIFW_WRITE_TIMEOUT` | The timeout for API Firewall to return the response to the request. The default value is `5s`. | No | | `APIFW_HEALTH_HOST` | The host of the health check service. The default value is `0.0.0.0:9667`. The liveness probe service path is `/v1/liveness` and the readiness service path is `/v1/readiness`. | No | | `APIFW_API_MODE_DB_VERSION` | Determines the SQLite database version that the API Firewall is configured to use. Available options are:
  • `0` (default) - tries to load V2 (with the `status` field) first; if unsuccessful, attempts V1. On both failures, the firewall fails to start.
  • `1` - recognize and process the database as V1 only.
  • `2` - recognize and process the database as V2 only.
| No | +|`APIFW_API_MODE_MAX_ERRORS_IN_RESPONSE` | Limits the number of errors included in the API Firewall response for a single request validation.

The default value is `0`, which means no limit is applied.

Supported starting from version 0.9.1. | No | ## Evaluating requests against the specification diff --git a/docs/installation-guides/docker-container.md b/docs/installation-guides/docker-container.md index faf10650..ee31ebd8 100644 --- a/docs/installation-guides/docker-container.md +++ b/docs/installation-guides/docker-container.md @@ -27,7 +27,7 @@ networks: services: api-firewall: container_name: api-firewall - image: wallarm/api-firewall:v0.8.6 + image: wallarm/api-firewall:v0.9.1 restart: on-failure volumes: - : @@ -169,6 +169,6 @@ To start API Firewall on Docker, you can also use regular Docker commands as in -v : -e APIFW_API_SPECS= \ -e APIFW_URL= -e APIFW_SERVER_URL= \ -e APIFW_REQUEST_VALIDATION= -e APIFW_RESPONSE_VALIDATION= \ - -p 8088:8088 wallarm/api-firewall:v0.8.6 + -p 8088:8088 wallarm/api-firewall:v0.9.1 ``` 4. When the environment is started, test it and enable traffic on API Firewall following steps 6 and 7. diff --git a/docs/installation-guides/graphql/docker-container.md b/docs/installation-guides/graphql/docker-container.md index 42abb3e4..b0dfa3e8 100644 --- a/docs/installation-guides/graphql/docker-container.md +++ b/docs/installation-guides/graphql/docker-container.md @@ -29,7 +29,7 @@ networks: services: api-firewall: container_name: api-firewall - image: wallarm/api-firewall:v0.8.6 + image: wallarm/api-firewall:v0.9.1 restart: on-failure volumes: - : @@ -200,6 +200,6 @@ To start API Firewall on Docker, you can also use regular Docker commands as in -e APIFW_GRAPHQL_MAX_QUERY_COMPLEXITY= \ -e APIFW_GRAPHQL_MAX_QUERY_DEPTH= -e APIFW_GRAPHQL_NODE_COUNT_LIMIT= \ -e APIFW_GRAPHQL_INTROSPECTION= \ - -p 8088:8088 wallarm/api-firewall:v0.8.6 + -p 8088:8088 wallarm/api-firewall:v0.9.1 ``` 4. When the environment is started, test it and enable traffic on API Firewall following steps 6 and 7. diff --git a/docs/release-notes.md b/docs/release-notes.md index 58b0546f..5240124e 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -4,9 +4,9 @@ This page describes new releases of Wallarm API Firewall. ## v0.9.1 (2025-04-23) +* Added the `APIFW_API_MODE_MAX_ERRORS_IN_RESPONSE` [environment variable to limit the number of returned validation errors](installation-guides/api-mode.md#running-the-api-firewall-container) in the `API` mode +* Fixed the `related_fields_details` field issues in the `API` mode * Dependency upgrade -* Add APIFW_API_MODE_MAX_ERRORS_IN_RESPONSE param to limit the response size in API mode -* Fix related_fields_details field issue in API mode ## v0.9.0 (2025-04-04)