added notes to the API docs regarding the two API versions, and a warning to the config docs. Also updated the client tests to work with the new default

This commit is contained in:
Spencer Alger
2014-01-17 15:50:06 -07:00
parent babc7bacea
commit 90aa185711
6 changed files with 51 additions and 15 deletions

View File

@ -1,6 +1,15 @@
[[api-reference<%= branchSuffix %>]]
== <%= branch === 'master' ? '' : branch + ' ' %>API
<%
[[api-reference<%= branchSuffix %>]]<%
if ( branch === 'master' ) {%>
== 1.0 API
NOTE: At this time, you must opt into the 1.0 API by setting the `apiVerion` config parameter.<%
} else {%>
== 0.90 API
NOTE: This is currently the default API, but with the upcoming release of Elasticsearch 1.0 that will change. We recommend setting the `apiVersion` config param when you instantiate your client to make sure that the API does not change when the default does.<%
}
_.each(actions, function (action) {
%>