Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.rst

Kinto Changes

https://coveralls.io/repos/Kinto/kinto-changes/badge.svg?branch=master

kinto-changes shows the list of collection timestamps, allowing to poll changes on several collections with one HTTP request.

Install

pip install kinto-changes

Setup

In the Kinto settings:

kinto.includes = kinto_changes

# List of buckets/collections to show:
kinto.changes.resources = /buckets/settings
                          /buckets/blocklists/collections/certificates

Cache Control

Like cache control in Kinto collections, it is possible to configure Cache-Control headers via some settings:

kinto.monitor.changes.record_cache_expires_seconds = 60

If cache busting query parameters then responses can be cached more agressively. If the setting below is set then a different cache control expiration will be set:

kinto.monitor.changes.record_cache_maximum_expires_seconds = 3600

Advanced options

The changes entries will have a host attribute, that can be used to distinguish changes from several Kinto instances.

kinto.changes.http_host = website.domain.tld

By default, it will rely on the global setting kinto.http_host.

Endpoints

  • GET /v1/buckets/monitor/collections/changes/records.

Returns the list of timestamps.

  • GET /v1/buckets/{bid}/collections/{cid}/changeset?_expected={timestamp}.

Returns the following response for the collection:

  • changes: list of records, optionnally filtered with ?_since="{timestamp}"
  • metadata: collection attributes
  • timestamp: records timestamp

Note: the _expected={} querystring parameter is mandatory but can contain any arbitrary value (used for cache busting).

About

Gather timestamps of several collections into one to optimize server polling

Resources

License

Packages

No packages published
You can’t perform that action at this time.