mirror of
https://github.com/stoatchat/javascript-client-api.git
synced 2026-07-18 16:14:27 -04:00
feature request: Make GET channels/{target}/messages use request body instead of query parameters #15
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @QuantumToasted on GitHub (Nov 10, 2023).
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.
@QuantumToasted commented on GitHub (Nov 10, 2023):
I've just remembered that the reason Fetch Messages uses query parameters is that
GETmethods cannot have a body, which is obviously something that has to be worked around and explains the usage of query parameters.Might I instead propose a sort of "merging" of the two endpoints into one single Search for Messages endpoint with an optional
queryfield on the object which determines whether to do a normal fetch versus an actual search?