roboflow / roboflow/inference

Improve API structure + put non-async handlers properly

Open
#569 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
2.5k
Forks
320
Avg merge
1d 14h
Merged PRs (30d)
133

Description

Search before asking
  • I have searched the Inference issues and found no similar bug report.
Bug

The HTTP API module requires re-design. It is large and contains plenty of handlers. Some handlers (running non-asyncio code) are marked async improperly, potentially making the API less performant (fastapi handles both async and non-async handlers, just stamps need to be placed properly). We have this mistake by the virtue of error handling wrapper which is async-first.
Please re-design API as maintenance activity.

Environment

No response

Minimal Reproducible Example

No response

Additional

No response

Are you willing to submit a PR?
  • Yes I'd like to help by submitting a PR!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the large HTTP API module, its FastAPI handlers, and the async-first error-handling wrapper. Review which handlers run non-asyncio code and how the wrapper marks them; done means the API structure is redesigned and non-async handlers are placed correctly without losing error handling.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, python
Domain
api, backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.