Skip to content

Commit c0ce566

Browse files
authored
Apifw api mode max errors in response decs (#131)
* detailed desc for the APIFW_API_MODE_MAX_ERRORS_IN_RESPONSE env var * broken link fix
1 parent 3ee7ccc commit c0ce566

File tree

6 files changed

+10
-9
lines changed

6 files changed

+10
-9
lines changed

docs/configuration-guides/allowlist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ docker run --rm -it --network api-firewall-network --network-alias api-firewall
3333
-e APIFW_URL=<API_FIREWALL_URL> -e APIFW_SERVER_URL=<PROTECTED_APP_URL> \
3434
-e APIFW_REQUEST_VALIDATION=<REQUEST_VALIDATION_MODE> -e APIFW_RESPONSE_VALIDATION=<RESPONSE_VALIDATION_MODE> \
3535
-e APIFW_ALLOW_IP_FILE=/opt/ip-allowlist.txt -e APIFW_ALLOW_IP_HEADER_NAME="X-Real-IP" \
36-
-p 8088:8088 wallarm/api-firewall:v0.8.6
36+
-p 8088:8088 wallarm/api-firewall:v0.9.1
3737
```
3838
3939
| Environment variable | Description |

docs/configuration-guides/dns-cache-update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
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.
44

55
!!! info "Feature availability"
6-
This feature and corresponding variables are supported only in the [`PROXY`](installation-guides/docker-container.md) API Firewall mode.
6+
This feature and corresponding variables are supported only in the [`PROXY`](../installation-guides/docker-container.md) API Firewall mode.
77

88
To configure the DNS cache update, use the following environment variables:
99

docs/installation-guides/api-mode.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Use the following command to run the API Firewall container:
3838

3939
```
4040
docker run --rm -it -v <PATH_TO_SQLITE_DATABASE>:/var/lib/wallarm-api/1/wallarm_api.db \
41-
-e APIFW_MODE=API -p 8282:8282 wallarm/api-firewall:v0.8.6
41+
-e APIFW_MODE=API -p 8282:8282 wallarm/api-firewall:v0.9.1
4242
```
4343

4444
You can pass to the container the following variables:
@@ -55,6 +55,7 @@ You can pass to the container the following variables:
5555
| `APIFW_WRITE_TIMEOUT` | The timeout for API Firewall to return the response to the request. The default value is `5s`. | No |
5656
| `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 |
5757
| `APIFW_API_MODE_DB_VERSION` | Determines the SQLite database version that the API Firewall is configured to use. Available options are:<ul><li>`0` (default) - tries to load V2 (with the `status` field) first; if unsuccessful, attempts V1. On both failures, the firewall fails to start.</li><li>`1` - recognize and process the database as V1 only.</li><li>`2` - recognize and process the database as V2 only.</li></ul> | No |
58+
|`APIFW_API_MODE_MAX_ERRORS_IN_RESPONSE` | Limits the number of errors included in the API Firewall response for a single request validation.<br><br>The default value is `0`, which means no limit is applied.<br><br>Supported starting from version 0.9.1. | No |
5859

5960
## Evaluating requests against the specification
6061

docs/installation-guides/docker-container.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ networks:
2727
services:
2828
api-firewall:
2929
container_name: api-firewall
30-
image: wallarm/api-firewall:v0.8.6
30+
image: wallarm/api-firewall:v0.9.1
3131
restart: on-failure
3232
volumes:
3333
- <HOST_PATH_TO_SPEC>:<CONTAINER_PATH_TO_SPEC>
@@ -169,6 +169,6 @@ To start API Firewall on Docker, you can also use regular Docker commands as in
169169
-v <HOST_PATH_TO_SPEC>:<CONTAINER_PATH_TO_SPEC> -e APIFW_API_SPECS=<PATH_TO_MOUNTED_SPEC> \
170170
-e APIFW_URL=<API_FIREWALL_URL> -e APIFW_SERVER_URL=<PROTECTED_APP_URL> \
171171
-e APIFW_REQUEST_VALIDATION=<REQUEST_VALIDATION_MODE> -e APIFW_RESPONSE_VALIDATION=<RESPONSE_VALIDATION_MODE> \
172-
-p 8088:8088 wallarm/api-firewall:v0.8.6
172+
-p 8088:8088 wallarm/api-firewall:v0.9.1
173173
```
174174
4. When the environment is started, test it and enable traffic on API Firewall following steps 6 and 7.

docs/installation-guides/graphql/docker-container.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ networks:
2929
services:
3030
api-firewall:
3131
container_name: api-firewall
32-
image: wallarm/api-firewall:v0.8.6
32+
image: wallarm/api-firewall:v0.9.1
3333
restart: on-failure
3434
volumes:
3535
- <HOST_PATH_TO_SPEC>:<CONTAINER_PATH_TO_SPEC>
@@ -200,6 +200,6 @@ To start API Firewall on Docker, you can also use regular Docker commands as in
200200
-e APIFW_GRAPHQL_MAX_QUERY_COMPLEXITY=<MAX_QUERY_COMPLEXITY> \
201201
-e APIFW_GRAPHQL_MAX_QUERY_DEPTH=<MAX_QUERY_DEPTH> -e APIFW_GRAPHQL_NODE_COUNT_LIMIT=<NODE_COUNT_LIMIT> \
202202
-e APIFW_GRAPHQL_INTROSPECTION=<ALLOW_INTROSPECTION_OR_NOT> \
203-
-p 8088:8088 wallarm/api-firewall:v0.8.6
203+
-p 8088:8088 wallarm/api-firewall:v0.9.1
204204
```
205205
4. When the environment is started, test it and enable traffic on API Firewall following steps 6 and 7.

docs/release-notes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This page describes new releases of Wallarm API Firewall.
44

55
## v0.9.1 (2025-04-23)
66

7+
* 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
8+
* Fixed the `related_fields_details` field issues in the `API` mode
79
* Dependency upgrade
8-
* Add APIFW_API_MODE_MAX_ERRORS_IN_RESPONSE param to limit the response size in API mode
9-
* Fix related_fields_details field issue in API mode
1010

1111
## v0.9.0 (2025-04-04)
1212

0 commit comments

Comments
 (0)