https://github.com/geocoders/geocodejson-spec

DRAFT An attempt to have standard geojson responses from geocoders.
https://github.com/geocoders/geocodejson-spec

Last synced: 3 months ago
JSON representation

DRAFT An attempt to have standard geojson responses from geocoders.

• Host: GitHub
• URL: https://github.com/geocoders/geocodejson-spec
• Owner: geocoders
• Created: 2014-11-19T14:12:45.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-11-06T16:01:28.000Z (about 1 year ago)
• Last Synced: 2024-05-30T01:56:47.778Z (6 months ago)
• Language: Shell
• Size: 24.4 KB
• Stars: 35
• Watchers: 7
• Forks: 11
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# GeocodeJSON Specification

An attempt to have standard geojson responses from geocoders.

## How to use

Please read the full spec at [master/draft/README.md](https://github.com/geocoders/geocodejson-spec/blob/master/draft/README.md).

You can validate a geocoding service response against this GeocodeJSON spec using the JSON schema provided: [master/draft/geocodejson.schema.json](https://github.com/geocoders/geocodejson-spec/blob/master/draft/geocodejson.schema.json). Refer to [JSON Schema official website](https://json-schema.org/) for further informations.

Please verify the integrity of the JSON schema using the SHA-512 checksum provided: [master/draft/geocodejson.schema.json.checksum](https://github.com/geocoders/geocodejson-spec/blob/master/draft/geocodejson.schema.json.checksum).

## How to contribute

Pre-requisites: [git](https://git-scm.com/), [make](https://www.gnu.org/software/make/), [shasum](https://www.commandlinux.com/man-page/man1/shasum.1.html), [npx](https://www.npmjs.com/package/npx) (node and npm).

Please follow these steps:

- Let the community knows you want to contribute [opening an issue](https://github.com/geocoders/geocodejson-spec/issues)

- Fork this repo, clone it locally and create a new branch

- Edit the [draft document]((https://github.com/geocoders/geocodejson-spec/blob/master/draft/README.md))

- Update the [JSON schema](https://github.com/geocoders/geocodejson-spec/blob/master/draft/geocodejson.schema.json) in `src/` folder

- Run `make`

- If all is ok, commit your changes and push them

- Open a Pull Request on the main branch of this repo

## Licence

Public Domain, No Rights Reserved - Creative Commons Zero License ([CC0](https://creativecommons.org/public-domain/cc0/)).