Browse Source

update api comments for search_api

pull/2/merge
Brett Langdon 13 years ago
parent
commit
65d89016b5
1 changed files with 10 additions and 0 deletions
  1. +10
    -0
      lib/api/search.js

+ 10
- 0
lib/api/search.js View File

@ -1,5 +1,15 @@
var search_api = function(){}; var search_api = function(){};
search_api.prototype.search = function(query, callback){ search_api.prototype.search = function(query, callback){
/*
* search_api.search(query, [callback])
*
* method used to query the api for `metrics` or `hosts`
*
* `query` the query to use to search the datadog service
*
* `callback` an optional function called with the results of the search
* callback(error, result, status_code)
*/
this.request('GET', '/search', {query: {'q': query}}, callback); this.request('GET', '/search', {query: {'q': query}}, callback);
}; };


Loading…
Cancel
Save