diff --git a/docs/changelog.asciidoc b/docs/changelog.asciidoc new file mode 100644 index 000000000..f5cf4b4e4 --- /dev/null +++ b/docs/changelog.asciidoc @@ -0,0 +1,133 @@ +[[changelog]] +== Changelog + +=== 12.0 (Oct 26 2016) + * apiVersion `"5.0"` is now the default + +=== 11.0 (Apr 5 2016) + * apiVersion `"2.3"` is now the default + * updated APIs, to use the new API's exposed by the `v5.0.0-alpha1` of elasticsearch use the `"master"` api version. + * Switch to https://www.npmjs.com/package/promise[promise] from https://www.npmjs.com/package/promise-js[promise-js] to prevent polluting global environment + * Pass the keepAlive configuration all the way to the Agent https://github.com/elastic/elasticsearch-js/pull/371[#371] + +=== 10.1 (Jan 8 2016) + * browser builds now include the "unstable" api's from elasticsearch + * added `createNodeAgent` configuration value for overriding the agent that the node.js HttpConnector uses. (see https://github.com/elastic/elasticsearch-js/pull/329[#329]) + * fix a bug that could cause error statuses to be strings rather than numbers + * doc fixes + * support sniffing nodes that have published hostnames + * error logging now includes information about the request where the error occured https://github.com/elastic/elasticsearch-js/pull/330[#330] + +=== 10.0 (Nov 24 2015) + * apiVersion `"2.1"` is now the default + * Remove `bluebird` dependency, use an ES6 Promise shim instead. To use Bluebird in your project supply the <> configuration option. + +=== 9.0 (Oct 30 2015) + * apiVersion `"2.0"` is now the default + * Fix a memory leak caused by sniffing + * Use the `application/x-ldjson` content-type for bulk formatted bodies + * Added `wwwAuthenticateDirective` property to `401` errors + +=== 8.2 (Sep 17 2015) + * Added <> configuration option + * Fixed an issue which prevented promised from getting rejected if the `GET` verb was used with a request body (https://github.com/elastic/elasticsearch-js/issues/263[#263]) + +=== 8.1 (Sep 8 2015) + * Added apiVersion `"2.x"`, which will semi-regularly be updated to match the latest development at https://github.com/elastic/elasticsearch/tree/2.x[elastic/elasticsearch#2.x] + * Removed node engine upper-bound, supporting 4.0 and versions beyond. + +=== 8.0 (Aug 26 2015) + * apiVersion changed back to `"1.7"` until es 2.0 is actually released. + +=== **unpublished** 7.0 (Aug 26 2015) + * Added apiVersion `"2.0"`, which is now the default + +=== 6.1 (Aug 18 2015) + * Added experimental support for apiVersion `"2.0"` + * Added support for https://github.com/elastic/elasticsearch-js/blob/ea6721127fb239951fb86ac3b386e182b26f683c/src/lib/errors.js#L94-L138[many more status codes] so that "unknown error" is far less likely. + +=== 6.0 (Aug 4 2015) + * Added apiVersion `"1.7"`, which is now the default + * Error objects resulting from a completed http request now have much more information about the request that caused them. + +=== 5.0 (Jun 9 2015) + * Added apiVersion `"1.6"`, which is now the default + +=== 4.1 (May 19 2015) + * Plugin configuration option added + * Added support for object based error + +=== 4.0 (Mar 26 2015) + * Added apiVersion `"1.5"`, which is now the default + * Changed the default pingTimeout to 3 seconds, and made it configurable + * Improved compatibility with node 0.12 + * Updated dependencies + * Make the stream logger actually usable (thanks @falmp!) + +=== 3.1 (Jan 6 2015) + * Added HTTPS/SSL configuration options and related errors + * `client.scroll()` requests made without a body will use the `scrollId` param as the body to prevent #113 & #174 + * Updated bluebird to `v2.8.2` - https://github.com/petkaantonov/bluebird/blob/master/changelog.md[bluebird changelog] + * Added specific error message for 504 errors https://github.com/elastic/elasticsearch-js/pull/182[#182] + +=== 3.0 (Nov 7 2014) + * Added apiVersion `"1.4"`, which is now the default + * Improved parsing of `host:` strings, https://github.com/elastic/elasticsearch-js/blob/165b7d7986b2184b2e4b73d33bf5803e61ce7a54/test/unit/specs/host.js#L71-L92[examples in the tests] + * The Angular version of the client now uses `angular.toJson()` (https://code.angularjs.org/1.2.27/docs/api/ng/function/angular.toJson[1.2], https://code.angularjs.org/1.3.5/docs/api/ng/function/angular.toJson[1.3]) to serialize requests, override with `serializer: "json"` + * Angular requests are now being https://github.com/elastic/elasticsearch-js/commit/4c106967d3e9ae208fae42ce013f0a21e1ace021[aborted properly] + +=== 2.4 (Jul 30 2014) + * Added apiVersion `"1.3"`, which is now the default + * Angular connector (when used with Basic Auth) no longer modifies Angular's default headers + +=== 2.3 (Jul 11 2014) + * Added support for Node 0.11 + * Updated `bluebird`, which modified the https://github.com/petkaantonov/bluebird/blob/v2.2.1/API.md[promise api] somewhat + * moved the log generator into it's own package https://www.npmjs.org/package/makelogs[makelogs] + * https://github.com/elastic/elasticsearch-js/pull/122[Lower the logging level of `Request complete`] + +=== 2.2 (Mar 27 2014) + * The default API version is now `'1.2'` + * Node clinet now supports master, 1.x, 1.2, 1.1, 1.0, and 0.90 + * Browser client now supports versions 1.0, 1.1, and 1.2 + +=== 2.1 (Mar 27 2014) + * The default API version is now `'1.1'` + * Errors generated in the browser will now have stack traces + * Clarified IE-support + * Improvements to the bundled log-generator + +=== 2.0 (Mar 27 2014) + * The default API version is now `'1.0'` + * Promises are now supported using the Bluebird module + * If you try to reuse a configuration object, an error will be thrown. https://github.com/elastic/elasticsearch-js/issues/33 + +=== 1.5 (Feb 6 2014) + * Switched out `keepaliveagent` dependency with `forever-agent`, which is used in the ever popular `request` module, and is much simpler + * The option to use keep-alive is now all or nothing. `maxKeepAliveTime` and `maxKeepAliveRequests` config parameters have been replaced by `keepAlive`, which will keeps at least `minSockets` connections open forever. See: http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/configuration.html + * Closing the client with `keepAlive` turned on will allow the process to exit. https://github.com/elastic/elasticsearch-js/issues/40 + * Fixed a bug that caused invalid param/type errors to not be reported properly, in the browser builds that use promises + * added the cat.threadPool to the master/1.0/1.x apis + * Enabled Basic auth in the Angular connector -- Thanks @jeff-french! + * Fixed a bug that was preventing index requests (and any other POST/PUT request) from using connections in the connection pool + +=== 1.4 (Jan 30 2014) + * The trace log messages will now diaplay the actual host connected to (without auth info) unless they are being written to a bash script + * API Updated with latest changes awaiting 1.0 release + +=== 1.2/1.3 (Jan 17 2014) + * `apiVersion` config parameter was added. Use this to specify which API the client should provide, we currently offer support for elasticsearch branches "0.90", "1.0", and "master" + + +=== 1.1 (Dec 22 2013) + * Changed the resolution value of promises. Instead of being an object like `{body: ..., status: ...}` it is now + just the response body + + +=== 1.0 (Dec 17 2013) + * Initial Release + + +=== pre 1.0 + * Another module, now know as es on npm, used the elasticsearch module name. This module had several pre-1.0 + releases so we started at 1.0 to prevent collisions in exiting projects. The history for that project is available https://github.com/ncb000gt/node-es[here] diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 2aca64db9..18594062e 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -50,6 +50,8 @@ include::api_methods_1_0.asciidoc[] include::api_methods_0_90.asciidoc[] +include::changelog.asciidoc[] + include::host.asciidoc[] include::transport.asciidoc[] diff --git a/scripts/generate/templates/docs_index.tmpl b/scripts/generate/templates/docs_index.tmpl index fd1c0a7e1..bad7fb953 100644 --- a/scripts/generate/templates/docs_index.tmpl +++ b/scripts/generate/templates/docs_index.tmpl @@ -29,6 +29,8 @@ apiFiles.forEach(function (file, i) { }); %> +include::changelog.asciidoc[] + include::host.asciidoc[] include::transport.asciidoc[] diff --git a/src/lib/apis/master.js b/src/lib/apis/master.js index afcc5fa23..c6e4ca7d9 100644 --- a/src/lib/apis/master.js +++ b/src/lib/apis/master.js @@ -2691,33 +2691,12 @@ api.indices = namespace(); * Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {String} params.analyzer - The name of the analyzer to use - * @param {String, String[], Boolean} params.charFilter - A comma-separated list of character filters to use for the analysis - * @param {String} params.field - Use the analyzer configured for this field (instead of passing the analyzer name) - * @param {String, String[], Boolean} params.filter - A comma-separated list of filters to use for the analysis * @param {String} params.index - The name of the index to scope the operation * @param {Boolean} params.preferLocal - With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true) - * @param {String, String[], Boolean} params.text - The text on which the analysis should be performed (when request body is not used) - * @param {String} params.tokenizer - The name of the tokenizer to use for the analysis - * @param {Boolean} params.explain - With `true`, outputs more advanced details. (default: false) - * @param {String, String[], Boolean} params.attributes - A comma-separated list of token attributes to output, this parameter works only with `explain=true` * @param {String} [params.format=detailed] - Format of the output */ api.indices.prototype.analyze = ca({ params: { - analyzer: { - type: 'string' - }, - charFilter: { - type: 'list', - name: 'char_filter' - }, - field: { - type: 'string' - }, - filter: { - type: 'list' - }, index: { type: 'string' }, @@ -2725,18 +2704,6 @@ api.indices.prototype.analyze = ca({ type: 'boolean', name: 'prefer_local' }, - text: { - type: 'list' - }, - tokenizer: { - type: 'string' - }, - explain: { - type: 'boolean' - }, - attributes: { - type: 'list' - }, format: { type: 'enum', 'default': 'detailed',