Context
The application configures CORS middleware in app/main.py (allowing all origins, methods, and headers), but the README.md does not mention CORS at all. Contributors and API consumers should know that CORS is enabled and how it is configured, especially since allow_origins=["*"] has security implications.
Steps to reproduce
- Open
README.md.
- Search for "CORS" -- no results.
- Open
app/main.py and see the CORS middleware configuration near the top.
Expected behavior
The README should have a section (or a note in an existing section) documenting:
- That CORS middleware is enabled
- The current configuration (all origins allowed)
- A note that this is suitable for development but should be restricted in production
Actual behavior
No mention of CORS anywhere in the README.
Files
README.md -- add a CORS section or note
app/main.py -- the existing CORS middleware setup (for reference)
Acceptance criteria
Suggested approach
- Open
README.md.
- Add a section after "API Endpoints", for example:
## CORS
The application includes CORS middleware that allows requests from all origins.
This is configured in `app/main.py`. For production deployments, restrict
`allow_origins` to your specific frontend domain(s).
- Review the section for accuracy against the code in
app/main.py.
Context
The application configures CORS middleware in
app/main.py(allowing all origins, methods, and headers), but theREADME.mddoes not mention CORS at all. Contributors and API consumers should know that CORS is enabled and how it is configured, especially sinceallow_origins=["*"]has security implications.Steps to reproduce
README.md.app/main.pyand see the CORS middleware configuration near the top.Expected behavior
The README should have a section (or a note in an existing section) documenting:
Actual behavior
No mention of CORS anywhere in the README.
Files
README.md-- add a CORS section or noteapp/main.py-- the existing CORS middleware setup (for reference)Acceptance criteria
Suggested approach
README.md.app/main.py.