temporarily linking to general info for the cat api until aliases specific docs are written
This commit is contained in:
@ -65,7 +65,7 @@ client.cat.aliases([params, [callback]])
|
|||||||
|
|
||||||
// no description
|
// no description
|
||||||
|
|
||||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-aliases.html[the elasticsearch docs] for more about this method.
|
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html[the elasticsearch docs] for more about this method.
|
||||||
|
|
||||||
// no examples
|
// no examples
|
||||||
|
|
||||||
|
|||||||
@ -133,6 +133,10 @@ module.exports = function (branch, done) {
|
|||||||
//camelcase the name
|
//camelcase the name
|
||||||
name = _.map(name.split('.'), _.camelCase).join('.');
|
name = _.map(name.split('.'), _.camelCase).join('.');
|
||||||
|
|
||||||
|
if (name === 'cat.aliases') {
|
||||||
|
def.documentation = 'http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html';
|
||||||
|
}
|
||||||
|
|
||||||
var steps = name.split('.');
|
var steps = name.split('.');
|
||||||
|
|
||||||
function transformParamKeys(note, param, key) {
|
function transformParamKeys(note, param, key) {
|
||||||
|
|||||||
@ -81,7 +81,7 @@ api.cat = function CatNS(transport) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Perform a [cat.aliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-aliases.html) request
|
* Perform a [cat.aliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html) request
|
||||||
*
|
*
|
||||||
* @param {Object} params - An object with parameters used to carry out this action
|
* @param {Object} params - An object with parameters used to carry out this action
|
||||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||||
|
|||||||
Reference in New Issue
Block a user