From 71b71c0f77754113da89220437dbf3d25054094c Mon Sep 17 00:00:00 2001
From: David Ortiz <z.david.ortiz@gmail.com>
Date: Thu, 19 Apr 2018 17:48:51 +0200
Subject: [PATCH 1/2] policy: document in schemas when the order in the chain
matters
Some policies only work properly when placed before or after the Apicast
policy. Others have a different behavior depending on their position with
respect to Apicast in the chain.
---
gateway/src/apicast/policy/cors/apicast-policy.json | 4 +++-
gateway/src/apicast/policy/upstream/apicast-policy.json | 4 +++-
.../src/apicast/policy/url_rewriting/apicast-policy.json | 6 +++++-
3 files changed, 11 insertions(+), 3 deletions(-)
diff --git a/gateway/src/apicast/policy/cors/apicast-policy.json b/gateway/src/apicast/policy/cors/apicast-policy.json
index 0e64f2206..df060b7d9 100644
--- a/gateway/src/apicast/policy/cors/apicast-policy.json
+++ b/gateway/src/apicast/policy/cors/apicast-policy.json
@@ -5,7 +5,9 @@
"description":
["This policy enables CORS (Cross Origin Resource Sharing) request ",
"handling. It allows to define CORS headers such as ",
- "Access-Control-Allow-Headers, Access-Control-Allow-Methods, etc."],
+ "Access-Control-Allow-Headers, Access-Control-Allow-Methods, etc. \n",
+ "When combined with the APIcast policy, the CORS policy should be ",
+ "placed before it in the chain."],
"version": "builtin",
"configuration": {
"type": "object",
diff --git a/gateway/src/apicast/policy/upstream/apicast-policy.json b/gateway/src/apicast/policy/upstream/apicast-policy.json
index 45ffaaea3..dd2681e45 100644
--- a/gateway/src/apicast/policy/upstream/apicast-policy.json
+++ b/gateway/src/apicast/policy/upstream/apicast-policy.json
@@ -5,7 +5,9 @@
"description":
["This policy allows to modify the host of a request based on its path. ",
"It accepts regular expressions that, when matched against the path, ",
- "replace it with a given string."],
+ "replace it with a given string. \n",
+ "When combined with the APIcast policy, the upstream policy should be ",
+ "placed before it in the policy chain"],
"version": "builtin",
"configuration": {
"type": "object",
diff --git a/gateway/src/apicast/policy/url_rewriting/apicast-policy.json b/gateway/src/apicast/policy/url_rewriting/apicast-policy.json
index 9c74a5d0a..1700c5a95 100644
--- a/gateway/src/apicast/policy/url_rewriting/apicast-policy.json
+++ b/gateway/src/apicast/policy/url_rewriting/apicast-policy.json
@@ -7,7 +7,11 @@
"The operations supported are sub and gsub based on ngx.re.sub and ",
"ngx.re.gsub provided by OpenResty. Please check ",
"https://github.com/openresty/lua-nginx-module for more details on how ",
- "to define regular expressions and learn the options supported."],
+ "to define regular expressions and learn the options supported. \n",
+ "When combined with the APIcast policy, if the URL rewriting policy is ",
+ "placed before it in the chain, the APIcast mapping rules will apply to the ",
+ "modified path. If the URL rewriting policy is placed after APIcast in the ",
+ "chain, then the mapping rules will apply to the original path."],
"version": "builtin",
"configuration": {
"type": "object",
From 64e619512d48bb7098710f3fc52e19acd4bd74cb Mon Sep 17 00:00:00 2001
From: David Ortiz <z.david.ortiz@gmail.com>
Date: Thu, 19 Apr 2018 18:19:20 +0200
Subject: [PATCH 2/2] CHANGELOG: add entry for documentation regarding
restrictions in the order of policy chains
---
CHANGELOG.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5f127e909..36ff552b6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
### Added
- Rate Limit policy [PR #648](https://github.com/3scale/apicast/pull/648)
+- [THREESCALE-799](https://issues.jboss.org/browse/THREESCALE-799) Documented restrictions in the position in the chain for some policies [PR #675](https://github.com/3scale/apicast/pull/675)
+
### Changed
- descriptions in `oneOf`s in policy manifests have been replaced with titles [PR #663](https://github.com/3scale/apicast/pull/663)