diff --git a/docs/transport.asciidoc b/docs/transport.asciidoc index 8901ef251..5939ad5b8 100644 --- a/docs/transport.asciidoc +++ b/docs/transport.asciidoc @@ -11,9 +11,6 @@ `query`:: `Object` -- The query string params -`path`:: -`Object` -- The query string params - `ignore`:: `Number, Number[]` -- HTTP status codes which should not be treated as errors diff --git a/src/lib/transport.js b/src/lib/transport.js index 7a8b943e8..fca15912d 100644 --- a/src/lib/transport.js +++ b/src/lib/transport.js @@ -122,9 +122,10 @@ Transport.prototype.defer = function () { * @todo access to custom headers, modifying of request in general * @param {object} params * @param {Number} params.requestTimeout - timeout for the entire request (inculding all retries) - * @param {Number} params.maxRetries - number of times the request will be re-run in - * the original node chosen can not be connected to. - * @param {String} params.url - The url for the request + * @param {Number} params.maxRetries - number of times to re-run request if the + * original node chosen can not be connected to. + * @param {string} [params.path="/"] - URL pathname. Do not include query string. + * @param {string|object} [params.query] - Query string. * @param {String} params.method - The HTTP method for the request * @param {String} params.body - The body of the HTTP request * @param {Function} cb - A function to call back with (error, responseBody, responseStatus)