Updated the api to include the latest changes, fixed the id of the api-method-index, moved the index out of the

existing menu as to prevent the other options in the menu from being hidden. Added the options of an enum param
to the docs.
This commit is contained in:
Spencer Alger
2014-01-20 09:25:29 -07:00
parent f5acc5c20e
commit d30cea1db0
7 changed files with 673 additions and 76 deletions

View File

@ -15,7 +15,7 @@ NOTE: This is currently the default API, but with the upcoming release of Elasti
}
// method index%>
[[js-api-method-index]]<%
[[js-api-method-index<%= branchSuffix %>]]<%
actions = _.sortBy(actions, 'namespace');
_.each(actions, function (action) {
action.index = 'api-' + action.name.toLowerCase().replace(/[^\w]+/g, '-') + branchSuffix; %>
@ -46,12 +46,19 @@ The default method is `<%= action.spec.method || 'GET' %>` and the usual <<api-c
_.each(action.allParams, function (param, paramName) { %>
`<%= paramWithDefault(paramName, param.default) %>`::
`<%= paramType(param.type) %>` -- <%= joinParagraphs(param.description || '', 4) %><%
if (param.type === 'enum') {%>
Options:::<%
_.each(param.options, function (opt) {%>
* `"<%= opt %>"`<%
});%>
<%
} // endif enum
}); // endeach %>
}); // endeach param %>
link:#[back to top]<%
} // endif
} // endif size allParams
}); // endeach
%>