microsoft / microsoft/api-guidelines

Add guidance for pageable post operations

Open
#489 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Azure Guidelines
Dominant language
No language data
Stars
23.3k
Forks
2.7k
PR merge metrics
No merged PRs in 30d

Description

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing pageable pattern in the API guidelines first, then compare it with the POST-operation scenario described here. Done means documented recommendations that answer whether follow-up pages use POST or GET, whether the body is required, and how differing bodies are handled.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.