Add guidance for pageable post operations
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- api, documentation
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.
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?
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/api-guidelines
-
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
microsoft/api-guidelines#571 ·
-
Difficulty 5/5 Over a week Newbie friendliness 5/100
microsoft/api-guidelines#570 ·
-
Im Open
Difficulty 5/5 Over a week Newbie friendliness 10/100
microsoft/api-guidelines#562 ·
-
Difficulty 5/5 Over a week Newbie friendliness 1/100
microsoft/api-guidelines#560 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 58/100
microsoft/api-guidelines#559 ·
All issues in microsoft/api-guidelines
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
use-agent-os/agent-os#3312 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
needs-acceptance wg/data-plane-networking
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vllm-project/semantic-router#4024 · 1 comment ·
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#165 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100