feature request: Make GET channels/{target}/messages use request body instead of query parameters
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- openapi, typescript
- Domain
- api, backend-api-design
Research direction
Start with the linked Search for Messages and Fetch Messages API definitions, comparing their request parameters and body schemas. Trace where these endpoint definitions feed the TypeScript typings and OpenAPI v3 generator; done means both endpoints use the same JSON request-body shape and the resulting breaking client types are consistent.
Written by the indexing model from the issue text.
Description
What do you want to see?
At the moment, Search for Messages (POST channels/{target}/search) utilizes nearly identical parameters to Fetch Messages (GET channels/{target}/messages), but the former uses a JSON request body whereas the latter uses query parameters, which in my personal opinion is a worse way to build requests especially with as many parameters as the methods allow.
Would it be possible to make both endpoints use the same request body type (specifically a JSON request body instead of query parameters) for consistency? This would obviously be a breaking change for clients and API wrappers which depend on this functionality, but I think it would be better to get that over with sooner rather than later.
- Dominant language
- TypeScript
- Stars
- 42
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from stoatchat/javascript-client-api
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 35/100
stoatchat/javascript-client-api#34 · 1 comment ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
stoatchat/javascript-client-api#29 · 1 reaction ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
stoatchat/javascript-client-api#18 · 2 comments · 4 reactions ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
stoatchat/javascript-client-api#16 · 2 comments · 8 reactions ·
All issues in stoatchat/javascript-client-api
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug v2
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/inspector#2458 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
carbon-design-system/ibm-products#9907 ·