Release 1.0.0

[scottinet]

1.0.0 (2017-06-20)

Compatibility

Kuzzle	Proxy
1.0.0	1.0.0

Breaking changes

• [ #257 ] Migrate documentation to metalsmith (stafyniaksacha)
• [ #215 ] Document the refactor of authentication plugins (dbengsch)
• [ #189 ] Rename metadata into volatile (AnthonySendra)

Bug fixes

• [ #289 ] Fix credentials exemple in security (jenow)
• [ #279 ] Display ms/zinterstore code example properly (dbengsch)
• [ #271 ] Fix the expected return value of authentication plugins "verify" function (dbengsch)
• [ #272 ] Fix the HTTP URL of the collection/create API route (dbengsch)
• [ #274 ] Response section was not displayed properly in code section as expected in bulk/import (dbengsch)
• [ #275 ] Error section was not displayed properly in code section as expected in collection/getSpecification (dbengsch)
• [ #276 ] Scroll examples have a bad structure in API documentation (dbengsch)
• [ #278 ] The code example in ms/geopos is not typed properly (dbengsch)
• [ #235 ] Fix broken link in manual install documentation (scottinet)

New features

• [ #264 ] Added docs for new routes in Security, Collection & Document (samniisan)
• [ #265 ] Documentation about getStrategies route (jenow)
• [ #261 ] New credentials related functions (jenow)
• [ #177 ] Document new scroll methods (scottinet)
• [ #163 ] Document the storage accessor in the pluginContext (dbengsch)

Enhancements

• [ #310 ] Introduction and enhancement of the data validation section (dbengsch)
• [ #307 ] Move kuzzle event to a new doc section (dbengsch)
• [ #281 ] Replace JSONArray with native Arrays for arguments and returned values (scottinet)
• [ #288 ] Add a user authentication guide (scottinet)
• [ #266 ] Update user.getProfiles documentation and add user.getProfileIds (scottinet)
• [ #258 ] SDK "error" event has been renamed "networkError" (scottinet)
• [ #237 ] Add plugin install details on manual install (stafyniaksacha)
• [ #236 ] Add 64-bit environment as a Kuzzle prerequisite (scottinet)
• [ #234 ] Document submodule install when installing Kuzzle manually (scottinet)
• [ #233 ] Update CLI documentation (scottinet)
• [ #221 ] Document the "log:xxx" events (scottinet)
• [ #223 ] Document how to handle errors from SDK methods (scottinet)
• [ #225 ] SDK Reference: make returned instantiated objects point to their related documentation (scottinet)
• [ #199 ] Adapt verify arguments documentation (dbengsch)
• [ #168 ] Document the new ExternalServiceError object (scottinet)
• [ #171 ] Document the new "retryOnConflict" option (scottinet)
• [ #173 ] Document "origin" and "previous" Request properties (scottinet)
• [ #180 ] Update plugin documentation with new strategy registration method (scottinet)
• [ #169 ] Document the new request:onUnauthorized event (scottinet)
• [ #149 ] Upgrade the elasticsearch to version 5 in documentation (dbengsch)
• [ #160 ] Update server:getconfig documentation (scottinet)
• [ #161 ] Change payload of 'add subscription' core event ------ resolve #159 (stafyniaksacha)
• [ #155 ] Improve title structuration of validation reference (dbengsch)
• [ #145 ] Improve the Guide's validation documentation (dbengsch)
• [ #144 ] Add documentation for the kuzzle metadatas usage (dbengsch)

Others

• [ #305 ] Add a guide chapter about why document ids are separated from their contents (scottinet)
• [ #304 ] Add explanations to the API notifications documentation (scottinet)
• [ #301 ] Document auth:strategyAuthenticated pipe event (ballinette)
• [ #297 ] Add documentation for specification routes in SDK (samniisan)
• [ #302 ] Remove obsolete "proxy:" events (scottinet)
• [ #303 ] Add documentation about event on error (AnthonySendra)
• [ #295 ] Document PreconditionError error object (scottinet)
• [ #294 ] Add response example (empty result) for controller auth/logout (ballinette)
• [ #290 ] Added refresh option in Collection:truncate (samniisan)
• [ #287 ] Remove Collection.fetchAllDocuments (benoitvidis)
• [ #285 ] Add example to the Profile.getPolicies() method (scottinet)
• [ #286 ] Update the API "login" action documentation (scottinet)
• [ #282 ] Update index/create return value (ballinette)
• [ #284 ] Update search code sample in SDK (ballinette)
• [ #283 ] Remove unnecessary mention to Elasticsearch version (ballinette)
• [ #270 ] Update protocol plugin context description (ballinette)
• [ #277 ] Bad alignment in collection/*Specification examples (dbengsch)
• [ #260 ] Added instructions to install Kuzzle via the setup.sh script (xbill82)
• [ #226 ] Document getById and SDK adaptation of auth refactor (dbengsch)
• [ #232 ] Fix closure example in the guide (dbengsch)
• [ #172 ] SDK: change addListener signature (ballinette)
• [ #212 ] Update internalBroker arguments (stafyniaksacha)
• [ #209 ] Fix 138 partial errors (benoitvidis)
• [ #202 ] Proxy logs configuration (benoitvidis)
• [ #191 ] Fix some nitpicking issues and missing docs (ballinette)
• [ #190 ] Remove the route security:createOrReplaceUser (dbengsch)
• [ #179 ] Fix typos (ballinette)
• [ #139 ] Document the SearchResult object (dbengsch)
• [ #136 ] SDK Reference: memory storage full documentation (scottinet)
• [ #140 ] Document the query string argument scroll in search HTTP API (dbengsch)
• [ #134 ] Add a new Mapping section under Essentials/persisted (dbengsch)
• [ #125 ] Improve search and scroll documentation about the scroll feature (dbengsch)
• [ #118 ] Upgrade documentation to fit the multiple right refactors (dbengsch)
• [ #135 ] Add list of supported operating systems (dbengsch)
• [ #133 ] Fix dead links in the Essential introduction (dbengsch)
• [ #129 ] Specify version needed of the prerequisites; correct the Debian-based sentence (dbengsch)
• [ #128 ] Add documentation about subscribe options (dbengsch)
• [ #127 ] Add the scroll method documentation; document the argument 'scroll' in search (dbengsch)
• [ #126 ] Align mDelete* routes in security to add an 's' to each action names (dbengsch)
• [ #124 ] Document the Kuzzle.createIndex method (dbengsch)
• [ #123 ] Kuzzle.query example referred to the removed 'read' controller (dbengsch)
• [ #121 ] Use roles instead of policies as argument for searchProfiles (dbengsch)
• [ #120 ] Upgrade right examples in 'Essentials/Security/Permissions' section alongside Kuzzle refactors (dbengsch)
• [ #115 ] Remove the profileIds field from the request examples of the security/createFirstAdmin route (dbengsch)
• [ #109 ] [plugins] new role & profile core events (ballinette)
• [ #114 ] Fix duplicate menu entries (scottinet)
• [ #119 ] Precise description on how to set roles on a controller declared by a Plugin (xbill82)
• [ #108 ] Detailed documentation of the memoryStorage controller (scottinet)
• [ #105 ] Event discard handling (AnthonySendra)
• [ #104 ] Document new request:on* events (scottinet)
• [ #89 ] Document events triggered by controllers added plugins (scottinet)
• [ #91 ] Remove obsolete documentation file (scottinet)
• [ #92 ] Add a list of useful commands to the install guide (scottinet)
• [ #93 ] Rename the "updateIfExist" option for the createDocument method (scottinet)
• [ #96 ] Fix erroneous auth:login options description (scottinet)
• [ #97 ] Fix outdated PM2 configuration (scottinet)
• [ #98 ] Fix document:deleteByQuery documentation (scottinet)
• [ #100 ] Document arguments provided to callbacks listening to events (scottinet)
• [ #102 ] Plugin context documentation improvement (scottinet)
• [ #95 ] Plugins documentation improvement and add missing plugins options (scottinet)

Securities

• [ #219 ] Changed createUser's user object definition (jenow)

---