chroma-core / chroma-core/chroma
Improve types and docs around FastAPI Http Endpoints
- Dominant language
- Rust
- Stars
- 29.3k
- Forks
- 2.5k
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 38
Description
Some users want to directly use the Http endpoints from the FastAPI server. We should improve the naming, types, docstrings, and docs around this.
@HammadB @atroyn how would we feel about make this more of a "external service"? I know in the past we have thought of it as more "internal"
http://localhost:8000/docs exists, but we can do better.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start at the FastAPI server and its generated http://localhost:8000/docs page, then review the HTTP endpoint names, types, docstrings, and surrounding documentation. Clarify whether the endpoints are intended as an external service; done means the public-facing naming, typing, and documentation consistently support direct use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100