Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[THREESCALE-799] policy: document in schemas when the order in the chain matters #675

Merged
merged 2 commits into from
Apr 23, 2018
Merged

[THREESCALE-799] policy: document in schemas when the order in the chain matters #675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71b71c0
policy: document in schemas when the order in the chain matters
davidor Apr 19, 2018
64e6195
CHANGELOG: add entry for documentation regarding restrictions in the …
davidor Apr 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 3 additions & 1 deletion gateway/src/apicast/policy/cors/apicast-policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 3 additions & 1 deletion gateway/src/apicast/policy/upstream/apicast-policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 5 additions & 1 deletion gateway/src/apicast/policy/url_rewriting/apicast-policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down