microsoft / api-guidelines

Microsoft REST API Guidelines
Other
22.69k stars 2.71k forks source link

Add guidance for pageable post operations #489

Open mikekistler opened 1 year ago

mikekistler commented 1 year ago

There are situations where a query-like operation must accept inputs that are too complex or bulky to pass in the query string, and since GET cannot accept a request body, the operation instead uses the POST method. When the response to this method could be large, it should be pageable. But the pageable pattern is not designed for POST methods.

We should have a recommended pattern for pageable post operations. The guidance should address: