lm-sys / lm-sys/FastChat

Potential Enhancement: Use GET Instead of POST for Fetching Data?

Open
#2,625 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
39.5k
Forks
4.8k
PR merge metrics
No merged PRs in 30d

Description

Hello,

As I was reviewing the project, I noticed that some endpoints, specifically `api_model_details` and `api_get_status`, utilize the POST method. From my understanding, these endpoints do not alter the server's state but merely retrieve information.

I'm under the impression that the GET method is generally preferred for data retrieval operations, primarily because of its cacheable nature and the direct accessibility via URLs. Leveraging this could potentially improve network efficiency and reduce server load.

Of course, there might be reasons for choosing POST that I'm not aware of. So, I'm reaching out to gather insights from the community. If there's a consensus that this is an area that could benefit from enhancement, I would be interested in contributing.

Looking forward to your feedback. Thank you!

image

image

image

Contributor guide

No contributing guide indexed for this repository

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 implementations and callers of the `api_model_details` and `api_get_status` endpoints. Check why they currently use POST and whether their request patterns support retrieval through GET; done requires a decided, tested endpoint-method change or a documented reason to keep POST.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.