From ce79b9ddc60e2c01d5c39d4ad4616d829d3e1dd5 Mon Sep 17 00:00:00 2001 From: "Peter Johnson a.k.a. insertcoffee" Date: Tue, 2 Dec 2014 17:55:14 +0000 Subject: [PATCH] [docs] formatting and general pedantry I'm not sure if the `distance-units` section is totally clear, when using the 'Geohash Cell Filter' and omitting a unit, the default is to interpret the integer as the 'length of the geohash prefix', not to default it to 'meter'. Maybe I'm being pedantic. --- docs/reference/api-conventions.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/api-conventions.asciidoc b/docs/reference/api-conventions.asciidoc index 10d9b6cc0a851..374f9a04937ae 100644 --- a/docs/reference/api-conventions.asciidoc +++ b/docs/reference/api-conventions.asciidoc @@ -68,7 +68,7 @@ The following options can be applied to all of the REST APIs. When appending `?pretty=true` to any request made, the JSON returned will be pretty formatted (use it for debugging only!). Another option is -to set `format=yaml` which will cause the result to be returned in the +to set `?format=yaml` which will cause the result to be returned in the (sometimes) more readable yaml format. @@ -77,7 +77,7 @@ to set `format=yaml` which will cause the result to be returned in the Statistics are returned in a format suitable for humans (eg `"exists_time": "1h"` or `"size": "1kb"`) and for computers -(eg `"exists_time_in_millis": 3600000`` or `"size_in_bytes": 1024`). +(eg `"exists_time_in_millis": 3600000` or `"size_in_bytes": 1024`). The human readable values can be turned off by adding `?human=false` to the query string. This makes sense when the stats results are being consumed by a monitoring tool, rather than intended for human @@ -88,7 +88,7 @@ consumption. The default for the `human` flag is === Flat Settings The `flat_settings` flag affects rendering of the lists of settings. When -flat_settings` flag is `true` settings are returned in a flat format: +`flat_settings` flag is `true` settings are returned in a flat format: [source,js] --------------------------------------------------