Mauricio Scheffer
66832cf0a5
docs: fix links to rank docs
2022-09-05 11:11:13 +01:00
Kian-Meng Ang
f5e52e748f
docs: fix typos
2022-07-20 22:05:31 +08:00
Stef Ki
b803505402
Typos and syntax on Reverse.md
2022-06-17 21:01:38 +02:00
Sarah Hoffmann
310776671b
adapt docs to geocodejson changes
2022-04-27 11:50:12 +02:00
Sarah Hoffmann
a319b0a0b4
docs: different default for format on osm.org
...
Add a note that the format parameter is needed for
nominatim.openstreetmap.org for historical reasons.
2022-04-08 17:13:42 +02:00
Artem Ziablytskyi
d1479072ae
fix bdd tests and docs
2022-04-07 16:37:51 +02:00
Artem Ziablytskyi
9a56e53d50
use ISO3166-2-lvl<admin_level> instead of typeLabel prefix
2022-04-07 16:37:51 +02:00
Artem Ziablytskyi
665fae8343
Fix API docs and Vagrant instructions to import data
2022-04-07 16:37:51 +02:00
Artem Ziablytskyi
6bee188f24
Change the key to <addresspart_type>-ISO3166-2 to support xml response correctly
2022-04-07 16:37:51 +02:00
Artem Ziablytskyi
82dbcbb12a
add <addresspart_type>:ISO3166-2 field to response address details
2022-04-07 16:37:51 +02:00
Artem Ziablytskyi
76c146f326
add state_code field to response address details
2022-04-07 16:37:51 +02:00
Marc Tobias
5e0155ae29
documentation: update example output of lookup endpoint
2022-03-28 16:41:10 +02:00
Sarah Hoffmann
74be6828dd
check and fix all liks in documentation
2021-10-18 16:53:24 +02:00
Mastercuber
c70d72f06b
Added postcode
...
Added postcode to the list of addressdetails
2021-08-22 02:52:41 +02:00
Sarah Hoffmann
32c2d2b248
document new status fields
2021-03-01 22:21:37 +01:00
Muh. Rizky Eka Arlin
436cb9229b
fix indentation
2021-01-28 14:21:54 +08:00
Sarah Hoffmann
1c1e951826
adapt documentation to new nominatim cli tool
2021-01-14 12:12:38 +01:00
marc tobias
31ba7e7cf0
Reverse.md: fix two typos
2020-12-12 00:30:26 +01:00
Sarah Hoffmann
9f6e2de4ed
fix typos
2020-12-11 17:08:13 +01:00
Sarah Hoffmann
eaee87e73d
update API documentation
...
* remove traces of HTML output
* add details on artificial objects (see also #1671 )
* add geometry output documentation for lookup
* deprecate query by ID via reverse endpoint
* remove /search/<query> query format, no longer supported
* explain better what reverse geocoding does
* lots of smaller fixes to wording
2020-12-08 17:47:38 +01:00
Pietro
a92bd1e2db
viewbox arguments are no longer accepter "in any order"
...
Order should be longitude, then latitude
2020-11-23 10:40:43 +02:00
Sarah Hoffmann
96ed4b02d7
document which labels may appear in the address info
...
The list is manually generated and only valid for the default
configuration as used on openstreetmap.org.
Fixes #1808 .
2020-06-06 17:32:30 +02:00
Sarah Hoffmann
c2f0d8e5ba
docs: add link to new status page
2020-05-04 21:11:57 +02:00
marc tobias
0fb93b1e8a
documenation for /status endpoint
2020-05-04 17:06:06 +02:00
marc tobias
e33315eaa6
API documentation: clarification countrycode assignment happens using admin_level=2 tags
2020-04-21 17:42:12 +02:00
Sarah Hoffmann
975ef0b305
re-add district to geocodejson
2020-04-01 21:24:42 +02:00
Sarah Hoffmann
e59146a733
update documentation for geocodejson
...
Address parts should be usable now.
2020-04-01 11:17:25 +02:00
Sarah Hoffmann
e98619f801
docs: remove example with polygon parameter
...
This parameter was undocumented, long deprecated and is gone now.
2020-03-31 20:10:03 +02:00
marc tobias
db6da75683
documentation: add note what bounding box can be used for
2019-11-06 17:33:20 +01:00
marc tobias
423efd54e4
documentation: add note what x,y mean for viewbox parameter
2019-10-08 19:22:51 +13:00
Christoffer Bo Petersen
ac7f0f7581
Remove duplicate format query param
2019-10-01 12:37:53 +02:00
marc tobias
1560685020
lookup endpoint supports jsonv2 and geocodejson output now
2019-07-21 23:20:48 +02:00
André Santos
a4a17f93f5
Minor change on lookup endpoint doc
...
Fix documentation about lookup endpoint on output formats available on filter `format`
2019-07-10 19:26:38 +01:00
André Santos
bbc2da2a4b
Minor issue on api docs
...
Fix a minor issue on API docs in details endpoint example 🙏
2019-07-08 20:08:43 +01:00
Jochen Topf
634684236c
Fix some minor issues in docs.
2019-05-21 13:55:16 +02:00
Sarah Hoffmann
62da8a34f3
add documentation for new reverse zoom 17
2019-04-30 23:27:04 +02:00
marc tobias
1489e6c00e
Explain place_id, i.e. shouldn't be use as permanent id
2018-12-03 19:05:18 +01:00
marc tobias
9b69bde613
three further FAQ entries regarding timezone, continents, exports
2018-09-19 19:31:54 +02:00
Sarah Hoffmann
e09c42a78a
add docs for class parameter in /details
2018-08-26 16:40:52 +02:00
Sarah Hoffmann
c80c80200c
fix links in details documentation
...
Thanks to @JamesKingdom.
2018-08-23 20:30:07 +02:00
marc tobias
4d38833170
documentation for /details endpoint
2018-08-22 13:55:43 +02:00
marc tobias
7081e2ab66
documentation for /details endpoint
2018-08-21 17:15:47 +02:00
marc tobias
71ae7f10f7
small typos and wording in the API docs
2018-08-20 19:11:38 +02:00
Sarah Hoffmann
569184a5b0
add FAQ from nominatim.org
2018-08-11 14:47:36 +02:00
Sarah Hoffmann
41c4b51be5
add description of output of API
2018-08-11 14:17:41 +02:00
Sarah Hoffmann
513bf485f2
clean up docs for lookup call
2018-08-11 09:24:59 +02:00
Sarah Hoffmann
263240919c
clean up and format search documentation
2018-08-09 23:06:52 +02:00
Sarah Hoffmann
d2b9493d72
clean up and format search documentation
2018-08-09 21:47:57 +02:00
marc tobias
879f818d81
add geojson,geocodejson formats to API documentation
2018-07-09 16:06:48 +02:00
Sarah Hoffmann
1d0da944a6
document polygon_threashold parameter
...
Fixes #1041 .
2018-05-15 23:30:58 +02:00
