hotosm / galaxy-api

Backend to fetch data from Underpass
https://galaxy-api.hotosm.org/latest/redoc
GNU Affero General Public License v3.0
14 stars 5 forks source link

Add API documentation #219

Open petya-kangalova opened 2 years ago

petya-kangalova commented 2 years ago

As discussed with Ramya, we need clear API documentation for all Galaxy API endpoints.

Check this example: osm-stats/documentation at master · AmericanRedCross/osm-stats (github.com) All current API are available on Swagger: FastAPI - Swagger UI (hotosm.org) Testing and reporting issue about the API

@ramyaragupathy I might need your input to understand what is missing from the swagger UI and the improvements needed. We can discuss in the sprint.