Skip to content
Bryan Housel edited this page Sep 19, 2021 · 4 revisions

File List

The files under dist/* are generated:

  • nsi.json - The complete index
  • dissolved.json - List of items that we believe may be dissolved based on Wikidata claims
  • featureCollection.json - A GeoJSON FeatureCollection containing all the custom features (geofences)
  • taginfo.json - List of all tags this project supports (see: https://taginfo.openstreetmap.org/)
  • wikidata.json - Cached data retrieved from Wikidata (names, social accounts, logos)
  • filtered/* - Subset of name tags that we are keeping or discarding
  • presets/* - Preset files generated for iD and JOSM editors

These files from the config/ folder are also copied over to the dist/ folder:

  • genericWords.json - Regular expressions to match generic names (e.g. "store", "noname")
  • matchGroups.json - Groups of OpenStreetMap tags that are considered equivalent for purposes of matching
  • replacements.json - Mapping of old Wikidata QIDs to replacement new Wikidata/Wikipedia values
  • trees.json - Metadata about subtrees supported in this project

Each file is available in both regular .json or minified .min.json format.

Metadata

Each JSON file contains a block of metadata like:

"_meta": {
  "version": "6.0.20210624",
  "generated": "2021-06-24T19:01:08.972Z",
  "url": "https://raw.githubusercontent.com/osmlab/name-suggestion-index/main/dist/featureCollection.json",
  "hash": "13d723d1c594ef649a230954727b3f47"
},
  • version - the semantic version of project when the file was generated: major.minor.patch where patch is the date in yyyymmdd format
  • generated - the date that the file was generated
  • url - source url where the file is available
  • hash - MD5 hash of the file

Home

For Contributors

Contributing to the index

Advanced Topics

For Developers

Information for developers using the name-suggestion-index in another project.

For Maintainers

Information for maintainers, including how to clone and build the project.

 

Clone this wiki locally