Skip to content

Latest commit

 

History

History
559 lines (371 loc) · 17.1 KB

CHANGELOG.rst

File metadata and controls

559 lines (371 loc) · 17.1 KB
Raw

Changelog

This document describes changes between each past release.

1.12.0 (unreleased)

  • Nothing changed yet.

1.11.1 (2016-02-01)

Bug fixes

  • Fix wheels for Python 3 that were requiring the functools32 package that is for Python 2 only (fixes #303).

Documentation

  • Fix a broken hyperlink in the overview section. (#406, thanks William Hoang)
  • Talk about tokens rather than user:password (#393)

1.11.0 (2016-01-28)

Protocol

  • Forward slashes (/) are not escaped anymore in JSON responses (mozilla-services/cliquet#537)
  • Fields can be filtered in GET requests using _fields=f1,f2 in querystring (#399)
  • New collections can be created via POST requests (thanks John Giannelos)
  • The API capabilities can be exposed in a capabilities attribute in the root URL (#628). Clients can rely on this to detect optional features on the server (e.g. enabled plugins)

Protocol is now version 1.3. See API changelog.

New features

  • Add a Heroku single-clic deploy button (#362)
  • Install PostgreSQL libraries on kinto init (fixes #313)
  • Smaller Docker container image (#375, #376, #383)
  • Install major plugins in Dockerfile (fixes #317)
  • The policy name used to configure authentication in settings is now used for the user id prefix and StatsD authn_type counters.
  • Check backends configuration at startup (#228)
  • Output message for config file creation (#351, thanks Aditya Basin)
  • Trigger internal event on server flush (#354)

Bug fixes

  • Fix validation of collection id in default bucket (fixes #260)
  • Fix kinto init failure when the config folder already exists (#349)
  • Fix Docker compose startup (fixes #325)
  • Run migrate command when Docker container starts (fixes #363)
  • Fix listener name logging during startup (#626)
  • Do not log batch subrequests twice (#264)
  • Fix hmac digest with Python 3 (#288)
  • Add explicit dependency for functools32 when Kinto is installed with an old pip version (fixes #303)

Documentation

Highlights:

  • Add tutorials about notifications (ref #353)
  • Add tutorial how to write a plugin (#382)
  • Add tutorial how to setup Github authentication (#390)
  • Move default values to dedicated column in docs (fixes #255)
  • Move run-kinto to get-started and remove platform specific installation instructions (#373)

Improved:

  • Update features table in overview
  • Update overview comparisons (#294, #324, #328)
  • Update FAQ (#397, #398)
  • Simplify some aspects of the settings page (#374)
  • Sharding documentation (#381)

Minor:

  • Added missing DELETE endoint for list of records (fixes #238)
  • Mention how to restrict private URLs with NGinx (fixes #250)
  • Fix link to the freenode #kinto channel in the docs (#333)
  • Remove Firefox Account mention from README (fixes #326)
  • Move application examples page to wiki (ref #321)
  • Move PostgreSQL server docs to wiki (fixes #321)
  • Change colors of logo (#359)
  • Add invitation for community to point their demos/use cases (fixes #356)
  • Remove duplicate glossary in docs (#372)
  • Remove troubleshooting paragraph from contributing page (#385)
  • Fix wrong groups name and permissions names in the documentation (#389)
  • Improve formatting of code block in tutorials (#391, #396)

Internal changes

  • Default bucket feature is now a built-in plugin (fixes #277, fixes #311, #380)
  • Do not require cliquet master branch in dev (#341, #400). Now moved as tox env in TravisCI

1.10.1 (2015-12-11)

Bug fixes

  • Fix kinto init when containing folder does not exist (fixes #302)

Internal changes

  • Added Hoodie in the comparison matrix (#282, thanks @Niraj8!)
  • Added a get started button in documentation (#315, thanks @Niraj8!)

1.10.0 (2015-12-01)

Breaking changes

  • When using cliquet-fxa, the setting multiauth.policy.fxa.use must now be explicitly set to cliquet_fxa.authentication.FxAOAuthAuthenticationPolicy
  • Fields in the root view were renamed (mozilla-services/cliquet#600)

Bug fixes

  • Fix redis default host in kinto init (fixes #289)
  • Fix DockerFile with default configuration (fixes #296)
  • Include plugins after setting up components (like authn/authz) so that plugins can register views with permissions checking
  • Remove __permissions__ from impacted records values in ResourceChanged events (mozilla-services/cliquet#586)

Protocol

Changed the naming in the root URL (hello view) (mozilla-services/cliquet#600)

  • Added http_api_version
  • Renamed hello to project_name
  • Renamed protocol_version to cliquet_protocol_version
  • Renamed documentation to project_docs
  • Renamed version to project_version

New features

Internal changes

  • Clarified how Kinto is versionned in the documentation (#305)

1.9.0 (2015-11-18)

  • Upgraded to Cliquet 2.11.0

Breaking changes

  • For PostgreSQL backends, it is recommended to specify postgresql://.

Protocol

  • In the hello view:

    • Add a bucket attribute in user mapping allowing clients to obtain the actual id of their default bucket
    • Add the protocol_version to tell which protocol version is implemented by the service. (#324)

  • _since and _before now accepts an integer value between quotes ", as it would be returned in the ETag response header.

  • A batch request now fails if one of the subrequests fails (mozilla-services/cliquet#510) (see new feature about transactions)

New features

  • Add a Kinto command for start and migrate operation. (#129)
  • Add a Kinto command to create a configuration file. (#278)
  • A transaction now covers the whole request/response cycle (#194). If an error occurs during the request processing, every operation performed is rolled back. Note: This is only enabled with PostgreSQL backends. In other words, the rollback has no effect on backends like Redis or Memory.
  • New settings for backends when using PostgreSQL: *_max_backlog, *_max_overflow, *_pool_recycle, *_pool_timeout to control connections pool behaviour.

Bug fixes

  • Fix 500 error response (instead of 503) when storage backend fails during implicit creation of objects on default bucket. (fixes #236)
  • Fixed Dockerfile for PostgreSQL backends.
  • Fix JSON schema crash when no field information is available.

Internal changes

  • Optimization for obtention of user principals (#263)
  • Do not build the Docker container when using Docker Compose.
  • Add Python 3.5 on TravisCI
  • Add schema validation loadtest (fixes #201)
  • Multiple documentation improvements.
  • The PostgreSQL backends now use SQLAlchemy sessions.

See also *Cliquet* changes

1.8.0 (2015-10-30)

  • Upgraded to Cliquet 2.10.0

Protocol breaking changes

  • Moved userid attribute to a dedicated user mapping in the hello view (#242).

New features

  • Follow redirections in batch subrequests (fixes mozilla-services/cliquet#511)
  • Set cache headers only when anonymous (fixes mozilla-services/cliquet#449)
  • Add a readonly setting to run the service in read-only mode. (#241)
  • If no client cache is set, add Cache-Control: no-cache by default, so that clients are forced to revalidate their cache against the server (ref Kinto#231)

Bug fixes

1.7.0 (2015-10-28)

  • Upgraded to Cliquet 2.9.0
  • Update cliquet-fxa configuration example for cliquet-fxa 1.4.0
  • Improve the documentation to get started

New features

  • Added Pyramid events, triggered when the content of a resource has changed. (#488)
  • Added kinto.includes setting allowing loading of plugins once Kinto is initialized (unlike pyramid.includes). (#504)

Protocol

  • Remove the broken git revision commit field in the hello page. (#495).

Please read the full Cliquet 2.9.0 changelog for more information

1.6.2 (2015-10-22)

Bug fixes

  • Handle 412 details with default bucket (#226)

1.6.1 (2015-10-22)

  • Upgraded to Cliquet 2.8.2

Bug fixes

  • Return a JSON body for 405 response on the default bucket (#214)

Internal changes

  • Improve documentation for new comers (#217)
  • Do not force host in default configuration (#219)
  • Use tox installed in virtualenv (#221)
  • Skip python versions unavailable in tox (#222)

1.6.0 (2015-10-14)

  • Upgraded to Cliquet 2.8.1

Breaking changes

  • Settings prefixed with cliquet. are now deprecated, and should be replaced with non prefixed version instead.
  • In the root url response, public settings are exposed without prefix too (e.g. batch_max_requests).

1.5.1 (2015-10-07)

  • Upgraded to Cliquet 2.7.0

1.5.0 (2015-09-23)

  • Add Disqus comments to documentation (fixes #159)

New features

  • Allow POST to create buckets (fixes #64)
  • Control client cache headers from settings or collection objects (#189)

Internal changes

  • Remove dead code (#187, ref #53)
  • Add pytest-capturelog for better output on test failures (#191)
  • Install cliquet middleware (no-op if disabled) (#193)
  • Many optimizations on default bucket (#192, #197)
  • Many optimizations on number of storage hits (#203)
  • Fix contributing docs about tests (#198)
  • Added more batched actions to loadtests (#199)

1.4.0 (2015-09-04)

New features

  • Partial collection of records when user has no read permission on collection (fixes #76). Alice can now obtain a list of Bob records on which she has individual read permission!
  • Collection can now specify a JSON schema and validate its records (#31). The feature is marked as experimental and should be explicitly enabled from settings (#181)
  • Accept empty payload on buckets and collections creation (#63)
  • Allow underscores in Kinto bucket and collection names (#153, fixes #77)
  • Collection records can now be filtered using multiple values (?in_status=1,2,3) (mozilla-services/cliquet#39)
  • Collection records can now be filtered excluding multiple values (?exclude_status=1,2,3) (mozilla-services/readinglist#68)
  • Current userid is now provided when requesting the hello endpoint with an Authorization header (mozilla-services/cliquet#319)
  • UUID validation now accepts any kind of UUID, not just v4 (mozilla-services/cliquet#387)
  • Querystring parameter _to on collection records was renamed to _before (the former is now deprecated) (mozilla-services/cliquet#391)
  • Allow to configure info link in error responses with cliquet.error_info_link setting (mozilla-services/cliquet#395)

Bug fixes

  • Fix consistency in API to modify permissions with PATCH (fixes #155) The list of principals for each specified permission is now replaced by the one provided.
  • Use correct HTTP Headers encoding in both Python2 and Python3 (#141)
  • ETag is now returned on every verb (fixes #110)

Internal changes

  • When deleting a collection also remove the records tombstones (#136)
  • Complete revamp of the documentation (#156 #167 #168 #169 #170)
  • Upgraded to Cliquet 2.6.0

1.3.1 (2015-07-15)

  • Upgraded to Cliquet 2.3.1

Bug fixes

  • Make sure the default route only catch /buckets/default and /buckets/default/* routes. (#131)

1.3.0 (2015-07-13)

  • Upgraded to Cliquet 2.3.0

Bug fixes

  • Handle CORS with the default bucket. (#126, #135)
  • Add a test to make sure the tutorial works. (#118)

Internal changes

  • List StatsD counters and timers in documentation (fixes #73)
  • Update virtualenv dependencies on setup.py modification (fixes #130)

1.2.1 (2015-07-08)

  • Upgraded to Cliquet 2.2.1

Bug fixes

  • Improvements and fixes in the tutorial (#107)
  • Querystring handling when using the personal bucket (#119)
  • Default buckets ID is now a UUID with dashes (#120)
  • Handle unknown permission and fix crash on /buckets (#88)
  • Fix permissions handling on PATCH /resource (mozilla-services/cliquet#358)

Internal changes

  • Test with the normal Kinto authentication policy and remove the fake one (#121)

1.2.0 (2015-07-03)

  • Upgraded to Cliquet 2.2.+

New features

  • Add the personal bucket /buckets/default, where collections are created implicitly (#71)
  • Kinto now uses the memory backend by default, which simplifies its usage for development (#86, #95)
  • Add public settings in hello view (mozilla-services/cliquet#318)

Bug fixes

Internal changes

  • Documentation improvements (#75)
  • Added tutorial (#79)
  • Remove hard dependency on PostgreSQL (#100)
  • Add pytest-cache (#98)
  • Add Pypy test on Travis (#99)
  • Update dependencies on make install (#97)
  • Fix URL of readthedocs.org (#90)

1.1.0 (2015-06-29)

New features

  • Polish default kinto configuration and default to memory backend. (#81)
  • Add the kinto group finder (#78)
  • Flush endpoint now returns 404 is disabled (instead of 405) (#82)

Bug fixes

  • ETag not updated on collection update (#80)

Internal changes

  • Use py.test to run tests instead of nose (#85)

1.0.0 (2015-06-17)

New features

  • Added notion of buckets, user groups and collections (#48, #58)
  • Buckets, collections and records can now have permissions (#59)

Breaking changes

  • Updated Cliquet to 2.0, which introduces a lot of breaking changes (see changelog)
  • Firefox Accounts is not a dependency anymore and should be installed and included explictly using the python package cliquet-fxa (see documentation)
  • API is now served under /v1
  • Collections are now managed by bucket, and not by user anymore (#44)

Note

A list of records cannot be manipulated until its parents objects (bucket and collection) are created.

Settings

Internal changes

  • Added documentation about deployment and data durability (#50)
  • Added load tests (#30)
  • Several improvements in documentation (#51)

0.2.2 (2015-06-04)

  • Upgraded to cliquet 1.8.+

Breaking changes

  • PostgreSQL database initialization process is not run automatically in production. Add this command to deployment procedure:
cliquet --ini config/kinto.ini migrate

Internal changes

  • Improved documentation (#29)
  • Require 100% coverage during tests (#27)
  • Basic Auth is now enabled by default in example config

0.2.1 (2015-03-25)

  • Upgraded to cliquet 1.4.1

Bug fixes

  • Rely on Pyramid API to build pagination Next-Url (#147)

0.2 (2015-03-24)

  • Upgraded to cliquet 1.4

Bug fixes

0.1 (2015-03-20)

Initial version

  • Schemaless storage of records
  • Firefox Account authentication
  • Kinto as a storage backend for cliquet applications