Skip to content

Commit 5129979

Browse files
fabriziofioruccifabriziofiorucci
authored
5.2.3 (#84)
* 20250306 - 5.2.3 dev * Postman collection updated * 20250312 - v5.2.3 - Cache support added
1 parent de4c43e commit 5129979

7 files changed

+261
-422
lines changed

‎FEATURES.md

+21-14
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ NGINX Declarative API has been tested with the following NGINX control plane rel
2020
| TLS | X | X | X | <li>Certificates and keys can be dynamically fetched from source of truth (currently supported for NGINX Instance Manager)</li> |
2121
| Client authentication | X | X | X | See [client authentication](#Client-authentication) |
2222
| Upstream authentication | X | X | X | See [upstream and Source of truth authentication](#Upstream-and-Source-of-truth-authentication) |
23-
| Rate limiting | X | X | X | |
23+
| Rate limiting | X | X | X |
2424
| Active healthchecks | X | X | X | |
2525
| Cookie-based stickiness | X | X | X | |
2626
| HTTP headers manipulation | X | X | X | <li>To server: set, delete</li><li>To client: add, delete, replace</li> |
2727
| Maps | X | X | X | |
28+
| Cache | | | X | Supported for `http`, `servers`, `locations` and API Gateway |
2829
| NGINX Plus REST API access | X | X | X | |
2930
| NGINX App Protect WAF | X | X | X | NOTE: For NGINX Instance Manager only<li>Per-policy CRUD at `server` and `location` level</li><li>Support for dataplane-based bundle compilation</li><li>Security policies can be fetched from source of truth</li> |
3031

@@ -40,15 +41,17 @@ Locations `.declaration.http.servers[].locations[].uri` match modifiers in `.dec
4041

4142
### NGINX API Gateway use case
4243

43-
| Feature | API v5.0 | API v5.1 | API v5.2 | Notes |
44-
|----------------------------------------------|------------------------------------|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------|-----------------------------------------|
45-
| Configuration generation from OpenAPI schema | X | X | X | OpenAPI 2.0, 3.0, 3.0.1 |
46-
| HTTP methods enforcement | X | X | X | |
47-
| per-URI rate limiting | X | X | X | |
48-
| per-URI client authentication | X | <li>Static JWT key</li><li>JWT key fetched from URL</li><li>Bearer token</li> | <li>Static JWT key</li><li>JWT key fetched from URL</li><li>Bearer token</li> | |
49-
| per-URI client authorization | X | <li>JWT claims</li> | <li>JWT claims</li> | |
50-
| Developer portal | <li>Redocly</li><li>Backstage</li> | <li>Redocly</li><li>Backstage</li> | <li>Redocly</li><li>Backstage</li> | Supported through 3rd party integration |
51-
| API visibility | | <li>Moesif</li> | <li>Moesif</li> | Supported through 3rd party integration |
44+
| Feature | API v5.0 | API v5.1 | API v5.2 | Notes |
45+
|----------------------------------------------|------------------------------------|-----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|-----------------------------------------|
46+
| Configuration generation from OpenAPI schema | X | X | X | OpenAPI 2.0, 3.0, 3.0.1 |
47+
| HTTP methods enforcement | X | X | X | |
48+
| per-URI rate limiting | X | X | X | |
49+
| per-URI client authentication | X | <li>Static JWT key</li><li>JWT key fetched from URL</li><li>Bearer token</li> | <li>Static JWT key</li><li>JWT key fetched from URL</li><li>Bearer token</li> | |
50+
| per-URI client authorization | X | <li>JWT claims</li> | <li>JWT claims</li> | |
51+
| per-URI cache | | | X |
52+
| Developer portal | <li>Redocly</li><li>Backstage</li> | <li>Redocly</li><li>Backstage</li> | <li>Redocly</li><li>Backstage</li> | Supported through 3rd party integration |
53+
| API visibility | | <li>Moesif</li> | <li>Moesif</li> | Supported through 3rd party integration |
54+
5255

5356
Swagger files and OpenAPI schemas can be used to automatically configure NGINX as an API Gateway
5457

@@ -68,12 +71,16 @@ Declaration path `.declaration.http.servers[].locations[].apigateway` defines th
6871
- `visibility[].moesif.*` - Moesif visibility parameters. See the [Postman collection](/contrib/postman)
6972
- `authentication` - optional, used to enforce authentication at the API Gateway level
7073
- `authentication.client[]` - authentication profile names
71-
- `authentication.enforceOnPaths` - if set to `true` authentication is enforced on all API endpoints listed under `authentication.paths`. if set to `false` authentication is enforced on all API endpoints but those listed under `authentication.paths`
72-
- `authentication.paths` - paths to enforce authentication
74+
- `authentication.enforceOnPaths` - if set to `true` authentication is enforced on all API endpoints listed under `authentication[].paths`. if set to `false` authentication is enforced on all API endpoints but those listed under `authentication.paths`
75+
- `authentication.paths` - paths to enforce authentication on
7376
- `authorization[]` - optional, used to enforce authorization
7477
- `authorization[].profile` - authorization profile name
75-
- `authorization[].enforceOnPaths` - if set to `true` authorization is enforced on all API endpoints listed under `authorization.paths`. if set to `false` authorization is enforced on all API endpoints but those listed under `authorization[].paths`
76-
- `authorization[].paths` - paths to enforce authorization
78+
- `authorization[].enforceOnPaths` - if set to `true` authorization is enforced on all API endpoints listed under `authorization[].paths`. if set to `false` authorization is enforced on all API endpoints but those listed under `authorization[].paths`
79+
- `authorization[].paths` - paths to enforce authorization on
80+
- `cache[]` - optional, used to enforce authorization
81+
- `cache[].profile` - cache profile name
82+
- `cache[].enforceOnPaths` - if set to `true` caching is performed on all API endpoints listed under `cache[].paths`. if set to `false` caching is performed on all API endpoints but those listed under `cache[].paths`
83+
- `cache[].paths` - paths to perform caching on
7784
- `rate_limit` - optional, used to enforce rate limiting at the API Gateway level
7885
- `rate_limit.enforceOnPaths` - if set to `true` rate limiting is enforced on all API endpoints listed under `rate_limit.paths`. if set to `false` rate limiting is enforced on all API endpoints but those listed under `rate_limit.paths`
7986

0 commit comments

Comments
 (0)