habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated the API, fixed the config docs, added a method list to the API pages

Browse Source
This commit is contained in:
Spencer Alger
2014-01-19 12:48:44 -07:00
parent 54beb73c0b
commit 149b099fb5
9 changed files with 3582 additions and 3131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
scripts/generate/templates/api_methods.tmpl
View File

@ -3,17 +3,29 @@
if ( branch === 'master' ) {%>
== 1.0 API
NOTE: At this time, you must opt into the 1.0 API by setting the `apiVerion` config parameter.<%
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.<%
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.
<%
}
// method index%>
[[js-api-method-index]]<%
actions = _.sortBy(actions, 'namespace');
_.each(actions, function (action) {
action.index = 'api-' + action.name.toLowerCase().replace(/[^\w]+/g, '-') + branchSuffix; %>
* <%= '<<' + action.index + ',' + action.name + '>>' %><%
})
_.each(actions, function (action) {
%>
[[<%= 'api-' + action.name.toLowerCase().replace(/[^\w]+/g, '-') + branchSuffix %>]]
[[<%= action.index %>]]
=== `<%= action.name %>`
[source,js]
@ -35,7 +47,10 @@ _.each(action.allParams, function (param, paramName) { %>
`<%= paramWithDefault(paramName, param.default) %>`::
`<%= paramType(param.type) %>` -- <%= joinParagraphs(param.description || '', 4) %><%
}); // endeach
}); // endeach %>
link:#[back to top]<%
} // endif
}); // endeach