Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature request: Make GET channels/{target}/messages use request body instead of query parameters #28

Open
QuantumToasted opened this issue Nov 10, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@QuantumToasted
Copy link

QuantumToasted commented 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 QuantumToasted added the enhancement New feature or request label Nov 10, 2023
@QuantumToasted
Copy link
Author

QuantumToasted commented Nov 10, 2023

I've just remembered that the reason Fetch Messages uses query parameters is that GET methods 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 query field on the object which determines whether to do a normal fetch versus an actual search?

@insertish insertish moved this to 💬 Needs Discussion in Revolt Project Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 💬 Needs Discussion
Development

No branches or pull requests

1 participant