Skip to content

Commit 7725605

Browse files
committed
docs(api): add CORS_ALLOW_ORIGINS example and list attribute filters
1 parent 033ba55 commit 7725605

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ uvicorn main:app --reload --port 8000
1515
# API docs: Swagger UI at /docs, ReDoc at /redoc, OpenAPI JSON at /openapi.json
1616
```
1717

18+
CORS configuration:
19+
20+
```bash
21+
# Allow docs site and org landing page origins
22+
export CORS_ALLOW_ORIGINS="https://bharataddress.github.io,https://example.com"
23+
uvicorn main:app --reload --port 8000
24+
```
25+
1826
OpenAPI export:
1927

2028
```bash
@@ -25,6 +33,7 @@ Query parameters (items endpoint):
2533
- `limit` (default 100): maximum features returned
2634
- `offset` (default 0): pagination index; response includes `self`/`next`/`prev` links
2735
- `bbox`: `minLon,minLat,maxLon,maxLat` filter
36+
- Optional attribute filters: `pin`, `city` (case-insensitive), `ulb_lgd`, `digipin`
2837

2938
Docker:
3039

0 commit comments

Comments
 (0)