sparkfabrik / nominatim-openapi Goto Github PK
View Code? Open in Web Editor NEWOpenAPI specification for OpenStreetMap Nominatim API (unofficial).
Home Page: https://sparkfabrik.github.io/nominatim-openapi/
License: MIT License
OpenAPI specification for OpenStreetMap Nominatim API (unofficial).
Home Page: https://sparkfabrik.github.io/nominatim-openapi/
License: MIT License
Is your feature request related to a problem? Please describe.
Right now the official default format
value for the /search
endpoint is jsonv2
(see documentation) and the spec describes this response. But this discussion suggests that the best output format is geocodejson
described by this spec.
Describe the solution you'd like
Change default format value of the OpenAPI spec to geocodejson
and describe only this output in json schema. We should find or write the json schema for the geocodejson spec, but it is an extension of GeoJSON that already has an official json schema.
Describe alternatives you've considered
We can strictly follow the Nominatim documentation, but jsonv2
format has several well-known drawbacks and probably the next v2 of the api will drop it.
Additional context
Some useful resources:
Describe the solution you'd like
The official documentation describes the /lookup
endpoint. We should add it to paths
section and describe all accepted parameters. The response schema (for the geocodejson
format, see #2) will be the same of /search
endpoint.
Additional context
Some useful resources:
Describe the solution you'd like
The official documentation describes the /status
endpoint. We should add it to paths
section and describe all accepted parameters. The default response schema should be json
, described in json schema.
Warning! Status endpoint is not compliant with REST spec (returns always 200, also on errors).
Additional context
Some useful resources:
Here I'm proposing final goals and a development roadmap for this project, discussion is open!
Describe your question or point of view about a topic
Security topic: how can the user be confident (and verify by himself!) that the published application is the same in the repository? Example: openapi specification as source code and as published resource. Two different URLs, same resource?
The official documentation describes also the /details
, /deletable
, and /polygons
endpoints. We should add it to paths
section and describe all accepted parameters.
These endpoints are for debug or maintenance purposes and we can ignore them.
Some useful resources:
Swagger Editor can check the specs for syntax issues or invalid openapi yaml, but we need to test also endpoints and json schemas.
Yes, at this moment we can't test errors in endpoints or json schemas and this should be mandatory for the first stable release.
Handmade checks using the playground.
No response
Describe the solution you'd like
The official documentation describes the /reverse
endpoint. We should add it to paths
section and describe all accepted parameters. The response schema (for the geocodejson
format, see #2) will be the same of /search
endpoint.
Additional context
Some useful resources:
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.