From fab62a82d2b58fbc6cac1c64b2bec4b0053871e2 Mon Sep 17 00:00:00 2001 From: Julian Simioni Date: Tue, 6 Oct 2015 15:44:16 -0400 Subject: [PATCH] Move label description to new notable features section --- response.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/response.md b/response.md index 7f13818..b7a11b3 100644 --- a/response.md +++ b/response.md @@ -19,7 +19,7 @@ The top-level structure to every response looks like this: The `features` property of the result is where you will find the list of results that best matched your input parameters. -Each item in this list will contain all the information needed to identify it in human-readable format in the `properties` block, as well as computer friendly coordinates in the `geometry` property. Note the `label` property, which is a human-friendly representation of the place, ready to be displayed to an end-user. +Each item in this list will contain all the information needed to identify it in human-readable format in the `properties` block, as well as computer friendly coordinates in the `geometry` property. ```json { @@ -53,6 +53,11 @@ Each item in this list will contain all the information needed to identify it in } ``` +## Notable Features + +### Label +The `label` is a human-friendly representation of the place, ready to be displayed to an end user. The label field attempts to use a format that is appropriate for the region the result is in, although we only support a few countries at the moment. + ## Result count By default, Mapzen Search results 10 places, unless otherwise specified. If you want a different number of results, set the `size` parameter to the desired number. This example shows returning only the first result.