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

Add guidance for pageable post operations #489

Open
mikekistler opened this issue Aug 17, 2023 · 0 comments
Open

Add guidance for pageable post operations #489

mikekistler opened this issue Aug 17, 2023 · 0 comments
Labels
Azure Guidelines This issue relates to the Auzre Guidelines.

Comments

@mikekistler
Copy link
Member

mikekistler commented Aug 17, 2023

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:

  • are operations to get subsequent pages POST or GET?
  • if POST, does the request body have to be supplied?
  • if the request body is required for subsequent pages, does it have to be the same as on the original request? What happens if it isn't?
@mikekistler mikekistler added the Azure Guidelines This issue relates to the Auzre Guidelines. label Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Azure Guidelines This issue relates to the Auzre Guidelines.
Projects
None yet
Development

No branches or pull requests

1 participant