diff options
| author | Sean McGivern <sean@mcgivern.me.uk> | 2017-04-05 14:37:33 +0000 |
|---|---|---|
| committer | Sean McGivern <sean@mcgivern.me.uk> | 2017-04-05 14:37:33 +0000 |
| commit | 97667b83420cf42b01836d9b0c46d904f55aae21 (patch) | |
| tree | 1af62132e22921656575be3cf2d26e9acccca62b | |
| parent | 32e9e24a89679427804cb15e1b76462bd67f628a (diff) | |
| parent | 3bec61319431725b6b6330824b7cd6e0cfce7b54 (diff) | |
| download | gitlab-ce-97667b83420cf42b01836d9b0c46d904f55aae21.tar.gz | |
Merge branch 'docs-polling-query-params' into 'master'
Document how ETag caching middleware handles query parameters
See merge request !10482
| -rw-r--r-- | doc/development/polling.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/development/polling.md b/doc/development/polling.md index e5a717f712b..4042b8aaa61 100644 --- a/doc/development/polling.md +++ b/doc/development/polling.md @@ -39,6 +39,12 @@ Instead you should use polling mechanism with ETag caching in Redis. 1. If the `If-None-Match` header does not match the current value in Redis we have to generate a new response, because the resource changed. +Do not use query parameters (for example `?scope=all`) for endpoints where you +want to enable ETag caching. The middleware takes into account only the request +path and ignores query parameters. All parameters should be included in the +request path. By doing this we avoid query parameter ordering problems and make +route matching easier. + For more information see: - [RFC 7232](https://tools.ietf.org/html/rfc7232) - [ETag proposal](https://gitlab.com/gitlab-org/gitlab-ce/issues/26926) |