Add v1 410 response and migrating documentation

NYCPlanning / labs-geosearch-docker

Main repository for running the Planning Labs geosearch API powered by pelias

12 stars 3 forks source link

Add v1 410 response and migrating documentation #67

Closed TylerMatteo closed 1 year ago

TylerMatteo commented 1 year ago

Summary

After changing nginx.conf to no longer proxy v1 traffic to an old version of Geosearch, I realized that calls to /v1 would be forwarded to the docs site. This would be very confusing for external consumers of the /v1 API that haven't been warned about its deprecation. This PR should set nginx.conf to return a 410 response to requests to the v1 endpoints with a message linking to the newly added MIGRATING.md that documents how to move to v2.

eldang commented 1 year ago

Thank you for doing this. A client noticed today that our old NYC Geosearch integration wasn't working, and the breadcrumbs you left with this made it so much easier to figure out what was going on.