From 1636e0acab812f6894152ea036560c5e9a3844c0 Mon Sep 17 00:00:00 2001 From: Glenn Date: Fri, 26 Jun 2026 09:50:00 -0400 Subject: [PATCH 1/6] Add release notes links to Omni Gateway policies Added release notes xrefs to 52 Omni Gateway policy documentation pages in gateway/1.13: - 42 included policies - 10 outbound policies Each policy now links to its corresponding release notes page in the docs-release-notes repo under flex-gateway/omni-gateway-policies. Co-Authored-By: Claude Sonnet 4.5 --- ...olicies-included-azure-content-safety.adoc | 1 + .../policies-included-basic-auth-ldap.adoc | 1 + .../policies-included-basic-auth-simple.adoc | 1 + .../policies-included-bedrock-guardrails.adoc | 1 + ...licies-included-client-id-enforcement.adoc | 1 + .../ROOT/pages/policies-included-cors.adoc | 1 + ...ncluded-dataweave-body-transformation.adoc | 1 + ...uded-dataweave-headers-transformation.adoc | 1 + ...ies-included-dataweave-request-filter.adoc | 1 + ...icies-included-external-authorization.adoc | 1 + ...policies-included-external-processing.adoc | 1 + ...ncluded-graphql-introspection-control.adoc | 1 + ...ies-included-graphql-operation-limits.adoc | 1 + ...es-included-graphql-schema-validation.adoc | 1 + ...luded-graphql-static-query-complexity.adoc | 1 + .../policies-included-header-injection.adoc | 1 + .../policies-included-header-removal.adoc | 1 + .../pages/policies-included-health-check.adoc | 1 + .../pages/policies-included-http-caching.adoc | 1 + ...olicies-included-injection-protection.adoc | 1 + .../pages/policies-included-ip-allowlist.adoc | 1 + .../pages/policies-included-ip-blocklist.adoc | 1 + ...icies-included-json-threat-protection.adoc | 1 + .../policies-included-jwt-validation.adoc | 1 + .../policies-included-message-logging.adoc | 1 + ...ded-oauth-protected-resource-metadata.adoc | 1 + ...es-included-oauth-token-introspection.adoc | 1 + ...ies-included-openid-token-enforcement.adoc | 1 + .../policies-included-rate-limiting-sla.adoc | 1 + .../policies-included-rate-limiting.adoc | 1 + .../policies-included-response-timeout.adoc | 1 + .../policies-included-schema-validation.adoc | 1 + ...icies-included-soap-schema-validation.adoc | 1 + .../policies-included-spike-control.adoc | 1 + ...policies-included-stream-idle-timeout.adoc | 1 + .../pages/policies-included-tls-outbound.adoc | 1 + .../ROOT/pages/policies-included-tls.adoc | 1 + .../ROOT/pages/policies-included-tracing.adoc | 1 + ...ies-included-traffic-management-route.adoc | 1 + .../policies-included-traffic-management.adoc | 1 + ...s-included-websocket-connection-limit.adoc | 1 + ...licies-included-xml-threat-protection.adoc | 1 + .../ROOT/pages/policies-outbound-api-key.adoc | 1 + .../pages/policies-outbound-aws-lambda.adoc | 1 + .../policies-outbound-aws-signature.adoc | 1 + .../pages/policies-outbound-basic-auth.adoc | 1 + .../policies-outbound-circuit-breaker.adoc | 1 + .../policies-outbound-jwt-generation.adoc | 1 + .../policies-outbound-message-logging.adoc | 1 + .../pages/policies-outbound-oauth-obo.adoc | 1 + .../ROOT/pages/policies-outbound-oauth.adoc | 1 + ...licies-outbound-upstream-idle-timeout.adoc | 1 + omni-policies-list.txt | 52 +++++++++++++++++++ 53 files changed, 104 insertions(+) create mode 100644 omni-policies-list.txt diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc index cd5c01286..c4889d6ee 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Azure AI Content Safety for harmful content, jailbreak attempts, hallucinations, and copyrighted material >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/azure-content-safety-release-notes.adoc[Azure Content Safety Policy] .>s| Returned Status Codes |403 - Forbidden: Content violates Azure Content Safety policies |503 - Service Unavailable: Azure API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc index 6dee81421..32be9e709 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with user-password defined on LDAP >s|Category | Security >s|First Omni Gateway version available | v1.1.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/basic-auth-ldap-release-notes.adoc[Basic Authentication: LDAP] .1+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc index e15f5861e..f37963665 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with a single user-password >s|Category | Security >s|First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/basic-auth-simple-release-notes.adoc[Basic Authentication: Simple] .1+>.^s| Returned Status Codes |400 - Unauthorized or invalid client application credentials in WSDL API using SOAP 1.2 | | 401 - Unauthorized or invalid client application credentials in HTTP or RAML APIs diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc index 54167165d..ff23f76d3 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Amazon Bedrock guardrails for content safety, PII detection, and contextual grounding >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/bedrock-guardrails-release-notes.adoc[Amazon Bedrock Guardrails Policy] .>s| Returned Status Codes |403 - Forbidden: Content violates guardrail policies |503 - Service Unavailable: Bedrock API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc index 654d09197..ea07fa773 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Compliance >s|First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/client-id-enforcement-release-notes.adoc[Client ID Enforcement] .4+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |500 - Bad response from authorization server, or WSDL SOAP Fault error diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc index 57c82d78e..82e024f0a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc @@ -12,6 +12,7 @@ endif::[] >s| Summary | Enables access to resources residing in external domains >s| Category | Compliance >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/cors-release-notes.adoc[Cross-Origin Resource Sharing (CORS)] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc index a15608e25..7d3f96b3a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Transforms the body of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/dataweave-body-transformation-release-notes.adoc[DataWeave Body Transformation] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc index 4a9898060..bd08d30b9 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Transforms headers of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/dataweave-headers-transformation-release-notes.adoc[DataWeave Headers Transformation] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc index 80da7642c..2a3b7e506 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Filters requests by using a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | 1.12 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/dataweave-request-filter-release-notes.adoc[DataWeave Request Filter] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc index b2098445c..b6fd6b1e5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Authenticates requests with an external gRPC or HTTP authorization service >s|Category | Security >s| First Omni Gateway version available | v1.6.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/external-authorization-release-notes.adoc[External Authorization Policy] >s| Returned Status Codes | 403 - Forbidden, invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc index 19e24f5f3..e93f0cf45 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Sends the incoming HTTP requests or outgoing HTTP responses requests to an external gRPC service for additional processing >s|Category | Transformation >s|First Omni Gateway version available | v1.6.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/external-processing-release-notes.adoc[External Processing] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc index fbd3520c5..05e4593cd 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc @@ -11,6 +11,7 @@ endif::[] >s| Summary | Blocks or allows requests that access the `__schema`, `__type`, and `__typename` GraphQL meta fields >s| Category | Security >s| First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/graphql-introspection-control-release-notes.adoc[GraphQL Introspection Control] .1+>.^s| Returned status codes | 403 Forbidden — The response follows the standard GraphQL error format, including a message such as `Introspection field '__schema' is not allowed`. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc index 833f69a1d..ea6d7ffc4 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc @@ -11,6 +11,7 @@ endif::[] >s| Summary | Limits GraphQL operation depth, aliases, root fields, and directives >s| Category | Security >s| First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/graphql-operation-limits-release-notes.adoc[GraphQL Operation Limits] .1+>.^s| Returned status codes | 400 - Operations that exceed a configured limit. The response follows the standard GraphQL error format and lists each violation. For example, `Query depth of 7 exceeds the maximum allowed depth of 5` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc index 2489f2b7e..98543d9d2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc @@ -11,6 +11,7 @@ endif::[] >s| Summary | Validates incoming GraphQL operations against a GraphQL schema definition >s| Category | Security >s| First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/graphql-schema-validation-release-notes.adoc[GraphQL Schema Validation] .1+>.^s| Returned status codes | 400 - The operation doesn't satisfy the schema. When *Block request* is enabled, the JSON response includes GraphQL-style `errors` with a validation message. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc index db6625865..ef61f50e4 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc @@ -11,6 +11,7 @@ endif::[] >s| Summary | Calculates query complexity and blocks requests that exceed the defined budget >s| Category | Security >s| First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/graphql-static-query-complexity-release-notes.adoc[GraphQL Static Query Complexity] .1+>.^s| Returned status codes | 400 - Parse failures always trigger a 400 response. Complexity and list violations return this code only if *Block request* is enabled. The response includes a standard GraphQL errors object. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc index 01f76931f..3fbece395 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Adds headers to a request or response. >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/header-injection-release-notes.adoc[Header Injection Policy] >s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc index 7fe46b906..91af4a6be 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Removes headers from a request or a response >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/header-removal-release-notes.adoc[Header Removal] .1+>.^s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc index 3ce53c465..ac289bb72 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Monitors API upstream health at specific intervals >s|Category | Quality of Service >s| First Omni Gateway version available | v1.4.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/health-check-release-notes.adoc[Health Check Policy] .1+>.^s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc index 6e0e52707..bb3d5c42d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Caches HTTP responses from an API implementation >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/http-caching-release-notes.adoc[HTTP caching] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc index 8ebe8e7ac..76c724263 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary| Scans incoming requests to protect against SQL, XSS, and custom injection attacks >s|Category| Security >s|First Omni Gateway version available |v1.12.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/injection-protection-release-notes.adoc[Injection Protection Policy] >s|Returned Status Codes|`400` - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc index 6638913a9..bc4b3b09b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Allows a list or range of specified IP addresses to request access >s|Category | Security >s|First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/ip-allowlist-release-notes.adoc[IP Allowlist] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc index ed970618a..feb4ed429 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Blocks a single IP address or a range of IP addresses from accessing an API endpoint >s|Category | Security >s|First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/ip-blocklist-release-notes.adoc[IP Blocklist] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc index bfe1aa4c7..942a00576 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary| Protects against malicious JSON in API requests >s|Category| Security >s|First Omni Gateway version available | v1.4.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/json-threat-protection-release-notes.adoc[JSON Threat Protection Policy] >s|Returned Status Codes| 400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc index 945a75788..ca1e65d68 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc @@ -12,6 +12,7 @@ endif::[] >s| Summary | Validates a JWT >s| Category | Security >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/jwt-validation-release-notes.adoc[JWT Validation] .4+>.^s| Returned Status Codes | |400 - Token was not provided in the request. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc index 1dab83c47..9d4a4e08f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Logs custom messages using information from incoming requests, responses from the backend, or information from other policies applied to the same API endpoint >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/message-logging-release-notes.adoc[Message Logging] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc index 3fd468ffd..93b62733a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Serves OAuth 2.0 Protected Resource Metadata at the well-known endpoint >s|Category | Security >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/oauth-protected-resource-metadata-release-notes.adoc[OAuth 2.0 Protected Resource Metadata] .2+>.^s| Returned Status Codes |404 - Request path does not match the well-known endpoint |405 - HTTP method is not GET diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc index 7592713d8..6f6eb0593 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.3.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/oauth-token-introspection-release-notes.adoc[OAuth 2.0 Token Introspection Policy] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc index bab3159d3..d5f9a9ae2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/openid-token-enforcement-release-notes.adoc[OpenID Connect OAuth 2.0 Token Enforcement] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc index 83f4fc328..81c19628a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc @@ -12,6 +12,7 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a timespan, based on SLAs >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/rate-limiting-sla-release-notes.adoc[Rate-limiting SLA] .4+>.^s| Returned Status Codes |401 - Request blocked due to invalid client credentials (client ID or client secret) provided |429 - Quota exceeded; requests blocked until the current window finishes diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc index 81f2a3269..deaee5585 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc @@ -12,6 +12,7 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a period of time >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/rate-limiting-release-notes.adoc[Rate Limiting] .4+>.^s| Returned Status Codes |429 - Quota exceeded, requests are blocked until the current window finishes |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc index 96985e08b..7596d0788 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Sets the maximum duration that Omni Gateway waits for a response from an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/response-timeout-release-notes.adoc[Response Timeout] ^s| Returned Status Codes | 504 - Upstream request timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc index 139b24674..ab81a22d7 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary| Validates incoming traffic against a supplied API schema >s|Category| Security >s|First Omni Gateway version available | v1.4.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/schema-validation-release-notes.adoc[Schema Validation Policy] >s|Returned Status Codes| 400 - The request properties do not comply with the API specifications. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc index 18d1e7d00..74d2250b7 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary| Validates incoming traffic against a specified WSDL schema >s|Category| Security >s|First Omni Gateway version available |v1.10.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/soap-schema-validation-release-notes.adoc[SOAP Schema Validation Policy] >.^s| Returned Status Codes | The policy returns a `400` for a client error or `500` for a server error. Error messages are defined by SOAP standard responses. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc index 32a77cb89..5fb331ece 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Regulates API traffic >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/spike-control-release-notes.adoc[Spike Control] .4+>.^s| Returned Status Codes | [%autowidth.spread,cols="a,a"] | 429 - The number of requests by HTTP APIs exceeded the configured limit. Request rejected after specified number of reattempts. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc index 43a4fed2a..f82173739 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Sets the maximum duration a stream can remain idle without receiving a request or response >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/stream-idle-timeout-release-notes.adoc[Stream Idle Timeout] ^s| Returned Status Codes | 504 - Stream timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc index f7f751ae9..110359482 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Enables two-way authentication between the API proxy and an upstream service >s|Category | Security >s| First Omni version available | v1.4.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/tls-outbound-release-notes.adoc[Transport Layer Security (TLS) - Outbound] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc index 5e4fb20e2..cc0f7c021 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Enables authentication between a client and the API proxy >s|Category | Security >s| First Omni Gateway version available | v1.0.0 (inbound mTLS: v1.3.0) +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/tls-release-notes.adoc[Transport Layer Security (TLS) - Inbound] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc index 67d737221..15953de2d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Override global tracing configuration >s|Category | Troubleshooting >s|First Omni Gateway version available | 1.10.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/tracing-release-notes.adoc[Tracing] ^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc index 36ff54949..6c1fa6741 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc @@ -10,6 +10,7 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services >s|Summary | Manages API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/traffic-management-route-release-notes.adoc[Traffic Management for Multiple Upstream Services] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc index aeb7242bc..2df200c26 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc @@ -10,6 +10,7 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services (Weighted) >s|Summary | Manages weighted API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.5.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/traffic-management-release-notes.adoc[Traffic Management for Multiple Upstream Services (Weighted)] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc index 5eb569220..851e50d18 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc @@ -11,6 +11,7 @@ endif::[] >s| Summary | Limits the number of simultaneous WebSocket connections that each API instance allows >s| Category | Quality of Service >s| First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/websocket-connection-limit-release-notes.adoc[WebSocket Connection Limit] .1+>.^s| Returned status codes | 429 - `Too many WebSocket connections` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc index 996ac0b42..84e8c5d23 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary| Protects against malicious XML in API requests >s|Category| Security >s|First Omni Gateway version available |v1.10.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/xml-threat-protection-release-notes.adoc[XML Threat Protection Policy] >s|Returned Status Codes|400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc index 5242877a6..ac790577e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Injects an API key or client credentials headers into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.10.2 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-api-key-release-notes.adoc[Credential Injection API Key] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc index e6026a5c4..70b7dea30 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc @@ -6,6 +6,7 @@ >s| Summary | Triggers an AWS Lambda function from a standard HTTP request >s| Category | Transformation >s| First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-aws-lambda-release-notes.adoc[AWS Lambda] .4+>.^s| Returned Status Codes |502 - Bad Gateway, requests are blocked due to circuit breaker activation |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc index 61d53f239..c108c233c 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Signs outgoing requests with AWS Signature Version 4 (SigV4) or Signature Version 4A (SigV4A) >s|Category | Security >s|First Omni Gateway version available | v1.11.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-aws-signature-release-notes.adoc[AWS Request Signature] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc index f214f20eb..4d91811c0 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Injects a basic authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-basic-auth-release-notes.adoc[Credential Injection Basic Authentication] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc index 17d9443d3..e2fa049df 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc @@ -6,6 +6,7 @@ >s| Summary | Prevents an upstream from receiving too many requests or connections >s| Category | Quality of Service >s| First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-circuit-breaker-release-notes.adoc[Circuit Breaker] .4+>.^s| Returned Status Codes |503 - Service Unavailable |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc index 47875e5eb..b306cc489 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Generates and injects a JWT token into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.12.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-jwt-generation-release-notes.adoc[Credential Injection JWT Generation] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc index ed93c6729..659586e85 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Logs custom messages from outbound requests sent to upstream services, responses from upstream services, or information from other outbound policies applied to the same upstream service >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.11.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-message-logging-release-notes.adoc[Outbound Message Logging] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc index 9ae74095a..4e01a4f23 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Exchanges incoming bearer tokens using OAuth 2.0 Token Exchange (RFC 8693), Microsoft Entra ID On-Behalf-Of, or OAuth 2.0 Token Exchange with CIBA >s|Category | Security >s|First Omni Gateway version available | v1.11.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-oauth-obo-release-notes.adoc[OAuth 2.0 OBO Credential Injection] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc index 49500b147..0ae21bdf9 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Injects an OAuth 2.0 authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-oauth-release-notes.adoc[Credential Injection OAuth 2.0] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc index a27ce1a10..33c7f3fe5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Sets the maximum idle duration for a stream between the Omni Gateway and an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-upstream-idle-timeout-release-notes.adoc[Stream Idle Timeout] ^s| Returned Status Codes | 504 - Upstream request timeout |=== diff --git a/omni-policies-list.txt b/omni-policies-list.txt new file mode 100644 index 000000000..8f3d10432 --- /dev/null +++ b/omni-policies-list.txt @@ -0,0 +1,52 @@ +policies-included-azure-content-safety Azure Content Safety Policy +policies-included-basic-auth-ldap Basic Authentication: LDAP +policies-included-basic-auth-simple Basic Authentication: Simple +policies-included-bedrock-guardrails Amazon Bedrock Guardrails Policy +policies-included-client-id-enforcement Client ID Enforcement +policies-included-cors Cross-Origin Resource Sharing (CORS) +policies-included-dataweave-body-transformation DataWeave Body Transformation +policies-included-dataweave-headers-transformation DataWeave Headers Transformation +policies-included-dataweave-request-filter DataWeave Request Filter +policies-included-external-authorization External Authorization Policy +policies-included-external-processing External Processing +policies-included-graphql-introspection-control GraphQL Introspection Control +policies-included-graphql-operation-limits GraphQL Operation Limits +policies-included-graphql-schema-validation GraphQL Schema Validation +policies-included-graphql-static-query-complexity GraphQL Static Query Complexity +policies-included-header-injection Header Injection Policy +policies-included-header-removal Header Removal +policies-included-health-check Health Check Policy +policies-included-http-caching HTTP caching +policies-included-injection-protection Injection Protection Policy +policies-included-ip-allowlist IP Allowlist +policies-included-ip-blocklist IP Blocklist +policies-included-json-threat-protection JSON Threat Protection Policy +policies-included-jwt-validation JWT Validation +policies-included-message-logging Message Logging +policies-included-oauth-protected-resource-metadata OAuth 2.0 Protected Resource Metadata +policies-included-oauth-token-introspection OAuth 2.0 Token Introspection Policy +policies-included-openid-token-enforcement OpenID Connect OAuth 2.0 Token Enforcement +policies-included-rate-limiting-sla Rate-limiting SLA +policies-included-rate-limiting Rate Limiting +policies-included-response-timeout Response Timeout +policies-included-schema-validation Schema Validation Policy +policies-included-soap-schema-validation SOAP Schema Validation Policy +policies-included-spike-control Spike Control +policies-included-stream-idle-timeout Stream Idle Timeout +policies-included-tls-outbound Transport Layer Security (TLS) - Outbound +policies-included-tls Transport Layer Security (TLS) - Inbound +policies-included-tracing Tracing +policies-included-traffic-management-route Traffic Management for Multiple Upstream Services +policies-included-traffic-management Traffic Management for Multiple Upstream Services (Weighted) +policies-included-websocket-connection-limit WebSocket Connection Limit +policies-included-xml-threat-protection XML Threat Protection Policy +policies-outbound-api-key Credential Injection API Key +policies-outbound-aws-lambda AWS Lambda +policies-outbound-aws-signature AWS Request Signature +policies-outbound-basic-auth Credential Injection Basic Authentication +policies-outbound-circuit-breaker Circuit Breaker +policies-outbound-jwt-generation Credential Injection JWT Generation +policies-outbound-message-logging Outbound Message Logging +policies-outbound-oauth-obo OAuth 2.0 OBO Credential Injection +policies-outbound-oauth Credential Injection OAuth 2.0 +policies-outbound-upstream-idle-timeout Stream Idle Timeout From d2dce952b467a2b4f17e97e7e18925280b459ac6 Mon Sep 17 00:00:00 2001 From: Glenn Date: Fri, 26 Jun 2026 10:26:14 -0400 Subject: [PATCH 2/6] Update xrefs to point to consolidated flex-gateway policy release notes Removed omni-gateway-policies subdirectory path from all xrefs. All policy release notes now reference flex-gateway/ directly. Co-Authored-By: Claude Sonnet 4.5 --- .../ROOT/pages/policies-included-azure-content-safety.adoc | 2 +- .../modules/ROOT/pages/policies-included-basic-auth-ldap.adoc | 2 +- .../modules/ROOT/pages/policies-included-basic-auth-simple.adoc | 2 +- .../ROOT/pages/policies-included-bedrock-guardrails.adoc | 2 +- .../ROOT/pages/policies-included-client-id-enforcement.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc | 2 +- .../pages/policies-included-dataweave-body-transformation.adoc | 2 +- .../policies-included-dataweave-headers-transformation.adoc | 2 +- .../ROOT/pages/policies-included-dataweave-request-filter.adoc | 2 +- .../ROOT/pages/policies-included-external-authorization.adoc | 2 +- .../ROOT/pages/policies-included-external-processing.adoc | 2 +- .../pages/policies-included-graphql-introspection-control.adoc | 2 +- .../ROOT/pages/policies-included-graphql-operation-limits.adoc | 2 +- .../ROOT/pages/policies-included-graphql-schema-validation.adoc | 2 +- .../policies-included-graphql-static-query-complexity.adoc | 2 +- .../modules/ROOT/pages/policies-included-header-injection.adoc | 2 +- .../modules/ROOT/pages/policies-included-header-removal.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-health-check.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-http-caching.adoc | 2 +- .../ROOT/pages/policies-included-injection-protection.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc | 2 +- .../ROOT/pages/policies-included-json-threat-protection.adoc | 2 +- .../modules/ROOT/pages/policies-included-jwt-validation.adoc | 2 +- .../modules/ROOT/pages/policies-included-message-logging.adoc | 2 +- .../policies-included-oauth-protected-resource-metadata.adoc | 2 +- .../ROOT/pages/policies-included-oauth-token-introspection.adoc | 2 +- .../ROOT/pages/policies-included-openid-token-enforcement.adoc | 2 +- .../modules/ROOT/pages/policies-included-rate-limiting-sla.adoc | 2 +- .../modules/ROOT/pages/policies-included-rate-limiting.adoc | 2 +- .../modules/ROOT/pages/policies-included-response-timeout.adoc | 2 +- .../modules/ROOT/pages/policies-included-schema-validation.adoc | 2 +- .../ROOT/pages/policies-included-soap-schema-validation.adoc | 2 +- .../modules/ROOT/pages/policies-included-spike-control.adoc | 2 +- .../ROOT/pages/policies-included-stream-idle-timeout.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc | 2 +- .../ROOT/pages/policies-included-traffic-management-route.adoc | 2 +- .../ROOT/pages/policies-included-traffic-management.adoc | 2 +- .../pages/policies-included-websocket-connection-limit.adoc | 2 +- .../ROOT/pages/policies-included-xml-threat-protection.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-aws-signature.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-circuit-breaker.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-jwt-generation.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-message-logging.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc | 2 +- .../ROOT/pages/policies-outbound-upstream-idle-timeout.adoc | 2 +- 52 files changed, 52 insertions(+), 52 deletions(-) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc index c4889d6ee..5e14f2133 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Azure AI Content Safety for harmful content, jailbreak attempts, hallucinations, and copyrighted material >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/azure-content-safety-release-notes.adoc[Azure Content Safety Policy] +>s|Release Notes| xref:release-notes::flex-gateway/azure-content-safety-release-notes.adoc[Azure Content Safety Policy] .>s| Returned Status Codes |403 - Forbidden: Content violates Azure Content Safety policies |503 - Service Unavailable: Azure API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc index 32be9e709..e8787531d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with user-password defined on LDAP >s|Category | Security >s|First Omni Gateway version available | v1.1.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/basic-auth-ldap-release-notes.adoc[Basic Authentication: LDAP] +>s|Release Notes| xref:release-notes::flex-gateway/basic-auth-ldap-release-notes.adoc[Basic Authentication: LDAP] .1+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc index f37963665..83603fa6b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with a single user-password >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/basic-auth-simple-release-notes.adoc[Basic Authentication: Simple] +>s|Release Notes| xref:release-notes::flex-gateway/basic-auth-simple-release-notes.adoc[Basic Authentication: Simple] .1+>.^s| Returned Status Codes |400 - Unauthorized or invalid client application credentials in WSDL API using SOAP 1.2 | | 401 - Unauthorized or invalid client application credentials in HTTP or RAML APIs diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc index ff23f76d3..b982a37d5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Amazon Bedrock guardrails for content safety, PII detection, and contextual grounding >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/bedrock-guardrails-release-notes.adoc[Amazon Bedrock Guardrails Policy] +>s|Release Notes| xref:release-notes::flex-gateway/bedrock-guardrails-release-notes.adoc[Amazon Bedrock Guardrails Policy] .>s| Returned Status Codes |403 - Forbidden: Content violates guardrail policies |503 - Service Unavailable: Bedrock API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc index ea07fa773..6c8ec854c 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Compliance >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/client-id-enforcement-release-notes.adoc[Client ID Enforcement] +>s|Release Notes| xref:release-notes::flex-gateway/client-id-enforcement-release-notes.adoc[Client ID Enforcement] .4+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |500 - Bad response from authorization server, or WSDL SOAP Fault error diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc index 82e024f0a..485f20b99 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Enables access to resources residing in external domains >s| Category | Compliance >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/cors-release-notes.adoc[Cross-Origin Resource Sharing (CORS)] +>s|Release Notes| xref:release-notes::flex-gateway/cors-release-notes.adoc[Cross-Origin Resource Sharing (CORS)] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc index 7d3f96b3a..0da4c6f66 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Transforms the body of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/dataweave-body-transformation-release-notes.adoc[DataWeave Body Transformation] +>s|Release Notes| xref:release-notes::flex-gateway/dataweave-body-transformation-release-notes.adoc[DataWeave Body Transformation] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc index bd08d30b9..150e04424 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Transforms headers of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/dataweave-headers-transformation-release-notes.adoc[DataWeave Headers Transformation] +>s|Release Notes| xref:release-notes::flex-gateway/dataweave-headers-transformation-release-notes.adoc[DataWeave Headers Transformation] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc index 2a3b7e506..7df7936c1 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Filters requests by using a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | 1.12 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/dataweave-request-filter-release-notes.adoc[DataWeave Request Filter] +>s|Release Notes| xref:release-notes::flex-gateway/dataweave-request-filter-release-notes.adoc[DataWeave Request Filter] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc index b6fd6b1e5..fb0c8f21f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Authenticates requests with an external gRPC or HTTP authorization service >s|Category | Security >s| First Omni Gateway version available | v1.6.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/external-authorization-release-notes.adoc[External Authorization Policy] +>s|Release Notes| xref:release-notes::flex-gateway/external-authorization-release-notes.adoc[External Authorization Policy] >s| Returned Status Codes | 403 - Forbidden, invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc index e93f0cf45..ecf9af6bf 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Sends the incoming HTTP requests or outgoing HTTP responses requests to an external gRPC service for additional processing >s|Category | Transformation >s|First Omni Gateway version available | v1.6.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/external-processing-release-notes.adoc[External Processing] +>s|Release Notes| xref:release-notes::flex-gateway/external-processing-release-notes.adoc[External Processing] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc index 05e4593cd..c3e6bf5a2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Blocks or allows requests that access the `__schema`, `__type`, and `__typename` GraphQL meta fields >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/graphql-introspection-control-release-notes.adoc[GraphQL Introspection Control] +>s|Release Notes| xref:release-notes::flex-gateway/graphql-introspection-control-release-notes.adoc[GraphQL Introspection Control] .1+>.^s| Returned status codes | 403 Forbidden — The response follows the standard GraphQL error format, including a message such as `Introspection field '__schema' is not allowed`. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc index ea6d7ffc4..853fa1199 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Limits GraphQL operation depth, aliases, root fields, and directives >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/graphql-operation-limits-release-notes.adoc[GraphQL Operation Limits] +>s|Release Notes| xref:release-notes::flex-gateway/graphql-operation-limits-release-notes.adoc[GraphQL Operation Limits] .1+>.^s| Returned status codes | 400 - Operations that exceed a configured limit. The response follows the standard GraphQL error format and lists each violation. For example, `Query depth of 7 exceeds the maximum allowed depth of 5` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc index 98543d9d2..61ea8396e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Validates incoming GraphQL operations against a GraphQL schema definition >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/graphql-schema-validation-release-notes.adoc[GraphQL Schema Validation] +>s|Release Notes| xref:release-notes::flex-gateway/graphql-schema-validation-release-notes.adoc[GraphQL Schema Validation] .1+>.^s| Returned status codes | 400 - The operation doesn't satisfy the schema. When *Block request* is enabled, the JSON response includes GraphQL-style `errors` with a validation message. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc index ef61f50e4..5bbc5f7e5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Calculates query complexity and blocks requests that exceed the defined budget >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/graphql-static-query-complexity-release-notes.adoc[GraphQL Static Query Complexity] +>s|Release Notes| xref:release-notes::flex-gateway/graphql-static-query-complexity-release-notes.adoc[GraphQL Static Query Complexity] .1+>.^s| Returned status codes | 400 - Parse failures always trigger a 400 response. Complexity and list violations return this code only if *Block request* is enabled. The response includes a standard GraphQL errors object. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc index 3fbece395..3580534e1 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Adds headers to a request or response. >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/header-injection-release-notes.adoc[Header Injection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/header-injection-release-notes.adoc[Header Injection Policy] >s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc index 91af4a6be..17124af2d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Removes headers from a request or a response >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/header-removal-release-notes.adoc[Header Removal] +>s|Release Notes| xref:release-notes::flex-gateway/header-removal-release-notes.adoc[Header Removal] .1+>.^s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc index ac289bb72..b4fc4faa2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Monitors API upstream health at specific intervals >s|Category | Quality of Service >s| First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/health-check-release-notes.adoc[Health Check Policy] +>s|Release Notes| xref:release-notes::flex-gateway/health-check-release-notes.adoc[Health Check Policy] .1+>.^s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc index bb3d5c42d..70afc1034 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Caches HTTP responses from an API implementation >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/http-caching-release-notes.adoc[HTTP caching] +>s|Release Notes| xref:release-notes::flex-gateway/http-caching-release-notes.adoc[HTTP caching] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc index 76c724263..cf45a64ca 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary| Scans incoming requests to protect against SQL, XSS, and custom injection attacks >s|Category| Security >s|First Omni Gateway version available |v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/injection-protection-release-notes.adoc[Injection Protection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/injection-protection-release-notes.adoc[Injection Protection Policy] >s|Returned Status Codes|`400` - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc index bc4b3b09b..f5fd71fb4 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows a list or range of specified IP addresses to request access >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/ip-allowlist-release-notes.adoc[IP Allowlist] +>s|Release Notes| xref:release-notes::flex-gateway/ip-allowlist-release-notes.adoc[IP Allowlist] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc index feb4ed429..4affb90d3 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Blocks a single IP address or a range of IP addresses from accessing an API endpoint >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/ip-blocklist-release-notes.adoc[IP Blocklist] +>s|Release Notes| xref:release-notes::flex-gateway/ip-blocklist-release-notes.adoc[IP Blocklist] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc index 942a00576..c74bdae09 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary| Protects against malicious JSON in API requests >s|Category| Security >s|First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/json-threat-protection-release-notes.adoc[JSON Threat Protection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/json-threat-protection-release-notes.adoc[JSON Threat Protection Policy] >s|Returned Status Codes| 400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc index ca1e65d68..013d05e32 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Validates a JWT >s| Category | Security >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/jwt-validation-release-notes.adoc[JWT Validation] +>s|Release Notes| xref:release-notes::flex-gateway/jwt-validation-release-notes.adoc[JWT Validation] .4+>.^s| Returned Status Codes | |400 - Token was not provided in the request. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc index 9d4a4e08f..aefcc1986 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Logs custom messages using information from incoming requests, responses from the backend, or information from other policies applied to the same API endpoint >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/message-logging-release-notes.adoc[Message Logging] +>s|Release Notes| xref:release-notes::flex-gateway/message-logging-release-notes.adoc[Message Logging] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc index 93b62733a..bf55559b3 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Serves OAuth 2.0 Protected Resource Metadata at the well-known endpoint >s|Category | Security >s|First Omni Gateway version available | v1.9.3 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/oauth-protected-resource-metadata-release-notes.adoc[OAuth 2.0 Protected Resource Metadata] +>s|Release Notes| xref:release-notes::flex-gateway/oauth-protected-resource-metadata-release-notes.adoc[OAuth 2.0 Protected Resource Metadata] .2+>.^s| Returned Status Codes |404 - Request path does not match the well-known endpoint |405 - HTTP method is not GET diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc index 6f6eb0593..a6d2d2233 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.3.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/oauth-token-introspection-release-notes.adoc[OAuth 2.0 Token Introspection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/oauth-token-introspection-release-notes.adoc[OAuth 2.0 Token Introspection Policy] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc index d5f9a9ae2..71d82e735 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/openid-token-enforcement-release-notes.adoc[OpenID Connect OAuth 2.0 Token Enforcement] +>s|Release Notes| xref:release-notes::flex-gateway/openid-token-enforcement-release-notes.adoc[OpenID Connect OAuth 2.0 Token Enforcement] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc index 81c19628a..b36b3f6c8 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a timespan, based on SLAs >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/rate-limiting-sla-release-notes.adoc[Rate-limiting SLA] +>s|Release Notes| xref:release-notes::flex-gateway/rate-limiting-sla-release-notes.adoc[Rate-limiting SLA] .4+>.^s| Returned Status Codes |401 - Request blocked due to invalid client credentials (client ID or client secret) provided |429 - Quota exceeded; requests blocked until the current window finishes diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc index deaee5585..4c8f10a7f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a period of time >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/rate-limiting-release-notes.adoc[Rate Limiting] +>s|Release Notes| xref:release-notes::flex-gateway/rate-limiting-release-notes.adoc[Rate Limiting] .4+>.^s| Returned Status Codes |429 - Quota exceeded, requests are blocked until the current window finishes |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc index 7596d0788..8cb1a7bcd 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Sets the maximum duration that Omni Gateway waits for a response from an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/response-timeout-release-notes.adoc[Response Timeout] +>s|Release Notes| xref:release-notes::flex-gateway/response-timeout-release-notes.adoc[Response Timeout] ^s| Returned Status Codes | 504 - Upstream request timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc index ab81a22d7..0217e6385 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary| Validates incoming traffic against a supplied API schema >s|Category| Security >s|First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/schema-validation-release-notes.adoc[Schema Validation Policy] +>s|Release Notes| xref:release-notes::flex-gateway/schema-validation-release-notes.adoc[Schema Validation Policy] >s|Returned Status Codes| 400 - The request properties do not comply with the API specifications. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc index 74d2250b7..9af550849 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary| Validates incoming traffic against a specified WSDL schema >s|Category| Security >s|First Omni Gateway version available |v1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/soap-schema-validation-release-notes.adoc[SOAP Schema Validation Policy] +>s|Release Notes| xref:release-notes::flex-gateway/soap-schema-validation-release-notes.adoc[SOAP Schema Validation Policy] >.^s| Returned Status Codes | The policy returns a `400` for a client error or `500` for a server error. Error messages are defined by SOAP standard responses. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc index 5fb331ece..65f9cd2db 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Regulates API traffic >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/spike-control-release-notes.adoc[Spike Control] +>s|Release Notes| xref:release-notes::flex-gateway/spike-control-release-notes.adoc[Spike Control] .4+>.^s| Returned Status Codes | [%autowidth.spread,cols="a,a"] | 429 - The number of requests by HTTP APIs exceeded the configured limit. Request rejected after specified number of reattempts. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc index f82173739..2def66318 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Sets the maximum duration a stream can remain idle without receiving a request or response >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/stream-idle-timeout-release-notes.adoc[Stream Idle Timeout] +>s|Release Notes| xref:release-notes::flex-gateway/stream-idle-timeout-release-notes.adoc[Stream Idle Timeout] ^s| Returned Status Codes | 504 - Stream timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc index 110359482..78303ba09 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Enables two-way authentication between the API proxy and an upstream service >s|Category | Security >s| First Omni version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/tls-outbound-release-notes.adoc[Transport Layer Security (TLS) - Outbound] +>s|Release Notes| xref:release-notes::flex-gateway/tls-outbound-release-notes.adoc[Transport Layer Security (TLS) - Outbound] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc index cc0f7c021..c60330b95 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Enables authentication between a client and the API proxy >s|Category | Security >s| First Omni Gateway version available | v1.0.0 (inbound mTLS: v1.3.0) ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/tls-release-notes.adoc[Transport Layer Security (TLS) - Inbound] +>s|Release Notes| xref:release-notes::flex-gateway/tls-release-notes.adoc[Transport Layer Security (TLS) - Inbound] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc index 15953de2d..53ac319b7 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Override global tracing configuration >s|Category | Troubleshooting >s|First Omni Gateway version available | 1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/tracing-release-notes.adoc[Tracing] +>s|Release Notes| xref:release-notes::flex-gateway/tracing-release-notes.adoc[Tracing] ^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc index 6c1fa6741..f6b485a3f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc @@ -10,7 +10,7 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services >s|Summary | Manages API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/traffic-management-route-release-notes.adoc[Traffic Management for Multiple Upstream Services] +>s|Release Notes| xref:release-notes::flex-gateway/traffic-management-route-release-notes.adoc[Traffic Management for Multiple Upstream Services] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc index 2df200c26..7f9b6611b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc @@ -10,7 +10,7 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services (Weighted) >s|Summary | Manages weighted API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.5.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/traffic-management-release-notes.adoc[Traffic Management for Multiple Upstream Services (Weighted)] +>s|Release Notes| xref:release-notes::flex-gateway/traffic-management-release-notes.adoc[Traffic Management for Multiple Upstream Services (Weighted)] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc index 851e50d18..8ab259647 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Limits the number of simultaneous WebSocket connections that each API instance allows >s| Category | Quality of Service >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/websocket-connection-limit-release-notes.adoc[WebSocket Connection Limit] +>s|Release Notes| xref:release-notes::flex-gateway/websocket-connection-limit-release-notes.adoc[WebSocket Connection Limit] .1+>.^s| Returned status codes | 429 - `Too many WebSocket connections` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc index 84e8c5d23..f4e7c07ed 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary| Protects against malicious XML in API requests >s|Category| Security >s|First Omni Gateway version available |v1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/xml-threat-protection-release-notes.adoc[XML Threat Protection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/xml-threat-protection-release-notes.adoc[XML Threat Protection Policy] >s|Returned Status Codes|400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc index ac790577e..7d4bcf23e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Injects an API key or client credentials headers into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.10.2 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-api-key-release-notes.adoc[Credential Injection API Key] +>s|Release Notes| xref:release-notes::flex-gateway/outbound-api-key-release-notes.adoc[Credential Injection API Key] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc index 70b7dea30..e325e9a22 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc @@ -6,7 +6,7 @@ >s| Summary | Triggers an AWS Lambda function from a standard HTTP request >s| Category | Transformation >s| First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-aws-lambda-release-notes.adoc[AWS Lambda] +>s|Release Notes| xref:release-notes::flex-gateway/outbound-aws-lambda-release-notes.adoc[AWS Lambda] .4+>.^s| Returned Status Codes |502 - Bad Gateway, requests are blocked due to circuit breaker activation |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc index c108c233c..87b4da0b0 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Signs outgoing requests with AWS Signature Version 4 (SigV4) or Signature Version 4A (SigV4A) >s|Category | Security >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-aws-signature-release-notes.adoc[AWS Request Signature] +>s|Release Notes| xref:release-notes::flex-gateway/outbound-aws-signature-release-notes.adoc[AWS Request Signature] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc index 4d91811c0..c52343179 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Injects a basic authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-basic-auth-release-notes.adoc[Credential Injection Basic Authentication] +>s|Release Notes| xref:release-notes::flex-gateway/outbound-basic-auth-release-notes.adoc[Credential Injection Basic Authentication] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc index e2fa049df..7cd099500 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc @@ -6,7 +6,7 @@ >s| Summary | Prevents an upstream from receiving too many requests or connections >s| Category | Quality of Service >s| First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-circuit-breaker-release-notes.adoc[Circuit Breaker] +>s|Release Notes| xref:release-notes::flex-gateway/outbound-circuit-breaker-release-notes.adoc[Circuit Breaker] .4+>.^s| Returned Status Codes |503 - Service Unavailable |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc index b306cc489..a7a14bf4a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Generates and injects a JWT token into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-jwt-generation-release-notes.adoc[Credential Injection JWT Generation] +>s|Release Notes| xref:release-notes::flex-gateway/outbound-jwt-generation-release-notes.adoc[Credential Injection JWT Generation] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc index 659586e85..45ea74098 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Logs custom messages from outbound requests sent to upstream services, responses from upstream services, or information from other outbound policies applied to the same upstream service >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-message-logging-release-notes.adoc[Outbound Message Logging] +>s|Release Notes| xref:release-notes::flex-gateway/outbound-message-logging-release-notes.adoc[Outbound Message Logging] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc index 4e01a4f23..453e15ba7 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Exchanges incoming bearer tokens using OAuth 2.0 Token Exchange (RFC 8693), Microsoft Entra ID On-Behalf-Of, or OAuth 2.0 Token Exchange with CIBA >s|Category | Security >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-oauth-obo-release-notes.adoc[OAuth 2.0 OBO Credential Injection] +>s|Release Notes| xref:release-notes::flex-gateway/outbound-oauth-obo-release-notes.adoc[OAuth 2.0 OBO Credential Injection] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc index 0ae21bdf9..72291ea0a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Injects an OAuth 2.0 authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-oauth-release-notes.adoc[Credential Injection OAuth 2.0] +>s|Release Notes| xref:release-notes::flex-gateway/outbound-oauth-release-notes.adoc[Credential Injection OAuth 2.0] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc index 33c7f3fe5..5a2c0a791 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Sets the maximum idle duration for a stream between the Omni Gateway and an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/omni-gateway-policies/outbound-upstream-idle-timeout-release-notes.adoc[Stream Idle Timeout] +>s|Release Notes| xref:release-notes::flex-gateway/outbound-upstream-idle-timeout-release-notes.adoc[Stream Idle Timeout] ^s| Returned Status Codes | 504 - Upstream request timeout |=== From b005c6331441e888e7cca3a5f5c9380d9728c358 Mon Sep 17 00:00:00 2001 From: Glenn Date: Fri, 26 Jun 2026 10:28:46 -0400 Subject: [PATCH 3/6] Move policy release notes xrefs to flex-gateway/policies/ subfolder Updated all 52 policy xrefs to point to flex-gateway/policies/ instead of flex-gateway/ directly. Co-Authored-By: Claude Sonnet 4.5 --- .../ROOT/pages/policies-included-azure-content-safety.adoc | 2 +- .../modules/ROOT/pages/policies-included-basic-auth-ldap.adoc | 2 +- .../modules/ROOT/pages/policies-included-basic-auth-simple.adoc | 2 +- .../ROOT/pages/policies-included-bedrock-guardrails.adoc | 2 +- .../ROOT/pages/policies-included-client-id-enforcement.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc | 2 +- .../pages/policies-included-dataweave-body-transformation.adoc | 2 +- .../policies-included-dataweave-headers-transformation.adoc | 2 +- .../ROOT/pages/policies-included-dataweave-request-filter.adoc | 2 +- .../ROOT/pages/policies-included-external-authorization.adoc | 2 +- .../ROOT/pages/policies-included-external-processing.adoc | 2 +- .../pages/policies-included-graphql-introspection-control.adoc | 2 +- .../ROOT/pages/policies-included-graphql-operation-limits.adoc | 2 +- .../ROOT/pages/policies-included-graphql-schema-validation.adoc | 2 +- .../policies-included-graphql-static-query-complexity.adoc | 2 +- .../modules/ROOT/pages/policies-included-header-injection.adoc | 2 +- .../modules/ROOT/pages/policies-included-header-removal.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-health-check.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-http-caching.adoc | 2 +- .../ROOT/pages/policies-included-injection-protection.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc | 2 +- .../ROOT/pages/policies-included-json-threat-protection.adoc | 2 +- .../modules/ROOT/pages/policies-included-jwt-validation.adoc | 2 +- .../modules/ROOT/pages/policies-included-message-logging.adoc | 2 +- .../policies-included-oauth-protected-resource-metadata.adoc | 2 +- .../ROOT/pages/policies-included-oauth-token-introspection.adoc | 2 +- .../ROOT/pages/policies-included-openid-token-enforcement.adoc | 2 +- .../modules/ROOT/pages/policies-included-rate-limiting-sla.adoc | 2 +- .../modules/ROOT/pages/policies-included-rate-limiting.adoc | 2 +- .../modules/ROOT/pages/policies-included-response-timeout.adoc | 2 +- .../modules/ROOT/pages/policies-included-schema-validation.adoc | 2 +- .../ROOT/pages/policies-included-soap-schema-validation.adoc | 2 +- .../modules/ROOT/pages/policies-included-spike-control.adoc | 2 +- .../ROOT/pages/policies-included-stream-idle-timeout.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc | 2 +- .../ROOT/pages/policies-included-traffic-management-route.adoc | 2 +- .../ROOT/pages/policies-included-traffic-management.adoc | 2 +- .../pages/policies-included-websocket-connection-limit.adoc | 2 +- .../ROOT/pages/policies-included-xml-threat-protection.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-aws-signature.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-circuit-breaker.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-jwt-generation.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-message-logging.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc | 2 +- .../ROOT/pages/policies-outbound-upstream-idle-timeout.adoc | 2 +- 52 files changed, 52 insertions(+), 52 deletions(-) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc index 5e14f2133..0b3f2fe66 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Azure AI Content Safety for harmful content, jailbreak attempts, hallucinations, and copyrighted material >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/azure-content-safety-release-notes.adoc[Azure Content Safety Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/azure-content-safety-release-notes.adoc[Azure Content Safety Policy] .>s| Returned Status Codes |403 - Forbidden: Content violates Azure Content Safety policies |503 - Service Unavailable: Azure API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc index e8787531d..5b4897b7a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with user-password defined on LDAP >s|Category | Security >s|First Omni Gateway version available | v1.1.0 ->s|Release Notes| xref:release-notes::flex-gateway/basic-auth-ldap-release-notes.adoc[Basic Authentication: LDAP] +>s|Release Notes| xref:release-notes::flex-gateway/policies/basic-auth-ldap-release-notes.adoc[Basic Authentication: LDAP] .1+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc index 83603fa6b..5a7a8af78 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with a single user-password >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/basic-auth-simple-release-notes.adoc[Basic Authentication: Simple] +>s|Release Notes| xref:release-notes::flex-gateway/policies/basic-auth-simple-release-notes.adoc[Basic Authentication: Simple] .1+>.^s| Returned Status Codes |400 - Unauthorized or invalid client application credentials in WSDL API using SOAP 1.2 | | 401 - Unauthorized or invalid client application credentials in HTTP or RAML APIs diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc index b982a37d5..875424c56 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Amazon Bedrock guardrails for content safety, PII detection, and contextual grounding >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/bedrock-guardrails-release-notes.adoc[Amazon Bedrock Guardrails Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/bedrock-guardrails-release-notes.adoc[Amazon Bedrock Guardrails Policy] .>s| Returned Status Codes |403 - Forbidden: Content violates guardrail policies |503 - Service Unavailable: Bedrock API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc index 6c8ec854c..9d37ebb05 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Compliance >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/client-id-enforcement-release-notes.adoc[Client ID Enforcement] +>s|Release Notes| xref:release-notes::flex-gateway/policies/client-id-enforcement-release-notes.adoc[Client ID Enforcement] .4+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |500 - Bad response from authorization server, or WSDL SOAP Fault error diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc index 485f20b99..aba5f5762 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Enables access to resources residing in external domains >s| Category | Compliance >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/cors-release-notes.adoc[Cross-Origin Resource Sharing (CORS)] +>s|Release Notes| xref:release-notes::flex-gateway/policies/cors-release-notes.adoc[Cross-Origin Resource Sharing (CORS)] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc index 0da4c6f66..a274e4b71 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Transforms the body of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/dataweave-body-transformation-release-notes.adoc[DataWeave Body Transformation] +>s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-body-transformation-release-notes.adoc[DataWeave Body Transformation] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc index 150e04424..e1fec6bc8 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Transforms headers of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/dataweave-headers-transformation-release-notes.adoc[DataWeave Headers Transformation] +>s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-headers-transformation-release-notes.adoc[DataWeave Headers Transformation] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc index 7df7936c1..1110426a3 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Filters requests by using a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | 1.12 ->s|Release Notes| xref:release-notes::flex-gateway/dataweave-request-filter-release-notes.adoc[DataWeave Request Filter] +>s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-request-filter-release-notes.adoc[DataWeave Request Filter] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc index fb0c8f21f..08798c8e2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Authenticates requests with an external gRPC or HTTP authorization service >s|Category | Security >s| First Omni Gateway version available | v1.6.0 ->s|Release Notes| xref:release-notes::flex-gateway/external-authorization-release-notes.adoc[External Authorization Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/external-authorization-release-notes.adoc[External Authorization Policy] >s| Returned Status Codes | 403 - Forbidden, invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc index ecf9af6bf..64559669b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Sends the incoming HTTP requests or outgoing HTTP responses requests to an external gRPC service for additional processing >s|Category | Transformation >s|First Omni Gateway version available | v1.6.0 ->s|Release Notes| xref:release-notes::flex-gateway/external-processing-release-notes.adoc[External Processing] +>s|Release Notes| xref:release-notes::flex-gateway/policies/external-processing-release-notes.adoc[External Processing] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc index c3e6bf5a2..01ac16ee0 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Blocks or allows requests that access the `__schema`, `__type`, and `__typename` GraphQL meta fields >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/graphql-introspection-control-release-notes.adoc[GraphQL Introspection Control] +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-introspection-control-release-notes.adoc[GraphQL Introspection Control] .1+>.^s| Returned status codes | 403 Forbidden — The response follows the standard GraphQL error format, including a message such as `Introspection field '__schema' is not allowed`. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc index 853fa1199..2070227e4 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Limits GraphQL operation depth, aliases, root fields, and directives >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/graphql-operation-limits-release-notes.adoc[GraphQL Operation Limits] +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-operation-limits-release-notes.adoc[GraphQL Operation Limits] .1+>.^s| Returned status codes | 400 - Operations that exceed a configured limit. The response follows the standard GraphQL error format and lists each violation. For example, `Query depth of 7 exceeds the maximum allowed depth of 5` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc index 61ea8396e..585fed4c2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Validates incoming GraphQL operations against a GraphQL schema definition >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/graphql-schema-validation-release-notes.adoc[GraphQL Schema Validation] +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-schema-validation-release-notes.adoc[GraphQL Schema Validation] .1+>.^s| Returned status codes | 400 - The operation doesn't satisfy the schema. When *Block request* is enabled, the JSON response includes GraphQL-style `errors` with a validation message. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc index 5bbc5f7e5..3a9553f9f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Calculates query complexity and blocks requests that exceed the defined budget >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/graphql-static-query-complexity-release-notes.adoc[GraphQL Static Query Complexity] +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-static-query-complexity-release-notes.adoc[GraphQL Static Query Complexity] .1+>.^s| Returned status codes | 400 - Parse failures always trigger a 400 response. Complexity and list violations return this code only if *Block request* is enabled. The response includes a standard GraphQL errors object. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc index 3580534e1..4902998dd 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Adds headers to a request or response. >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/header-injection-release-notes.adoc[Header Injection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/header-injection-release-notes.adoc[Header Injection Policy] >s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc index 17124af2d..f1e27f1bc 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Removes headers from a request or a response >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/header-removal-release-notes.adoc[Header Removal] +>s|Release Notes| xref:release-notes::flex-gateway/policies/header-removal-release-notes.adoc[Header Removal] .1+>.^s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc index b4fc4faa2..4729c9475 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Monitors API upstream health at specific intervals >s|Category | Quality of Service >s| First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/health-check-release-notes.adoc[Health Check Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/health-check-release-notes.adoc[Health Check Policy] .1+>.^s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc index 70afc1034..4312e1ae0 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Caches HTTP responses from an API implementation >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/http-caching-release-notes.adoc[HTTP caching] +>s|Release Notes| xref:release-notes::flex-gateway/policies/http-caching-release-notes.adoc[HTTP caching] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc index cf45a64ca..952bffac9 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary| Scans incoming requests to protect against SQL, XSS, and custom injection attacks >s|Category| Security >s|First Omni Gateway version available |v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/injection-protection-release-notes.adoc[Injection Protection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/injection-protection-release-notes.adoc[Injection Protection Policy] >s|Returned Status Codes|`400` - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc index f5fd71fb4..aa7ecfe3e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows a list or range of specified IP addresses to request access >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/ip-allowlist-release-notes.adoc[IP Allowlist] +>s|Release Notes| xref:release-notes::flex-gateway/policies/ip-allowlist-release-notes.adoc[IP Allowlist] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc index 4affb90d3..3221de817 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Blocks a single IP address or a range of IP addresses from accessing an API endpoint >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/ip-blocklist-release-notes.adoc[IP Blocklist] +>s|Release Notes| xref:release-notes::flex-gateway/policies/ip-blocklist-release-notes.adoc[IP Blocklist] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc index c74bdae09..46100b3ef 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary| Protects against malicious JSON in API requests >s|Category| Security >s|First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/json-threat-protection-release-notes.adoc[JSON Threat Protection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/json-threat-protection-release-notes.adoc[JSON Threat Protection Policy] >s|Returned Status Codes| 400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc index 013d05e32..d611f36d8 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Validates a JWT >s| Category | Security >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/jwt-validation-release-notes.adoc[JWT Validation] +>s|Release Notes| xref:release-notes::flex-gateway/policies/jwt-validation-release-notes.adoc[JWT Validation] .4+>.^s| Returned Status Codes | |400 - Token was not provided in the request. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc index aefcc1986..9a5b52252 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Logs custom messages using information from incoming requests, responses from the backend, or information from other policies applied to the same API endpoint >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/message-logging-release-notes.adoc[Message Logging] +>s|Release Notes| xref:release-notes::flex-gateway/policies/message-logging-release-notes.adoc[Message Logging] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc index bf55559b3..1a114dbec 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Serves OAuth 2.0 Protected Resource Metadata at the well-known endpoint >s|Category | Security >s|First Omni Gateway version available | v1.9.3 ->s|Release Notes| xref:release-notes::flex-gateway/oauth-protected-resource-metadata-release-notes.adoc[OAuth 2.0 Protected Resource Metadata] +>s|Release Notes| xref:release-notes::flex-gateway/policies/oauth-protected-resource-metadata-release-notes.adoc[OAuth 2.0 Protected Resource Metadata] .2+>.^s| Returned Status Codes |404 - Request path does not match the well-known endpoint |405 - HTTP method is not GET diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc index a6d2d2233..f7c935121 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.3.0 ->s|Release Notes| xref:release-notes::flex-gateway/oauth-token-introspection-release-notes.adoc[OAuth 2.0 Token Introspection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/oauth-token-introspection-release-notes.adoc[OAuth 2.0 Token Introspection Policy] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc index 71d82e735..14f4bac16 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/openid-token-enforcement-release-notes.adoc[OpenID Connect OAuth 2.0 Token Enforcement] +>s|Release Notes| xref:release-notes::flex-gateway/policies/openid-token-enforcement-release-notes.adoc[OpenID Connect OAuth 2.0 Token Enforcement] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc index b36b3f6c8..ae7f37415 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a timespan, based on SLAs >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 ->s|Release Notes| xref:release-notes::flex-gateway/rate-limiting-sla-release-notes.adoc[Rate-limiting SLA] +>s|Release Notes| xref:release-notes::flex-gateway/policies/rate-limiting-sla-release-notes.adoc[Rate-limiting SLA] .4+>.^s| Returned Status Codes |401 - Request blocked due to invalid client credentials (client ID or client secret) provided |429 - Quota exceeded; requests blocked until the current window finishes diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc index 4c8f10a7f..1246251de 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a period of time >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 ->s|Release Notes| xref:release-notes::flex-gateway/rate-limiting-release-notes.adoc[Rate Limiting] +>s|Release Notes| xref:release-notes::flex-gateway/policies/rate-limiting-release-notes.adoc[Rate Limiting] .4+>.^s| Returned Status Codes |429 - Quota exceeded, requests are blocked until the current window finishes |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc index 8cb1a7bcd..9fd4e534d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Sets the maximum duration that Omni Gateway waits for a response from an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/response-timeout-release-notes.adoc[Response Timeout] +>s|Release Notes| xref:release-notes::flex-gateway/policies/response-timeout-release-notes.adoc[Response Timeout] ^s| Returned Status Codes | 504 - Upstream request timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc index 0217e6385..8ba9b1f2f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary| Validates incoming traffic against a supplied API schema >s|Category| Security >s|First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/schema-validation-release-notes.adoc[Schema Validation Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/schema-validation-release-notes.adoc[Schema Validation Policy] >s|Returned Status Codes| 400 - The request properties do not comply with the API specifications. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc index 9af550849..abc448c6f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary| Validates incoming traffic against a specified WSDL schema >s|Category| Security >s|First Omni Gateway version available |v1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/soap-schema-validation-release-notes.adoc[SOAP Schema Validation Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/soap-schema-validation-release-notes.adoc[SOAP Schema Validation Policy] >.^s| Returned Status Codes | The policy returns a `400` for a client error or `500` for a server error. Error messages are defined by SOAP standard responses. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc index 65f9cd2db..2843494b5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Regulates API traffic >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/spike-control-release-notes.adoc[Spike Control] +>s|Release Notes| xref:release-notes::flex-gateway/policies/spike-control-release-notes.adoc[Spike Control] .4+>.^s| Returned Status Codes | [%autowidth.spread,cols="a,a"] | 429 - The number of requests by HTTP APIs exceeded the configured limit. Request rejected after specified number of reattempts. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc index 2def66318..159e31180 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Sets the maximum duration a stream can remain idle without receiving a request or response >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/stream-idle-timeout-release-notes.adoc[Stream Idle Timeout] +>s|Release Notes| xref:release-notes::flex-gateway/policies/stream-idle-timeout-release-notes.adoc[Stream Idle Timeout] ^s| Returned Status Codes | 504 - Stream timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc index 78303ba09..a1a4e0f7e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Enables two-way authentication between the API proxy and an upstream service >s|Category | Security >s| First Omni version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/tls-outbound-release-notes.adoc[Transport Layer Security (TLS) - Outbound] +>s|Release Notes| xref:release-notes::flex-gateway/policies/tls-outbound-release-notes.adoc[Transport Layer Security (TLS) - Outbound] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc index c60330b95..d70899748 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Enables authentication between a client and the API proxy >s|Category | Security >s| First Omni Gateway version available | v1.0.0 (inbound mTLS: v1.3.0) ->s|Release Notes| xref:release-notes::flex-gateway/tls-release-notes.adoc[Transport Layer Security (TLS) - Inbound] +>s|Release Notes| xref:release-notes::flex-gateway/policies/tls-release-notes.adoc[Transport Layer Security (TLS) - Inbound] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc index 53ac319b7..c80cfd98e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Override global tracing configuration >s|Category | Troubleshooting >s|First Omni Gateway version available | 1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/tracing-release-notes.adoc[Tracing] +>s|Release Notes| xref:release-notes::flex-gateway/policies/tracing-release-notes.adoc[Tracing] ^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc index f6b485a3f..fa9f9afc6 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc @@ -10,7 +10,7 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services >s|Summary | Manages API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/traffic-management-route-release-notes.adoc[Traffic Management for Multiple Upstream Services] +>s|Release Notes| xref:release-notes::flex-gateway/policies/traffic-management-route-release-notes.adoc[Traffic Management for Multiple Upstream Services] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc index 7f9b6611b..18e791377 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc @@ -10,7 +10,7 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services (Weighted) >s|Summary | Manages weighted API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.5.0 ->s|Release Notes| xref:release-notes::flex-gateway/traffic-management-release-notes.adoc[Traffic Management for Multiple Upstream Services (Weighted)] +>s|Release Notes| xref:release-notes::flex-gateway/policies/traffic-management-release-notes.adoc[Traffic Management for Multiple Upstream Services (Weighted)] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc index 8ab259647..1ab7ed720 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Limits the number of simultaneous WebSocket connections that each API instance allows >s| Category | Quality of Service >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/websocket-connection-limit-release-notes.adoc[WebSocket Connection Limit] +>s|Release Notes| xref:release-notes::flex-gateway/policies/websocket-connection-limit-release-notes.adoc[WebSocket Connection Limit] .1+>.^s| Returned status codes | 429 - `Too many WebSocket connections` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc index f4e7c07ed..a23463e1d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary| Protects against malicious XML in API requests >s|Category| Security >s|First Omni Gateway version available |v1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/xml-threat-protection-release-notes.adoc[XML Threat Protection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/xml-threat-protection-release-notes.adoc[XML Threat Protection Policy] >s|Returned Status Codes|400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc index 7d4bcf23e..b5bee7000 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Injects an API key or client credentials headers into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.10.2 ->s|Release Notes| xref:release-notes::flex-gateway/outbound-api-key-release-notes.adoc[Credential Injection API Key] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-api-key-release-notes.adoc[Credential Injection API Key] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc index e325e9a22..92cbe6507 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc @@ -6,7 +6,7 @@ >s| Summary | Triggers an AWS Lambda function from a standard HTTP request >s| Category | Transformation >s| First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/outbound-aws-lambda-release-notes.adoc[AWS Lambda] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-aws-lambda-release-notes.adoc[AWS Lambda] .4+>.^s| Returned Status Codes |502 - Bad Gateway, requests are blocked due to circuit breaker activation |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc index 87b4da0b0..2f154acbb 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Signs outgoing requests with AWS Signature Version 4 (SigV4) or Signature Version 4A (SigV4A) >s|Category | Security >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/outbound-aws-signature-release-notes.adoc[AWS Request Signature] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-aws-signature-release-notes.adoc[AWS Request Signature] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc index c52343179..ed51456a5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Injects a basic authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/outbound-basic-auth-release-notes.adoc[Credential Injection Basic Authentication] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-basic-auth-release-notes.adoc[Credential Injection Basic Authentication] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc index 7cd099500..bd76de61b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc @@ -6,7 +6,7 @@ >s| Summary | Prevents an upstream from receiving too many requests or connections >s| Category | Quality of Service >s| First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/outbound-circuit-breaker-release-notes.adoc[Circuit Breaker] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-circuit-breaker-release-notes.adoc[Circuit Breaker] .4+>.^s| Returned Status Codes |503 - Service Unavailable |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc index a7a14bf4a..20cd02bc8 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Generates and injects a JWT token into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/outbound-jwt-generation-release-notes.adoc[Credential Injection JWT Generation] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-jwt-generation-release-notes.adoc[Credential Injection JWT Generation] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc index 45ea74098..d4f54fec2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Logs custom messages from outbound requests sent to upstream services, responses from upstream services, or information from other outbound policies applied to the same upstream service >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/outbound-message-logging-release-notes.adoc[Outbound Message Logging] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-message-logging-release-notes.adoc[Outbound Message Logging] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc index 453e15ba7..ceddb907f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Exchanges incoming bearer tokens using OAuth 2.0 Token Exchange (RFC 8693), Microsoft Entra ID On-Behalf-Of, or OAuth 2.0 Token Exchange with CIBA >s|Category | Security >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/outbound-oauth-obo-release-notes.adoc[OAuth 2.0 OBO Credential Injection] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-oauth-obo-release-notes.adoc[OAuth 2.0 OBO Credential Injection] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc index 72291ea0a..4dd5b3f46 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Injects an OAuth 2.0 authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/outbound-oauth-release-notes.adoc[Credential Injection OAuth 2.0] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-oauth-release-notes.adoc[Credential Injection OAuth 2.0] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc index 5a2c0a791..f14b5bc3d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Sets the maximum idle duration for a stream between the Omni Gateway and an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/outbound-upstream-idle-timeout-release-notes.adoc[Stream Idle Timeout] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-upstream-idle-timeout-release-notes.adoc[Stream Idle Timeout] ^s| Returned Status Codes | 504 - Upstream request timeout |=== From 26c73ea4dbc9dc736239807bf6a6a71cc41d9c26 Mon Sep 17 00:00:00 2001 From: Glenn Date: Fri, 26 Jun 2026 11:00:39 -0400 Subject: [PATCH 4/6] Remove release notes xrefs from Omni Gateway policy pages Removed release notes xref lines from all 52 Omni Gateway policy files in 1.13. Only hybrid/agentic policies should have release notes links. Co-Authored-By: Claude Sonnet 4.5 --- .../ROOT/pages/policies-included-azure-content-safety.adoc | 1 - .../modules/ROOT/pages/policies-included-basic-auth-ldap.adoc | 1 - .../modules/ROOT/pages/policies-included-basic-auth-simple.adoc | 1 - .../modules/ROOT/pages/policies-included-bedrock-guardrails.adoc | 1 - .../ROOT/pages/policies-included-client-id-enforcement.adoc | 1 - gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc | 1 - .../pages/policies-included-dataweave-body-transformation.adoc | 1 - .../policies-included-dataweave-headers-transformation.adoc | 1 - .../ROOT/pages/policies-included-dataweave-request-filter.adoc | 1 - .../ROOT/pages/policies-included-external-authorization.adoc | 1 - .../ROOT/pages/policies-included-external-processing.adoc | 1 - .../pages/policies-included-graphql-introspection-control.adoc | 1 - .../ROOT/pages/policies-included-graphql-operation-limits.adoc | 1 - .../ROOT/pages/policies-included-graphql-schema-validation.adoc | 1 - .../pages/policies-included-graphql-static-query-complexity.adoc | 1 - .../modules/ROOT/pages/policies-included-header-injection.adoc | 1 - .../modules/ROOT/pages/policies-included-header-removal.adoc | 1 - .../1.13/modules/ROOT/pages/policies-included-health-check.adoc | 1 - .../1.13/modules/ROOT/pages/policies-included-http-caching.adoc | 1 - .../ROOT/pages/policies-included-injection-protection.adoc | 1 - .../1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc | 1 - .../1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc | 1 - .../ROOT/pages/policies-included-json-threat-protection.adoc | 1 - .../modules/ROOT/pages/policies-included-jwt-validation.adoc | 1 - .../modules/ROOT/pages/policies-included-message-logging.adoc | 1 - .../policies-included-oauth-protected-resource-metadata.adoc | 1 - .../ROOT/pages/policies-included-oauth-token-introspection.adoc | 1 - .../ROOT/pages/policies-included-openid-token-enforcement.adoc | 1 - .../modules/ROOT/pages/policies-included-rate-limiting-sla.adoc | 1 - .../1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc | 1 - .../modules/ROOT/pages/policies-included-response-timeout.adoc | 1 - .../modules/ROOT/pages/policies-included-schema-validation.adoc | 1 - .../ROOT/pages/policies-included-soap-schema-validation.adoc | 1 - .../1.13/modules/ROOT/pages/policies-included-spike-control.adoc | 1 - .../ROOT/pages/policies-included-stream-idle-timeout.adoc | 1 - .../1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc | 1 - gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc | 1 - gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc | 1 - .../ROOT/pages/policies-included-traffic-management-route.adoc | 1 - .../modules/ROOT/pages/policies-included-traffic-management.adoc | 1 - .../ROOT/pages/policies-included-websocket-connection-limit.adoc | 1 - .../ROOT/pages/policies-included-xml-threat-protection.adoc | 1 - gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc | 1 - .../1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc | 1 - .../1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc | 1 - .../1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc | 1 - .../modules/ROOT/pages/policies-outbound-circuit-breaker.adoc | 1 - .../modules/ROOT/pages/policies-outbound-jwt-generation.adoc | 1 - .../modules/ROOT/pages/policies-outbound-message-logging.adoc | 1 - gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc | 1 - gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc | 1 - .../ROOT/pages/policies-outbound-upstream-idle-timeout.adoc | 1 - 52 files changed, 52 deletions(-) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc index 0b3f2fe66..cd5c01286 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Azure AI Content Safety for harmful content, jailbreak attempts, hallucinations, and copyrighted material >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/azure-content-safety-release-notes.adoc[Azure Content Safety Policy] .>s| Returned Status Codes |403 - Forbidden: Content violates Azure Content Safety policies |503 - Service Unavailable: Azure API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc index 5b4897b7a..6dee81421 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with user-password defined on LDAP >s|Category | Security >s|First Omni Gateway version available | v1.1.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/basic-auth-ldap-release-notes.adoc[Basic Authentication: LDAP] .1+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc index 5a7a8af78..e15f5861e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with a single user-password >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/basic-auth-simple-release-notes.adoc[Basic Authentication: Simple] .1+>.^s| Returned Status Codes |400 - Unauthorized or invalid client application credentials in WSDL API using SOAP 1.2 | | 401 - Unauthorized or invalid client application credentials in HTTP or RAML APIs diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc index 875424c56..54167165d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Amazon Bedrock guardrails for content safety, PII detection, and contextual grounding >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/bedrock-guardrails-release-notes.adoc[Amazon Bedrock Guardrails Policy] .>s| Returned Status Codes |403 - Forbidden: Content violates guardrail policies |503 - Service Unavailable: Bedrock API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc index 9d37ebb05..654d09197 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Compliance >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/client-id-enforcement-release-notes.adoc[Client ID Enforcement] .4+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |500 - Bad response from authorization server, or WSDL SOAP Fault error diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc index aba5f5762..57c82d78e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc @@ -12,7 +12,6 @@ endif::[] >s| Summary | Enables access to resources residing in external domains >s| Category | Compliance >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/cors-release-notes.adoc[Cross-Origin Resource Sharing (CORS)] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc index a274e4b71..a15608e25 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Transforms the body of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-body-transformation-release-notes.adoc[DataWeave Body Transformation] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc index e1fec6bc8..4a9898060 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Transforms headers of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-headers-transformation-release-notes.adoc[DataWeave Headers Transformation] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc index 1110426a3..80da7642c 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Filters requests by using a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | 1.12 ->s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-request-filter-release-notes.adoc[DataWeave Request Filter] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc index 08798c8e2..b2098445c 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Authenticates requests with an external gRPC or HTTP authorization service >s|Category | Security >s| First Omni Gateway version available | v1.6.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/external-authorization-release-notes.adoc[External Authorization Policy] >s| Returned Status Codes | 403 - Forbidden, invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc index 64559669b..19e24f5f3 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Sends the incoming HTTP requests or outgoing HTTP responses requests to an external gRPC service for additional processing >s|Category | Transformation >s|First Omni Gateway version available | v1.6.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/external-processing-release-notes.adoc[External Processing] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc index 01ac16ee0..fbd3520c5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc @@ -11,7 +11,6 @@ endif::[] >s| Summary | Blocks or allows requests that access the `__schema`, `__type`, and `__typename` GraphQL meta fields >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-introspection-control-release-notes.adoc[GraphQL Introspection Control] .1+>.^s| Returned status codes | 403 Forbidden — The response follows the standard GraphQL error format, including a message such as `Introspection field '__schema' is not allowed`. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc index 2070227e4..833f69a1d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc @@ -11,7 +11,6 @@ endif::[] >s| Summary | Limits GraphQL operation depth, aliases, root fields, and directives >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-operation-limits-release-notes.adoc[GraphQL Operation Limits] .1+>.^s| Returned status codes | 400 - Operations that exceed a configured limit. The response follows the standard GraphQL error format and lists each violation. For example, `Query depth of 7 exceeds the maximum allowed depth of 5` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc index 585fed4c2..2489f2b7e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc @@ -11,7 +11,6 @@ endif::[] >s| Summary | Validates incoming GraphQL operations against a GraphQL schema definition >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-schema-validation-release-notes.adoc[GraphQL Schema Validation] .1+>.^s| Returned status codes | 400 - The operation doesn't satisfy the schema. When *Block request* is enabled, the JSON response includes GraphQL-style `errors` with a validation message. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc index 3a9553f9f..db6625865 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc @@ -11,7 +11,6 @@ endif::[] >s| Summary | Calculates query complexity and blocks requests that exceed the defined budget >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-static-query-complexity-release-notes.adoc[GraphQL Static Query Complexity] .1+>.^s| Returned status codes | 400 - Parse failures always trigger a 400 response. Complexity and list violations return this code only if *Block request* is enabled. The response includes a standard GraphQL errors object. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc index 4902998dd..01f76931f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Adds headers to a request or response. >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/header-injection-release-notes.adoc[Header Injection Policy] >s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc index f1e27f1bc..7fe46b906 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Removes headers from a request or a response >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/header-removal-release-notes.adoc[Header Removal] .1+>.^s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc index 4729c9475..3ce53c465 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Monitors API upstream health at specific intervals >s|Category | Quality of Service >s| First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/health-check-release-notes.adoc[Health Check Policy] .1+>.^s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc index 4312e1ae0..6e0e52707 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Caches HTTP responses from an API implementation >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/http-caching-release-notes.adoc[HTTP caching] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc index 952bffac9..8ebe8e7ac 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary| Scans incoming requests to protect against SQL, XSS, and custom injection attacks >s|Category| Security >s|First Omni Gateway version available |v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/injection-protection-release-notes.adoc[Injection Protection Policy] >s|Returned Status Codes|`400` - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc index aa7ecfe3e..6638913a9 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Allows a list or range of specified IP addresses to request access >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/ip-allowlist-release-notes.adoc[IP Allowlist] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc index 3221de817..ed970618a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Blocks a single IP address or a range of IP addresses from accessing an API endpoint >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/ip-blocklist-release-notes.adoc[IP Blocklist] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc index 46100b3ef..bfe1aa4c7 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary| Protects against malicious JSON in API requests >s|Category| Security >s|First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/json-threat-protection-release-notes.adoc[JSON Threat Protection Policy] >s|Returned Status Codes| 400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc index d611f36d8..945a75788 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc @@ -12,7 +12,6 @@ endif::[] >s| Summary | Validates a JWT >s| Category | Security >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/jwt-validation-release-notes.adoc[JWT Validation] .4+>.^s| Returned Status Codes | |400 - Token was not provided in the request. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc index 9a5b52252..1dab83c47 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Logs custom messages using information from incoming requests, responses from the backend, or information from other policies applied to the same API endpoint >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/message-logging-release-notes.adoc[Message Logging] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc index 1a114dbec..3fd468ffd 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Serves OAuth 2.0 Protected Resource Metadata at the well-known endpoint >s|Category | Security >s|First Omni Gateway version available | v1.9.3 ->s|Release Notes| xref:release-notes::flex-gateway/policies/oauth-protected-resource-metadata-release-notes.adoc[OAuth 2.0 Protected Resource Metadata] .2+>.^s| Returned Status Codes |404 - Request path does not match the well-known endpoint |405 - HTTP method is not GET diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc index f7c935121..7592713d8 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.3.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/oauth-token-introspection-release-notes.adoc[OAuth 2.0 Token Introspection Policy] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc index 14f4bac16..bab3159d3 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/openid-token-enforcement-release-notes.adoc[OpenID Connect OAuth 2.0 Token Enforcement] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc index ae7f37415..83f4fc328 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc @@ -12,7 +12,6 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a timespan, based on SLAs >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/rate-limiting-sla-release-notes.adoc[Rate-limiting SLA] .4+>.^s| Returned Status Codes |401 - Request blocked due to invalid client credentials (client ID or client secret) provided |429 - Quota exceeded; requests blocked until the current window finishes diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc index 1246251de..81f2a3269 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc @@ -12,7 +12,6 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a period of time >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/rate-limiting-release-notes.adoc[Rate Limiting] .4+>.^s| Returned Status Codes |429 - Quota exceeded, requests are blocked until the current window finishes |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc index 9fd4e534d..96985e08b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Sets the maximum duration that Omni Gateway waits for a response from an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/response-timeout-release-notes.adoc[Response Timeout] ^s| Returned Status Codes | 504 - Upstream request timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc index 8ba9b1f2f..139b24674 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary| Validates incoming traffic against a supplied API schema >s|Category| Security >s|First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/schema-validation-release-notes.adoc[Schema Validation Policy] >s|Returned Status Codes| 400 - The request properties do not comply with the API specifications. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc index abc448c6f..18d1e7d00 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary| Validates incoming traffic against a specified WSDL schema >s|Category| Security >s|First Omni Gateway version available |v1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/soap-schema-validation-release-notes.adoc[SOAP Schema Validation Policy] >.^s| Returned Status Codes | The policy returns a `400` for a client error or `500` for a server error. Error messages are defined by SOAP standard responses. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc index 2843494b5..32a77cb89 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Regulates API traffic >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/spike-control-release-notes.adoc[Spike Control] .4+>.^s| Returned Status Codes | [%autowidth.spread,cols="a,a"] | 429 - The number of requests by HTTP APIs exceeded the configured limit. Request rejected after specified number of reattempts. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc index 159e31180..43a4fed2a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Sets the maximum duration a stream can remain idle without receiving a request or response >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/stream-idle-timeout-release-notes.adoc[Stream Idle Timeout] ^s| Returned Status Codes | 504 - Stream timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc index a1a4e0f7e..f7f751ae9 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Enables two-way authentication between the API proxy and an upstream service >s|Category | Security >s| First Omni version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/tls-outbound-release-notes.adoc[Transport Layer Security (TLS) - Outbound] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc index d70899748..5e4fb20e2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc @@ -12,7 +12,6 @@ endif::[] >s|Summary | Enables authentication between a client and the API proxy >s|Category | Security >s| First Omni Gateway version available | v1.0.0 (inbound mTLS: v1.3.0) ->s|Release Notes| xref:release-notes::flex-gateway/policies/tls-release-notes.adoc[Transport Layer Security (TLS) - Inbound] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc index c80cfd98e..67d737221 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Override global tracing configuration >s|Category | Troubleshooting >s|First Omni Gateway version available | 1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/tracing-release-notes.adoc[Tracing] ^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc index fa9f9afc6..36ff54949 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc @@ -10,7 +10,6 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services >s|Summary | Manages API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/traffic-management-route-release-notes.adoc[Traffic Management for Multiple Upstream Services] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc index 18e791377..aeb7242bc 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc @@ -10,7 +10,6 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services (Weighted) >s|Summary | Manages weighted API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.5.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/traffic-management-release-notes.adoc[Traffic Management for Multiple Upstream Services (Weighted)] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc index 1ab7ed720..5eb569220 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc @@ -11,7 +11,6 @@ endif::[] >s| Summary | Limits the number of simultaneous WebSocket connections that each API instance allows >s| Category | Quality of Service >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/websocket-connection-limit-release-notes.adoc[WebSocket Connection Limit] .1+>.^s| Returned status codes | 429 - `Too many WebSocket connections` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc index a23463e1d..996ac0b42 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary| Protects against malicious XML in API requests >s|Category| Security >s|First Omni Gateway version available |v1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/xml-threat-protection-release-notes.adoc[XML Threat Protection Policy] >s|Returned Status Codes|400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc index b5bee7000..5242877a6 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Injects an API key or client credentials headers into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.10.2 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-api-key-release-notes.adoc[Credential Injection API Key] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc index 92cbe6507..e6026a5c4 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc @@ -6,7 +6,6 @@ >s| Summary | Triggers an AWS Lambda function from a standard HTTP request >s| Category | Transformation >s| First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-aws-lambda-release-notes.adoc[AWS Lambda] .4+>.^s| Returned Status Codes |502 - Bad Gateway, requests are blocked due to circuit breaker activation |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc index 2f154acbb..61d53f239 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Signs outgoing requests with AWS Signature Version 4 (SigV4) or Signature Version 4A (SigV4A) >s|Category | Security >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-aws-signature-release-notes.adoc[AWS Request Signature] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc index ed51456a5..f214f20eb 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Injects a basic authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-basic-auth-release-notes.adoc[Credential Injection Basic Authentication] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc index bd76de61b..17d9443d3 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc @@ -6,7 +6,6 @@ >s| Summary | Prevents an upstream from receiving too many requests or connections >s| Category | Quality of Service >s| First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-circuit-breaker-release-notes.adoc[Circuit Breaker] .4+>.^s| Returned Status Codes |503 - Service Unavailable |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc index 20cd02bc8..47875e5eb 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Generates and injects a JWT token into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-jwt-generation-release-notes.adoc[Credential Injection JWT Generation] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc index d4f54fec2..ed93c6729 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Logs custom messages from outbound requests sent to upstream services, responses from upstream services, or information from other outbound policies applied to the same upstream service >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-message-logging-release-notes.adoc[Outbound Message Logging] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc index ceddb907f..9ae74095a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Exchanges incoming bearer tokens using OAuth 2.0 Token Exchange (RFC 8693), Microsoft Entra ID On-Behalf-Of, or OAuth 2.0 Token Exchange with CIBA >s|Category | Security >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-oauth-obo-release-notes.adoc[OAuth 2.0 OBO Credential Injection] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc index 4dd5b3f46..49500b147 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Injects an OAuth 2.0 authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-oauth-release-notes.adoc[Credential Injection OAuth 2.0] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc index f14b5bc3d..a27ce1a10 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc @@ -11,7 +11,6 @@ endif::[] >s|Summary | Sets the maximum idle duration for a stream between the Omni Gateway and an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-upstream-idle-timeout-release-notes.adoc[Stream Idle Timeout] ^s| Returned Status Codes | 504 - Upstream request timeout |=== From 44797efc00e0beecb69b9158bc0c655e9f2efa57 Mon Sep 17 00:00:00 2001 From: Glenn Date: Fri, 26 Jun 2026 11:26:03 -0400 Subject: [PATCH 5/6] Revert "Remove release notes xrefs from Omni Gateway policy pages" This reverts commit 26c73ea4dbc9dc736239807bf6a6a71cc41d9c26. --- .../ROOT/pages/policies-included-azure-content-safety.adoc | 1 + .../modules/ROOT/pages/policies-included-basic-auth-ldap.adoc | 1 + .../modules/ROOT/pages/policies-included-basic-auth-simple.adoc | 1 + .../modules/ROOT/pages/policies-included-bedrock-guardrails.adoc | 1 + .../ROOT/pages/policies-included-client-id-enforcement.adoc | 1 + gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc | 1 + .../pages/policies-included-dataweave-body-transformation.adoc | 1 + .../policies-included-dataweave-headers-transformation.adoc | 1 + .../ROOT/pages/policies-included-dataweave-request-filter.adoc | 1 + .../ROOT/pages/policies-included-external-authorization.adoc | 1 + .../ROOT/pages/policies-included-external-processing.adoc | 1 + .../pages/policies-included-graphql-introspection-control.adoc | 1 + .../ROOT/pages/policies-included-graphql-operation-limits.adoc | 1 + .../ROOT/pages/policies-included-graphql-schema-validation.adoc | 1 + .../pages/policies-included-graphql-static-query-complexity.adoc | 1 + .../modules/ROOT/pages/policies-included-header-injection.adoc | 1 + .../modules/ROOT/pages/policies-included-header-removal.adoc | 1 + .../1.13/modules/ROOT/pages/policies-included-health-check.adoc | 1 + .../1.13/modules/ROOT/pages/policies-included-http-caching.adoc | 1 + .../ROOT/pages/policies-included-injection-protection.adoc | 1 + .../1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc | 1 + .../1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc | 1 + .../ROOT/pages/policies-included-json-threat-protection.adoc | 1 + .../modules/ROOT/pages/policies-included-jwt-validation.adoc | 1 + .../modules/ROOT/pages/policies-included-message-logging.adoc | 1 + .../policies-included-oauth-protected-resource-metadata.adoc | 1 + .../ROOT/pages/policies-included-oauth-token-introspection.adoc | 1 + .../ROOT/pages/policies-included-openid-token-enforcement.adoc | 1 + .../modules/ROOT/pages/policies-included-rate-limiting-sla.adoc | 1 + .../1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc | 1 + .../modules/ROOT/pages/policies-included-response-timeout.adoc | 1 + .../modules/ROOT/pages/policies-included-schema-validation.adoc | 1 + .../ROOT/pages/policies-included-soap-schema-validation.adoc | 1 + .../1.13/modules/ROOT/pages/policies-included-spike-control.adoc | 1 + .../ROOT/pages/policies-included-stream-idle-timeout.adoc | 1 + .../1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc | 1 + gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc | 1 + gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc | 1 + .../ROOT/pages/policies-included-traffic-management-route.adoc | 1 + .../modules/ROOT/pages/policies-included-traffic-management.adoc | 1 + .../ROOT/pages/policies-included-websocket-connection-limit.adoc | 1 + .../ROOT/pages/policies-included-xml-threat-protection.adoc | 1 + gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc | 1 + .../1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc | 1 + .../1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc | 1 + .../1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc | 1 + .../modules/ROOT/pages/policies-outbound-circuit-breaker.adoc | 1 + .../modules/ROOT/pages/policies-outbound-jwt-generation.adoc | 1 + .../modules/ROOT/pages/policies-outbound-message-logging.adoc | 1 + gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc | 1 + gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc | 1 + .../ROOT/pages/policies-outbound-upstream-idle-timeout.adoc | 1 + 52 files changed, 52 insertions(+) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc index cd5c01286..0b3f2fe66 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Azure AI Content Safety for harmful content, jailbreak attempts, hallucinations, and copyrighted material >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/azure-content-safety-release-notes.adoc[Azure Content Safety Policy] .>s| Returned Status Codes |403 - Forbidden: Content violates Azure Content Safety policies |503 - Service Unavailable: Azure API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc index 6dee81421..5b4897b7a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with user-password defined on LDAP >s|Category | Security >s|First Omni Gateway version available | v1.1.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/basic-auth-ldap-release-notes.adoc[Basic Authentication: LDAP] .1+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc index e15f5861e..5a7a8af78 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with a single user-password >s|Category | Security >s|First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/basic-auth-simple-release-notes.adoc[Basic Authentication: Simple] .1+>.^s| Returned Status Codes |400 - Unauthorized or invalid client application credentials in WSDL API using SOAP 1.2 | | 401 - Unauthorized or invalid client application credentials in HTTP or RAML APIs diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc index 54167165d..875424c56 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Amazon Bedrock guardrails for content safety, PII detection, and contextual grounding >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/bedrock-guardrails-release-notes.adoc[Amazon Bedrock Guardrails Policy] .>s| Returned Status Codes |403 - Forbidden: Content violates guardrail policies |503 - Service Unavailable: Bedrock API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc index 654d09197..9d37ebb05 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Compliance >s|First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/client-id-enforcement-release-notes.adoc[Client ID Enforcement] .4+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |500 - Bad response from authorization server, or WSDL SOAP Fault error diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc index 57c82d78e..aba5f5762 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc @@ -12,6 +12,7 @@ endif::[] >s| Summary | Enables access to resources residing in external domains >s| Category | Compliance >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/cors-release-notes.adoc[Cross-Origin Resource Sharing (CORS)] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc index a15608e25..a274e4b71 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Transforms the body of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-body-transformation-release-notes.adoc[DataWeave Body Transformation] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc index 4a9898060..e1fec6bc8 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Transforms headers of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-headers-transformation-release-notes.adoc[DataWeave Headers Transformation] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc index 80da7642c..1110426a3 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Filters requests by using a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | 1.12 +>s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-request-filter-release-notes.adoc[DataWeave Request Filter] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc index b2098445c..08798c8e2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Authenticates requests with an external gRPC or HTTP authorization service >s|Category | Security >s| First Omni Gateway version available | v1.6.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/external-authorization-release-notes.adoc[External Authorization Policy] >s| Returned Status Codes | 403 - Forbidden, invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc index 19e24f5f3..64559669b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Sends the incoming HTTP requests or outgoing HTTP responses requests to an external gRPC service for additional processing >s|Category | Transformation >s|First Omni Gateway version available | v1.6.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/external-processing-release-notes.adoc[External Processing] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc index fbd3520c5..01ac16ee0 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc @@ -11,6 +11,7 @@ endif::[] >s| Summary | Blocks or allows requests that access the `__schema`, `__type`, and `__typename` GraphQL meta fields >s| Category | Security >s| First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-introspection-control-release-notes.adoc[GraphQL Introspection Control] .1+>.^s| Returned status codes | 403 Forbidden — The response follows the standard GraphQL error format, including a message such as `Introspection field '__schema' is not allowed`. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc index 833f69a1d..2070227e4 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc @@ -11,6 +11,7 @@ endif::[] >s| Summary | Limits GraphQL operation depth, aliases, root fields, and directives >s| Category | Security >s| First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-operation-limits-release-notes.adoc[GraphQL Operation Limits] .1+>.^s| Returned status codes | 400 - Operations that exceed a configured limit. The response follows the standard GraphQL error format and lists each violation. For example, `Query depth of 7 exceeds the maximum allowed depth of 5` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc index 2489f2b7e..585fed4c2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc @@ -11,6 +11,7 @@ endif::[] >s| Summary | Validates incoming GraphQL operations against a GraphQL schema definition >s| Category | Security >s| First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-schema-validation-release-notes.adoc[GraphQL Schema Validation] .1+>.^s| Returned status codes | 400 - The operation doesn't satisfy the schema. When *Block request* is enabled, the JSON response includes GraphQL-style `errors` with a validation message. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc index db6625865..3a9553f9f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc @@ -11,6 +11,7 @@ endif::[] >s| Summary | Calculates query complexity and blocks requests that exceed the defined budget >s| Category | Security >s| First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-static-query-complexity-release-notes.adoc[GraphQL Static Query Complexity] .1+>.^s| Returned status codes | 400 - Parse failures always trigger a 400 response. Complexity and list violations return this code only if *Block request* is enabled. The response includes a standard GraphQL errors object. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc index 01f76931f..4902998dd 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Adds headers to a request or response. >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/header-injection-release-notes.adoc[Header Injection Policy] >s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc index 7fe46b906..f1e27f1bc 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Removes headers from a request or a response >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/header-removal-release-notes.adoc[Header Removal] .1+>.^s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc index 3ce53c465..4729c9475 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Monitors API upstream health at specific intervals >s|Category | Quality of Service >s| First Omni Gateway version available | v1.4.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/health-check-release-notes.adoc[Health Check Policy] .1+>.^s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc index 6e0e52707..4312e1ae0 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Caches HTTP responses from an API implementation >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/http-caching-release-notes.adoc[HTTP caching] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc index 8ebe8e7ac..952bffac9 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary| Scans incoming requests to protect against SQL, XSS, and custom injection attacks >s|Category| Security >s|First Omni Gateway version available |v1.12.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/injection-protection-release-notes.adoc[Injection Protection Policy] >s|Returned Status Codes|`400` - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc index 6638913a9..aa7ecfe3e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Allows a list or range of specified IP addresses to request access >s|Category | Security >s|First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/ip-allowlist-release-notes.adoc[IP Allowlist] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc index ed970618a..3221de817 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Blocks a single IP address or a range of IP addresses from accessing an API endpoint >s|Category | Security >s|First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/ip-blocklist-release-notes.adoc[IP Blocklist] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc index bfe1aa4c7..46100b3ef 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary| Protects against malicious JSON in API requests >s|Category| Security >s|First Omni Gateway version available | v1.4.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/json-threat-protection-release-notes.adoc[JSON Threat Protection Policy] >s|Returned Status Codes| 400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc index 945a75788..d611f36d8 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc @@ -12,6 +12,7 @@ endif::[] >s| Summary | Validates a JWT >s| Category | Security >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/jwt-validation-release-notes.adoc[JWT Validation] .4+>.^s| Returned Status Codes | |400 - Token was not provided in the request. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc index 1dab83c47..9a5b52252 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Logs custom messages using information from incoming requests, responses from the backend, or information from other policies applied to the same API endpoint >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/message-logging-release-notes.adoc[Message Logging] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc index 3fd468ffd..1a114dbec 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Serves OAuth 2.0 Protected Resource Metadata at the well-known endpoint >s|Category | Security >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/oauth-protected-resource-metadata-release-notes.adoc[OAuth 2.0 Protected Resource Metadata] .2+>.^s| Returned Status Codes |404 - Request path does not match the well-known endpoint |405 - HTTP method is not GET diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc index 7592713d8..f7c935121 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.3.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/oauth-token-introspection-release-notes.adoc[OAuth 2.0 Token Introspection Policy] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc index bab3159d3..14f4bac16 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/openid-token-enforcement-release-notes.adoc[OpenID Connect OAuth 2.0 Token Enforcement] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc index 83f4fc328..ae7f37415 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc @@ -12,6 +12,7 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a timespan, based on SLAs >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/rate-limiting-sla-release-notes.adoc[Rate-limiting SLA] .4+>.^s| Returned Status Codes |401 - Request blocked due to invalid client credentials (client ID or client secret) provided |429 - Quota exceeded; requests blocked until the current window finishes diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc index 81f2a3269..1246251de 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc @@ -12,6 +12,7 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a period of time >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/rate-limiting-release-notes.adoc[Rate Limiting] .4+>.^s| Returned Status Codes |429 - Quota exceeded, requests are blocked until the current window finishes |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc index 96985e08b..9fd4e534d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Sets the maximum duration that Omni Gateway waits for a response from an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/response-timeout-release-notes.adoc[Response Timeout] ^s| Returned Status Codes | 504 - Upstream request timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc index 139b24674..8ba9b1f2f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary| Validates incoming traffic against a supplied API schema >s|Category| Security >s|First Omni Gateway version available | v1.4.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/schema-validation-release-notes.adoc[Schema Validation Policy] >s|Returned Status Codes| 400 - The request properties do not comply with the API specifications. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc index 18d1e7d00..abc448c6f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary| Validates incoming traffic against a specified WSDL schema >s|Category| Security >s|First Omni Gateway version available |v1.10.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/soap-schema-validation-release-notes.adoc[SOAP Schema Validation Policy] >.^s| Returned Status Codes | The policy returns a `400` for a client error or `500` for a server error. Error messages are defined by SOAP standard responses. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc index 32a77cb89..2843494b5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Regulates API traffic >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/spike-control-release-notes.adoc[Spike Control] .4+>.^s| Returned Status Codes | [%autowidth.spread,cols="a,a"] | 429 - The number of requests by HTTP APIs exceeded the configured limit. Request rejected after specified number of reattempts. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc index 43a4fed2a..159e31180 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Sets the maximum duration a stream can remain idle without receiving a request or response >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/stream-idle-timeout-release-notes.adoc[Stream Idle Timeout] ^s| Returned Status Codes | 504 - Stream timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc index f7f751ae9..a1a4e0f7e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Enables two-way authentication between the API proxy and an upstream service >s|Category | Security >s| First Omni version available | v1.4.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/tls-outbound-release-notes.adoc[Transport Layer Security (TLS) - Outbound] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc index 5e4fb20e2..d70899748 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc @@ -12,6 +12,7 @@ endif::[] >s|Summary | Enables authentication between a client and the API proxy >s|Category | Security >s| First Omni Gateway version available | v1.0.0 (inbound mTLS: v1.3.0) +>s|Release Notes| xref:release-notes::flex-gateway/policies/tls-release-notes.adoc[Transport Layer Security (TLS) - Inbound] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc index 67d737221..c80cfd98e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Override global tracing configuration >s|Category | Troubleshooting >s|First Omni Gateway version available | 1.10.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/tracing-release-notes.adoc[Tracing] ^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc index 36ff54949..fa9f9afc6 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc @@ -10,6 +10,7 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services >s|Summary | Manages API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.0.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/traffic-management-route-release-notes.adoc[Traffic Management for Multiple Upstream Services] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc index aeb7242bc..18e791377 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc @@ -10,6 +10,7 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services (Weighted) >s|Summary | Manages weighted API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.5.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/traffic-management-release-notes.adoc[Traffic Management for Multiple Upstream Services (Weighted)] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc index 5eb569220..1ab7ed720 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc @@ -11,6 +11,7 @@ endif::[] >s| Summary | Limits the number of simultaneous WebSocket connections that each API instance allows >s| Category | Quality of Service >s| First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/websocket-connection-limit-release-notes.adoc[WebSocket Connection Limit] .1+>.^s| Returned status codes | 429 - `Too many WebSocket connections` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc index 996ac0b42..a23463e1d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary| Protects against malicious XML in API requests >s|Category| Security >s|First Omni Gateway version available |v1.10.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/xml-threat-protection-release-notes.adoc[XML Threat Protection Policy] >s|Returned Status Codes|400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc index 5242877a6..b5bee7000 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Injects an API key or client credentials headers into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.10.2 +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-api-key-release-notes.adoc[Credential Injection API Key] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc index e6026a5c4..92cbe6507 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc @@ -6,6 +6,7 @@ >s| Summary | Triggers an AWS Lambda function from a standard HTTP request >s| Category | Transformation >s| First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-aws-lambda-release-notes.adoc[AWS Lambda] .4+>.^s| Returned Status Codes |502 - Bad Gateway, requests are blocked due to circuit breaker activation |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc index 61d53f239..2f154acbb 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Signs outgoing requests with AWS Signature Version 4 (SigV4) or Signature Version 4A (SigV4A) >s|Category | Security >s|First Omni Gateway version available | v1.11.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-aws-signature-release-notes.adoc[AWS Request Signature] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc index f214f20eb..ed51456a5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Injects a basic authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-basic-auth-release-notes.adoc[Credential Injection Basic Authentication] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc index 17d9443d3..bd76de61b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc @@ -6,6 +6,7 @@ >s| Summary | Prevents an upstream from receiving too many requests or connections >s| Category | Quality of Service >s| First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-circuit-breaker-release-notes.adoc[Circuit Breaker] .4+>.^s| Returned Status Codes |503 - Service Unavailable |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc index 47875e5eb..20cd02bc8 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Generates and injects a JWT token into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.12.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-jwt-generation-release-notes.adoc[Credential Injection JWT Generation] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc index ed93c6729..d4f54fec2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Logs custom messages from outbound requests sent to upstream services, responses from upstream services, or information from other outbound policies applied to the same upstream service >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.11.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-message-logging-release-notes.adoc[Outbound Message Logging] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc index 9ae74095a..ceddb907f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Exchanges incoming bearer tokens using OAuth 2.0 Token Exchange (RFC 8693), Microsoft Entra ID On-Behalf-Of, or OAuth 2.0 Token Exchange with CIBA >s|Category | Security >s|First Omni Gateway version available | v1.11.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-oauth-obo-release-notes.adoc[OAuth 2.0 OBO Credential Injection] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc index 49500b147..4dd5b3f46 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Injects an OAuth 2.0 authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-oauth-release-notes.adoc[Credential Injection OAuth 2.0] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc index a27ce1a10..f14b5bc3d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Sets the maximum idle duration for a stream between the Omni Gateway and an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-upstream-idle-timeout-release-notes.adoc[Stream Idle Timeout] ^s| Returned Status Codes | 504 - Upstream request timeout |=== From ca2437737469432a77b031111a069a473910efb2 Mon Sep 17 00:00:00 2001 From: Glenn Date: Fri, 10 Jul 2026 10:51:37 -0400 Subject: [PATCH 6/6] Edits --- .../modules/ROOT/pages/policies-included-a2a-agent-card.adoc | 1 + .../modules/ROOT/pages/policies-included-a2a-pii-detector.adoc | 1 + .../ROOT/pages/policies-included-a2a-prompt-decorator.adoc | 1 + .../ROOT/pages/policies-included-a2a-schema-validation.adoc | 1 + .../ROOT/pages/policies-included-a2a-token-rate-limit.adoc | 1 + .../pages/policies-included-agent-connection-telemetry.adoc | 1 + .../ROOT/pages/policies-included-azure-content-safety.adoc | 2 +- .../modules/ROOT/pages/policies-included-basic-auth-ldap.adoc | 2 +- .../ROOT/pages/policies-included-basic-auth-simple.adoc | 2 +- .../ROOT/pages/policies-included-bedrock-guardrails.adoc | 2 +- .../ROOT/pages/policies-included-client-id-enforcement.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc | 2 +- .../pages/policies-included-dataweave-body-transformation.adoc | 2 +- .../policies-included-dataweave-headers-transformation.adoc | 2 +- .../ROOT/pages/policies-included-dataweave-request-filter.adoc | 2 +- .../ROOT/pages/policies-included-external-authorization.adoc | 2 +- .../ROOT/pages/policies-included-external-processing.adoc | 2 +- .../pages/policies-included-graphql-introspection-control.adoc | 2 +- .../ROOT/pages/policies-included-graphql-operation-limits.adoc | 2 +- .../pages/policies-included-graphql-schema-validation.adoc | 2 +- .../policies-included-graphql-static-query-complexity.adoc | 2 +- .../modules/ROOT/pages/policies-included-header-injection.adoc | 2 +- .../modules/ROOT/pages/policies-included-header-removal.adoc | 2 +- .../modules/ROOT/pages/policies-included-health-check.adoc | 2 +- .../modules/ROOT/pages/policies-included-http-caching.adoc | 2 +- .../ROOT/pages/policies-included-injection-protection.adoc | 2 +- .../modules/ROOT/pages/policies-included-ip-allowlist.adoc | 2 +- .../modules/ROOT/pages/policies-included-ip-blocklist.adoc | 2 +- .../ROOT/pages/policies-included-json-threat-protection.adoc | 2 +- .../modules/ROOT/pages/policies-included-jwt-validation.adoc | 2 +- .../ROOT/pages/policies-included-llm-pii-detection.adoc | 1 + .../ROOT/pages/policies-included-llm-token-rate-limit.adoc | 1 + .../pages/policies-included-mcp-attribute-access-control.adoc | 1 + .../ROOT/pages/policies-included-mcp-global-access.adoc | 1 + .../ROOT/pages/policies-included-mcp-payload-optimization.adoc | 1 + .../modules/ROOT/pages/policies-included-mcp-pii-detector.adoc | 1 + .../ROOT/pages/policies-included-mcp-schema-validation.adoc | 1 + .../1.13/modules/ROOT/pages/policies-included-mcp-support.adoc | 1 + .../modules/ROOT/pages/policies-included-mcp-tool-mapping.adoc | 1 + .../modules/ROOT/pages/policies-included-message-logging.adoc | 2 +- .../policies-included-oauth-protected-resource-metadata.adoc | 2 +- .../pages/policies-included-oauth-token-introspection.adoc | 2 +- .../ROOT/pages/policies-included-openid-token-enforcement.adoc | 2 +- .../ROOT/pages/policies-included-rate-limiting-sla.adoc | 2 +- .../modules/ROOT/pages/policies-included-rate-limiting.adoc | 2 +- .../ROOT/pages/policies-included-regex-prompt-guard.adoc | 1 + .../modules/ROOT/pages/policies-included-response-timeout.adoc | 2 +- .../ROOT/pages/policies-included-schema-validation.adoc | 2 +- .../ROOT/pages/policies-included-soap-schema-validation.adoc | 2 +- .../modules/ROOT/pages/policies-included-spike-control.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-included-sse-logging.adoc | 3 ++- .../ROOT/pages/policies-included-stream-idle-timeout.adoc | 2 +- .../modules/ROOT/pages/policies-included-tls-outbound.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc | 2 +- .../ROOT/pages/policies-included-traffic-management-route.adoc | 2 +- .../ROOT/pages/policies-included-traffic-management.adoc | 2 +- .../pages/policies-included-websocket-connection-limit.adoc | 2 +- .../ROOT/pages/policies-included-xml-threat-protection.adoc | 2 +- .../pages/policies-outbound-a2a-intask-authorization-code.adoc | 1 + gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-aws-signature.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-circuit-breaker.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-jwt-generation.adoc | 2 +- .../modules/ROOT/pages/policies-outbound-message-logging.adoc | 2 +- .../1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc | 2 +- gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc | 2 +- .../ROOT/pages/policies-outbound-upstream-idle-timeout.adoc | 2 +- 70 files changed, 71 insertions(+), 53 deletions(-) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-a2a-agent-card.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-a2a-agent-card.adoc index 6c4081e56..2eb980b6e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-a2a-agent-card.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-a2a-agent-card.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Rewrites the Agent Card URL to match the public URL of the gateway >s|Category | A2A >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/a2a-agent-card-release-notes.adoc[] >s| Returned Status Codes | |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-a2a-pii-detector.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-a2a-pii-detector.adoc index 3bba6de0e..a8f64be1f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-a2a-pii-detector.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-a2a-pii-detector.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Detects personally identifiable information (PII) in A2A JSON-RPC traffic >s|Category | A2A >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/a2a-pii-detector-release-notes.adoc[] >s| Returned Status Codes | HTTP 403 with JSON-RPC 2.0 error code `-32602` (Invalid params) |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-a2a-prompt-decorator.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-a2a-prompt-decorator.adoc index cfba6b58d..0add877d4 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-a2a-prompt-decorator.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-a2a-prompt-decorator.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Decorates prompts with context information >s|Category | A2A >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/a2a-prompt-decorator-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-a2a-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-a2a-schema-validation.adoc index f8abee378..49bf1862c 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-a2a-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-a2a-schema-validation.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Validates Agent requests to ensure they conform to the A2A specification >s|Category | A2A >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/a2a-schema-validation-release-notes.adoc[] >s| Returned Status Codes | |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-a2a-token-rate-limit.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-a2a-token-rate-limit.adoc index a67b7fe2e..7440c4e56 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-a2a-token-rate-limit.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-a2a-token-rate-limit.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Rate limits agent usage of upstream resources >s|Category | A2A >s|First Omni Gateway version available | v1.11.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/a2a-token-rate-limit-release-notes.adoc[] .>s| Returned Status Codes |429 - Too Many Requests: Token limit exceeded, requests are blocked until the current window finishes |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-agent-connection-telemetry.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-agent-connection-telemetry.adoc index 3dd26862e..48a7d5daa 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-agent-connection-telemetry.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-agent-connection-telemetry.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Tracks the number of requests made to agent or MCP server instances >s|Category | A2A and MCP >s|First Omni Gateway version available | 1.11.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/agent-connection-telemetry-release-notes.adoc[] ^s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc index 0b3f2fe66..a5faa27be 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-azure-content-safety.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Azure AI Content Safety for harmful content, jailbreak attempts, hallucinations, and copyrighted material >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/azure-content-safety-release-notes.adoc[Azure Content Safety Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/azure-content-safety-release-notes.adoc[] .>s| Returned Status Codes |403 - Forbidden: Content violates Azure Content Safety policies |503 - Service Unavailable: Azure API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc index 5b4897b7a..b90dc719e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-ldap.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with user-password defined on LDAP >s|Category | Security >s|First Omni Gateway version available | v1.1.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/basic-auth-ldap-release-notes.adoc[Basic Authentication: LDAP] +>s|Release Notes| xref:release-notes::flex-gateway/policies/basic-auth-ldap-release-notes.adoc[] .1+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc index 5a7a8af78..13dcf4107 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-basic-auth-simple.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access based on the basic authorization mechanism, with a single user-password >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/basic-auth-simple-release-notes.adoc[Basic Authentication: Simple] +>s|Release Notes| xref:release-notes::flex-gateway/policies/basic-auth-simple-release-notes.adoc[] .1+>.^s| Returned Status Codes |400 - Unauthorized or invalid client application credentials in WSDL API using SOAP 1.2 | | 401 - Unauthorized or invalid client application credentials in HTTP or RAML APIs diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc index 875424c56..c3c3cc300 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-bedrock-guardrails.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Evaluates LLM prompts and responses against Amazon Bedrock guardrails for content safety, PII detection, and contextual grounding >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/bedrock-guardrails-release-notes.adoc[Amazon Bedrock Guardrails Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/bedrock-guardrails-release-notes.adoc[] .>s| Returned Status Codes |403 - Forbidden: Content violates guardrail policies |503 - Service Unavailable: Bedrock API call failed (only when fail-open is disabled) diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc index 9d37ebb05..dec882875 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-client-id-enforcement.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Compliance >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/client-id-enforcement-release-notes.adoc[Client ID Enforcement] +>s|Release Notes| xref:release-notes::flex-gateway/policies/client-id-enforcement-release-notes.adoc[] .4+>.^s| Returned Status Codes |401 - Unauthorized or invalid client application credentials |500 - Bad response from authorization server, or WSDL SOAP Fault error diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc index aba5f5762..41c631e4e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-cors.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Enables access to resources residing in external domains >s| Category | Compliance >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/cors-release-notes.adoc[Cross-Origin Resource Sharing (CORS)] +>s|Release Notes| xref:release-notes::flex-gateway/policies/cors-release-notes.adoc[] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc index a274e4b71..24ac4a549 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-body-transformation.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Transforms the body of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-body-transformation-release-notes.adoc[DataWeave Body Transformation] +>s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-body-transformation-release-notes.adoc[] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc index e1fec6bc8..a1c950dff 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-headers-transformation.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Transforms headers of request or response traffic with a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-headers-transformation-release-notes.adoc[DataWeave Headers Transformation] +>s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-headers-transformation-release-notes.adoc[] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc index 1110426a3..c2a583cf6 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-dataweave-request-filter.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Filters requests by using a DataWeave script >s|Category | Transformation >s| First Omni Gateway version available | 1.12 ->s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-request-filter-release-notes.adoc[DataWeave Request Filter] +>s|Release Notes| xref:release-notes::flex-gateway/policies/dataweave-request-filter-release-notes.adoc[] .1+>.^s| Returned Status Codes | `400` - The DataWeave script failed to execute or returned an invalid result |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc index 08798c8e2..a1d9409b4 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-authorization.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Authenticates requests with an external gRPC or HTTP authorization service >s|Category | Security >s| First Omni Gateway version available | v1.6.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/external-authorization-release-notes.adoc[External Authorization Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/external-authorization-release-notes.adoc[] >s| Returned Status Codes | 403 - Forbidden, invalid client application credentials |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc index 64559669b..ea7818f8a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-external-processing.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Sends the incoming HTTP requests or outgoing HTTP responses requests to an external gRPC service for additional processing >s|Category | Transformation >s|First Omni Gateway version available | v1.6.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/external-processing-release-notes.adoc[External Processing] +>s|Release Notes| xref:release-notes::flex-gateway/policies/external-processing-release-notes.adoc[] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc index 01ac16ee0..e70f1ec97 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-introspection-control.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Blocks or allows requests that access the `__schema`, `__type`, and `__typename` GraphQL meta fields >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-introspection-control-release-notes.adoc[GraphQL Introspection Control] +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-introspection-control-release-notes.adoc[] .1+>.^s| Returned status codes | 403 Forbidden — The response follows the standard GraphQL error format, including a message such as `Introspection field '__schema' is not allowed`. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc index 2070227e4..77f6df07e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-operation-limits.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Limits GraphQL operation depth, aliases, root fields, and directives >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-operation-limits-release-notes.adoc[GraphQL Operation Limits] +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-operation-limits-release-notes.adoc[] .1+>.^s| Returned status codes | 400 - Operations that exceed a configured limit. The response follows the standard GraphQL error format and lists each violation. For example, `Query depth of 7 exceeds the maximum allowed depth of 5` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc index 585fed4c2..c63e65df1 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-schema-validation.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Validates incoming GraphQL operations against a GraphQL schema definition >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-schema-validation-release-notes.adoc[GraphQL Schema Validation] +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-schema-validation-release-notes.adoc[] .1+>.^s| Returned status codes | 400 - The operation doesn't satisfy the schema. When *Block request* is enabled, the JSON response includes GraphQL-style `errors` with a validation message. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc index 3a9553f9f..ce364111a 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-graphql-static-query-complexity.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Calculates query complexity and blocks requests that exceed the defined budget >s| Category | Security >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-static-query-complexity-release-notes.adoc[GraphQL Static Query Complexity] +>s|Release Notes| xref:release-notes::flex-gateway/policies/graphql-static-query-complexity-release-notes.adoc[] .1+>.^s| Returned status codes | 400 - Parse failures always trigger a 400 response. Complexity and list violations return this code only if *Block request* is enabled. The response includes a standard GraphQL errors object. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc index 4902998dd..8039f82f6 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-injection.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Adds headers to a request or response. >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/header-injection-release-notes.adoc[Header Injection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/header-injection-release-notes.adoc[] >s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc index f1e27f1bc..ac011ccf5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-header-removal.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Removes headers from a request or a response >s|Category | Transformation >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/header-removal-release-notes.adoc[Header Removal] +>s|Release Notes| xref:release-notes::flex-gateway/policies/header-removal-release-notes.adoc[] .1+>.^s| Returned Status Codes | 500 - The configuration includes an expression that was not evaluated. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc index 4729c9475..51747847b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-health-check.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Monitors API upstream health at specific intervals >s|Category | Quality of Service >s| First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/health-check-release-notes.adoc[Health Check Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/health-check-release-notes.adoc[] .1+>.^s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc index 4312e1ae0..37a427083 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-http-caching.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Caches HTTP responses from an API implementation >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/http-caching-release-notes.adoc[HTTP caching] +>s|Release Notes| xref:release-notes::flex-gateway/policies/http-caching-release-notes.adoc[] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc index 952bffac9..da5a6c6fc 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-injection-protection.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary| Scans incoming requests to protect against SQL, XSS, and custom injection attacks >s|Category| Security >s|First Omni Gateway version available |v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/injection-protection-release-notes.adoc[Injection Protection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/injection-protection-release-notes.adoc[] >s|Returned Status Codes|`400` - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc index aa7ecfe3e..b80d4e666 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-allowlist.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows a list or range of specified IP addresses to request access >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/ip-allowlist-release-notes.adoc[IP Allowlist] +>s|Release Notes| xref:release-notes::flex-gateway/policies/ip-allowlist-release-notes.adoc[] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc index 3221de817..b5b2a4b26 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-ip-blocklist.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Blocks a single IP address or a range of IP addresses from accessing an API endpoint >s|Category | Security >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/ip-blocklist-release-notes.adoc[IP Blocklist] +>s|Release Notes| xref:release-notes::flex-gateway/policies/ip-blocklist-release-notes.adoc[] .1+>.^s| Returned Status Codes | 403 - IP is rejected |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc index 46100b3ef..b333dedd2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-json-threat-protection.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary| Protects against malicious JSON in API requests >s|Category| Security >s|First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/json-threat-protection-release-notes.adoc[JSON Threat Protection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/json-threat-protection-release-notes.adoc[] >s|Returned Status Codes| 400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc index d611f36d8..bed81ab58 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-jwt-validation.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Validates a JWT >s| Category | Security >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/jwt-validation-release-notes.adoc[JWT Validation] +>s|Release Notes| xref:release-notes::flex-gateway/policies/jwt-validation-release-notes.adoc[] .4+>.^s| Returned Status Codes | |400 - Token was not provided in the request. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-llm-pii-detection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-llm-pii-detection.adoc index ee17d9cbd..e282d3c53 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-llm-pii-detection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-llm-pii-detection.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Detects personally identifiable information (PII) in OpenAI-format LLM requests and responses >s|Category | LLM >s|First Omni Gateway version available | v1.13.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/llm-pii-detection-release-notes.adoc[] >s| Returned Status Codes |403 - Forbidden |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-llm-token-rate-limit.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-llm-token-rate-limit.adoc index c3450b66b..1887d96e0 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-llm-token-rate-limit.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-llm-token-rate-limit.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Rate limits LLM Proxy usage based on token consumption >s|Category | LLM >s|First Omni Gateway version available | v1.11.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/llm-token-rate-limit-release-notes.adoc[] .>s| Returned Status Codes |429 - Too Many Requests: Token limit exceeded, requests are blocked until the current window finishes |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-attribute-access-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-attribute-access-control.adoc index 3093b40dc..7bb39ff3e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-attribute-access-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-attribute-access-control.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Controls access to tools, resources, and prompts based on user information such as Tiers, IP, Headers, or Claims >s|Category | MCP >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/mcp-access-control-release-notes.adoc[] >s| Returned Status Codes | 400 - Invalid token |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-global-access.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-global-access.adoc index 3cbfcf6d0..4fead1305 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-global-access.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-global-access.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Restricts which MCP tools are exposed by defining Allow and Block rules >s|Category | MCP >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/mcp-global-access-policy-release-notes.adoc[] >s| Returned Status Codes | 403 — Returned when a call targets a blocked tool |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-payload-optimization.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-payload-optimization.adoc index d1deba31e..64c98d301 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-payload-optimization.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-payload-optimization.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Optimizes MCP tool responses for token consumption by transforming HTML to Markdown and removing unnecessary data >s|Category | MCP >s|First Omni Gateway version available | v1.12.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/mcp-payload-optimization-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. The policy modifies response bodies and doesn't block traffic based on content. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-pii-detector.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-pii-detector.adoc index 7e4f2b449..d5cabcadc 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-pii-detector.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-pii-detector.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Blocks elicitation responses containing personally identifiable information (PII) from reaching MCP servers >s|Category | MCP >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/mcp-pii-detector-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. The policy reports a policy violation when PII is detected. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-schema-validation.adoc index 75e8c5afa..bbe81c291 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-schema-validation.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Validates MCP requests to ensure they conform to the MCP specification >s|Category | MCP >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/mcp-schema-validation-release-notes.adoc[] >s| Returned Status Codes | |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-support.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-support.adoc index 1b3fd9711..3e0371ff3 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-support.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-support.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Adds MCP support to an Omni Gateway MCP server instance. This policy is required for your MCP server instance to function properly. >s|Category | MCP >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/mcp-support-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-tool-mapping.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-tool-mapping.adoc index 31205c3ae..0f18576e7 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-mcp-tool-mapping.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-mcp-tool-mapping.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Redefines tool names and descriptions to reduce prompt complexity and improve LLM comprehension >s|Category | MCP >s|First Omni Gateway version available | v1.11.0 +>s|Release Notes| xref:release-notes::flex-gateway/policies/mcp-tool-mapping-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc index 9a5b52252..6799d2366 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-message-logging.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Logs custom messages using information from incoming requests, responses from the backend, or information from other policies applied to the same API endpoint >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/message-logging-release-notes.adoc[Message Logging] +>s|Release Notes| xref:release-notes::flex-gateway/policies/message-logging-release-notes.adoc[] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc index 41c17ac0f..7dbb5189b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-protected-resource-metadata.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Serves OAuth 2.0 Protected Resource Metadata at the well-known endpoint >s|Category | Security >s|First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/oauth-protected-resource-metadata-release-notes.adoc[OAuth 2.0 Protected Resource Metadata] +>s|Release Notes| xref:release-notes::flex-gateway/policies/oauth-protected-resource-metadata-release-notes.adoc[] .2+>.^s| Returned Status Codes |404 - Request path does not match the well-known endpoint |405 - HTTP method is not GET diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc index f7c935121..62a9c2b59 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-oauth-token-introspection.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.3.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/oauth-token-introspection-release-notes.adoc[OAuth 2.0 Token Introspection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/oauth-token-introspection-release-notes.adoc[] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc index 14f4bac16..fa52411ec 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-openid-token-enforcement.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Allows access only to authorized client applications >s|Category | Security >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/openid-token-enforcement-release-notes.adoc[OpenID Connect OAuth 2.0 Token Enforcement] +>s|Release Notes| xref:release-notes::flex-gateway/policies/openid-token-enforcement-release-notes.adoc[] .4+>.^s| Returned Status Codes |400 - Invalid token |401 - Unauthorized access or error when connecting to the authorization server diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc index ae7f37415..2cf5cc636 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting-sla.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a timespan, based on SLAs >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/rate-limiting-sla-release-notes.adoc[Rate-limiting SLA] +>s|Release Notes| xref:release-notes::flex-gateway/policies/rate-limiting-sla-release-notes.adoc[] .4+>.^s| Returned Status Codes |401 - Request blocked due to invalid client credentials (client ID or client secret) provided |429 - Quota exceeded; requests blocked until the current window finishes diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc index 1246251de..6c59c1b81 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-rate-limiting.adoc @@ -12,7 +12,7 @@ endif::[] >s| Summary | Monitors access to an API by defining the maximum number of requests processed within a period of time >s| Category | Quality of Service >s| First Omni Gateway version available | v1.2.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/rate-limiting-release-notes.adoc[Rate Limiting] +>s|Release Notes| xref:release-notes::flex-gateway/policies/rate-limiting-release-notes.adoc[] .4+>.^s| Returned Status Codes |429 - Quota exceeded, requests are blocked until the current window finishes |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-regex-prompt-guard.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-regex-prompt-guard.adoc index 2ff9df705..1d3072801 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-regex-prompt-guard.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-regex-prompt-guard.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Blocks LLM requests that match deny-list regex patterns >s|Category | LLM >s|First Omni Gateway version available | v1.11.4 +>s|Release Notes| xref:release-notes::flex-gateway/policies/regex-prompt-guard-policy-release-notes.adoc[] .>s| Returned Status Codes |403 - Forbidden: Request blocked because prompt content matched one or more denied patterns |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc index 9fd4e534d..03ec75e71 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-response-timeout.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Sets the maximum duration that Omni Gateway waits for a response from an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/response-timeout-release-notes.adoc[Response Timeout] +>s|Release Notes| xref:release-notes::flex-gateway/policies/response-timeout-release-notes.adoc[] ^s| Returned Status Codes | 504 - Upstream request timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc index 8ba9b1f2f..0287807ca 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-schema-validation.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary| Validates incoming traffic against a supplied API schema >s|Category| Security >s|First Omni Gateway version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/schema-validation-release-notes.adoc[Schema Validation Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/schema-validation-release-notes.adoc[] >s|Returned Status Codes| 400 - The request properties do not comply with the API specifications. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc index abc448c6f..ce9ac2441 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-soap-schema-validation.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary| Validates incoming traffic against a specified WSDL schema >s|Category| Security >s|First Omni Gateway version available |v1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/soap-schema-validation-release-notes.adoc[SOAP Schema Validation Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/soap-schema-validation-release-notes.adoc[] >.^s| Returned Status Codes | The policy returns a `400` for a client error or `500` for a server error. Error messages are defined by SOAP standard responses. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc index 2843494b5..873c9628e 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-spike-control.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Regulates API traffic >s|Category | Quality of Service >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/spike-control-release-notes.adoc[Spike Control] +>s|Release Notes| xref:release-notes::flex-gateway/policies/spike-control-release-notes.adoc[] .4+>.^s| Returned Status Codes | [%autowidth.spread,cols="a,a"] | 429 - The number of requests by HTTP APIs exceeded the configured limit. Request rejected after specified number of reattempts. diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-sse-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-sse-logging.adoc index 638bfe0a8..a6c439c02 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-sse-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-sse-logging.adoc @@ -8,9 +8,10 @@ endif::[] [width="100%", cols="5,15"] |=== >s| Policy Name | SSE Logging ->s|Summary | Logs every SSE event while streaming +>s|Summary | Logs every SSE event while streaming >s|Category | SSE >s|First Omni Gateway version available | v1.9.3 +>s|Release Notes| xref:release-notes::flex-gateway/policies/sse-logging-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc index 159e31180..13ee27d1b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-stream-idle-timeout.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Sets the maximum duration a stream can remain idle without receiving a request or response >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/stream-idle-timeout-release-notes.adoc[Stream Idle Timeout] +>s|Release Notes| xref:release-notes::flex-gateway/policies/stream-idle-timeout-release-notes.adoc[] ^s| Returned Status Codes | 504 - Stream timeout |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc index a1a4e0f7e..0058248ee 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls-outbound.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Enables two-way authentication between the API proxy and an upstream service >s|Category | Security >s| First Omni version available | v1.4.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/tls-outbound-release-notes.adoc[Transport Layer Security (TLS) - Outbound] +>s|Release Notes| xref:release-notes::flex-gateway/policies/tls-outbound-release-notes.adoc[] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc index d70899748..36a293ce5 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tls.adoc @@ -12,7 +12,7 @@ endif::[] >s|Summary | Enables authentication between a client and the API proxy >s|Category | Security >s| First Omni Gateway version available | v1.0.0 (inbound mTLS: v1.3.0) ->s|Release Notes| xref:release-notes::flex-gateway/policies/tls-release-notes.adoc[Transport Layer Security (TLS) - Inbound] +>s|Release Notes| xref:release-notes::flex-gateway/policies/tls-release-notes.adoc[] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] | diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc index c80cfd98e..f17cbeb06 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-tracing.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Override global tracing configuration >s|Category | Troubleshooting >s|First Omni Gateway version available | 1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/tracing-release-notes.adoc[Tracing] +>s|Release Notes| xref:release-notes::flex-gateway/policies/tracing-release-notes.adoc[] ^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc index fa9f9afc6..7c96ba497 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management-route.adoc @@ -10,7 +10,7 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services >s|Summary | Manages API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.0.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/traffic-management-route-release-notes.adoc[Traffic Management for Multiple Upstream Services] +>s|Release Notes| xref:release-notes::flex-gateway/policies/traffic-management-route-release-notes.adoc[] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc index 18e791377..5f27210cc 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-traffic-management.adoc @@ -10,7 +10,7 @@ endif::[] >s| Policy Name | Traffic Management for Multiple Upstream Services (Weighted) >s|Summary | Manages weighted API instance traffic to multiple upstream services from a single consumer endpoint >s| First Omni Gateway version available | v1.5.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/traffic-management-release-notes.adoc[Traffic Management for Multiple Upstream Services (Weighted)] +>s|Release Notes| xref:release-notes::flex-gateway/policies/traffic-management-release-notes.adoc[] .4+>.^s| Returned Status Codes | No return codes exist for this policy. [%autowidth.spread,cols="a,a"] |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc index 1ab7ed720..e509451e8 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-websocket-connection-limit.adoc @@ -11,7 +11,7 @@ endif::[] >s| Summary | Limits the number of simultaneous WebSocket connections that each API instance allows >s| Category | Quality of Service >s| First Omni Gateway version available | v1.13.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/websocket-connection-limit-release-notes.adoc[WebSocket Connection Limit] +>s|Release Notes| xref:release-notes::flex-gateway/policies/websocket-connection-limit-release-notes.adoc[] .1+>.^s| Returned status codes | 429 - `Too many WebSocket connections` |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc index a23463e1d..da7bb5768 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-included-xml-threat-protection.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary| Protects against malicious XML in API requests >s|Category| Security >s|First Omni Gateway version available |v1.10.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/xml-threat-protection-release-notes.adoc[XML Threat Protection Policy] +>s|Release Notes| xref:release-notes::flex-gateway/policies/xml-threat-protection-release-notes.adoc[] >s|Returned Status Codes|400 - Bad Request |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-a2a-intask-authorization-code.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-a2a-intask-authorization-code.adoc index 45d27e987..e353bb41f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-a2a-intask-authorization-code.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-a2a-intask-authorization-code.adoc @@ -11,6 +11,7 @@ endif::[] >s|Summary | Ensures secondary credentials are present for in-task authentication using OAuth 2.0 Authorization Code flow >s|Category | A2A >s|First Omni Gateway version available | v1.11.4 +>s|Release Notes| xref:release-notes::flex-gateway/policies/a2a-intask-authorization-code-policy-release-notes.adoc[] >s| Returned Status Codes | 200 (authentication challenge), 401 (authentication failure) |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc index b5bee7000..7bdc3af9f 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-api-key.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Injects an API key or client credentials headers into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.10.2 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-api-key-release-notes.adoc[Credential Injection API Key] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-api-key-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc index 92cbe6507..7558b8904 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-lambda.adoc @@ -6,7 +6,7 @@ >s| Summary | Triggers an AWS Lambda function from a standard HTTP request >s| Category | Transformation >s| First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-aws-lambda-release-notes.adoc[AWS Lambda] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-aws-lambda-release-notes.adoc[] .4+>.^s| Returned Status Codes |502 - Bad Gateway, requests are blocked due to circuit breaker activation |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc index 2f154acbb..9f2da49c7 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-aws-signature.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Signs outgoing requests with AWS Signature Version 4 (SigV4) or Signature Version 4A (SigV4A) >s|Category | Security >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-aws-signature-release-notes.adoc[AWS Request Signature] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-aws-signature-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc index ed51456a5..0328f124d 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-basic-auth.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Injects a basic authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-basic-auth-release-notes.adoc[Credential Injection Basic Authentication] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-basic-auth-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc index bd76de61b..c9a4399e2 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-circuit-breaker.adoc @@ -6,7 +6,7 @@ >s| Summary | Prevents an upstream from receiving too many requests or connections >s| Category | Quality of Service >s| First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-circuit-breaker-release-notes.adoc[Circuit Breaker] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-circuit-breaker-release-notes.adoc[] .4+>.^s| Returned Status Codes |503 - Service Unavailable |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc index 20cd02bc8..4d877740b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-jwt-generation.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Generates and injects a JWT token into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.12.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-jwt-generation-release-notes.adoc[Credential Injection JWT Generation] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-jwt-generation-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc index d4f54fec2..333cf4204 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-message-logging.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Logs custom messages from outbound requests sent to upstream services, responses from upstream services, or information from other outbound policies applied to the same upstream service >s|Category | Troubleshooting >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-message-logging-release-notes.adoc[Outbound Message Logging] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-message-logging-release-notes.adoc[] .1+>.^s| Returned Status Codes | No return codes exist for this policy |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc index ceddb907f..86b92981b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth-obo.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Exchanges incoming bearer tokens using OAuth 2.0 Token Exchange (RFC 8693), Microsoft Entra ID On-Behalf-Of, or OAuth 2.0 Token Exchange with CIBA >s|Category | Security >s|First Omni Gateway version available | v1.11.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-oauth-obo-release-notes.adoc[OAuth 2.0 OBO Credential Injection] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-oauth-obo-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc index 4dd5b3f46..089c121d0 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-oauth.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Injects an OAuth 2.0 authorization header into outgoing requests >s|Category | Security >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-oauth-release-notes.adoc[Credential Injection OAuth 2.0] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-oauth-release-notes.adoc[] >s| Returned Status Codes | No return codes exist for this policy. Error codes are returned from the upstream service. |=== diff --git a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc index f14b5bc3d..b60057f8b 100644 --- a/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc +++ b/gateway/1.13/modules/ROOT/pages/policies-outbound-upstream-idle-timeout.adoc @@ -11,7 +11,7 @@ endif::[] >s|Summary | Sets the maximum idle duration for a stream between the Omni Gateway and an upstream service >s|Category | Quality of Service >s|First Omni Gateway version available | v1.9.0 ->s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-upstream-idle-timeout-release-notes.adoc[Stream Idle Timeout] +>s|Release Notes| xref:release-notes::flex-gateway/policies/outbound-upstream-idle-timeout-release-notes.adoc[] ^s| Returned Status Codes | 504 - Upstream request timeout |===