Add QUERY method description to HTTP methods index#44568
Conversation
Adds the HTTP QUERY method defined by RFC 10008 to the HTTP request methods landing page. RFC 10008 defines QUERY as a safe and idempotent HTTP method that carries request content and returns the result of processing that content. The request method table is updated accordingly.
|
Preview URLs (1 page) Flaws (2) Found an unexpected or unresolvable flaw? Please report it here. URL:
|
|
Thanks @gomestai . Thinking aloud:
Upshot, I'm going to see if I can get a little more information on this topic and get back to you. MIght not be very quick. |
| - : The `QUERY` method requests that the target resource process the request {{Glossary("HTTP Content", "content")}} in a safe and idempotent manner and respond with the result. | ||
| It is similar to `GET`, but allows request content to be sent, for example when query parameters are too large or complex to fit comfortably in the URI. |
There was a problem hiding this comment.
- I think I'd put these (all) in alphabetic order, and same for the table below. My reason is that all HTTP methods are equal. It is better to therefore treat them as such.
- There is no need to link
contentagain. First instance on page/list needed. - I think the text here is pretty good, but perhaps at this level we should omit the for-example since none of the others have it. The alternative is to add an example to all the others.
So maybe reorder and do this?
| - : The `QUERY` method requests that the target resource process the request {{Glossary("HTTP Content", "content")}} in a safe and idempotent manner and respond with the result. | |
| It is similar to `GET`, but allows request content to be sent, for example when query parameters are too large or complex to fit comfortably in the URI. | |
| - : The `QUERY` method requests that the target resource process the request content in a safe and idempotent manner, returning the result in the response. | |
| It is similar to GET, but allows request body content with defined semantics. |
|
@gomestai So I've had a short discussion on this.
What you have done is a first step - this really needs
This is a non-trivial bit of documentation. Are you willing to take it on. We could stop at this point if you think this is more than you are willing to commit. However it isn't all that useful at this point because until we have the page there is no spec link or detail on how it used. |
Description
Adds the HTTP
QUERYmethod, defined by RFC 10008, to the HTTP request methods landing page.The page currently lists the established HTTP request methods but does not include
QUERY. This PR adds a short description and updates the safe/idempotent/cacheable method table.Motivation
RFC 10008 defines
QUERYas a safe and idempotent HTTP method that carries request content and returns the result of processing that content. It fills the use case where a request is read-only likeGET, but the query input is too large or complex to fit comfortably in the URI.Additional details
I added
QUERYnext toGETbecause both are safe, idempotent, and cacheable request methods. I avoided describing it as simply “GET with a body” and used wording closer to the RFC semantics.I’m not sure whether a separate
Web/HTTP/Reference/Methods/QUERYpage and BCD/spec data should be added in the same PR or handled separately. Happy to adjust based on maintainer guidance.Related issues and pull requests
None.