Add city prefix search API using local pincode DB

2026-02-05 20:02:35 +05:30
parent a0e354b464
commit 71c10193a3
3 changed files with 88 additions and 0 deletions
--- a/docs/API_REFERENCE.txt
+++ b/docs/API_REFERENCE.txt
@@ -121,6 +121,33 @@ AUTH + SYSTEM APIS

  - 401 Unauthorized (missing principal / user not found)

+
+- City search API is this one:
+
+  GET /geo/cities/search
+
+  What it does:
+
+  - Searches city names by prefix from local pincode directory table.
+  - Returns unique city + state rows only.
+  - Uses local DB only (no external API call in this endpoint).
+
+  Request body:
+
+  - None.
+
+  Query params:
+
+  - q (required, minimum 2 characters)
+  - limit (optional, default 20, min 1, max 100)
+
+  - Allowed roles: authenticated Firebase user.
+
+  Error Codes
+
+  - 400 Bad Request (q too short)
+  - 401 Unauthorized
+
 ================================================================================
 PROPERTY + USER APIS
 ================================================================================