Skip to content

Commit

Permalink
Doc: Fix services filter parameter.
Browse files Browse the repository at this point in the history
Make it clear to users what URL is used discarded.

Fix THREESCALE-5421

Signed-off-by: Eloy Coto <eloy.coto@acalustra.com>
  • Loading branch information
eloycoto committed Oct 14, 2020
1 parent 25418f4 commit b0608c3
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 10 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ with many services might have experienced issues with this policy because the
size of those dictionaries was not enough to store everything the policy needs
to function correctly. [PR #1231](https://github.com/3scale/APIcast/pull/1231)
- Fixed issue with Camel service over HTTPs when Routing Policy [PR #1230](https://github.com/3scale/APIcast/pull/1230) [THREESCALE-5891](https://issues.redhat.com/browse/THREESCALE-5891)
- Fixed doc issue on SERVICES_FILTER parameter [PR #1233](https://github.com/3scale/APIcast/pull/1233) [THREESCALE-5421](https://issues.redhat.com/browse/THREESCALE-5421)



Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ node_modules/.bin/markdown-link-check:
yarn install

test-doc: node_modules/.bin/markdown-link-check
@find . \( -name node_modules -o -name .git -o -name t \) -prune -o -name "*.md" -print0 | xargs -0 -n1 -I % sh -c 'echo; echo ====================; echo Checking: %; node_modules/.bin/markdown-link-check %' \;
@find . \( -name node_modules -o -name .git -o -name t \) -prune -o -name "*.md" -print0 | xargs -0 -n1 -I % sh -c 'echo; echo ====================; echo Checking: %; node_modules/.bin/markdown-link-check -q --config travis/config.json %' \;

benchmark: export IMAGE_TAG ?= master
benchmark: export COMPOSE_FILE ?= docker-compose.benchmark.yml
Expand Down
18 changes: 9 additions & 9 deletions doc/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,22 +232,22 @@ Find more information about the Response Codes feature on the [3scale support si
**Example:** .*.example.com

Used to filter the service configured in the 3scale API Manager, the filter
matches with the public base URL. Services that do not match the filter will be
discarded. If the regular expression cannot be compiled no services will be
loaded.
matches with the public base URL (Staging or production). Services that do not
match the filter will be discarded. If the regular expression cannot be compiled
no services will be loaded.

Note: If a service does not match, but is included in the
`APICAST_SERVICES_LIST`, service will not be discarded

Example:

Regexp Filter: http:\/\/.*.google.com
Service 1: backend endpoint http://www.google.com
Service 2: backend endpoint http://www.yahoo.com
Service 3: backend endpoint http://mail.google.com
Service 4: backend endpoint http://mail.yahoo.com
Regexp Filter: http:\/\/.*.api.foo
Service 1: backend endpoint http://www.api.foo
Service 2: backend endpoint http://www.api.bar
Service 3: backend endpoint http://mail.api.foo
Service 4: backend endpoint http://mail.api.bar

The services that will be configured in Apicast will be 1 and 3. Services 2 and
The services that will be configured in APIcast will be 1 and 3. Services 2 and
4 will be discarded.

### `APICAST_SERVICES_LIST`
Expand Down
10 changes: 10 additions & 0 deletions travis/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"ignorePatterns": [
{
"pattern": "^.*.foo"
},
{
"pattern": "^.*.bar"
}
]
}

0 comments on commit b0608c3

Please sign in to comment.