feat(231): allow POST HTTP verb#415
Open
kindermoumoute wants to merge 1 commit into
Open
Conversation
Signed-off-by: Olivier Cano <ocano@scaleway.com>
toumorokoshi
requested changes
Jun 13, 2026
toumorokoshi
left a comment
toumorokoshi
left a comment
Member
There was a problem hiding this comment.
Thanks! A couple suggestions, and the examples should also be updated to illustrate how the support will work in practice.
|
|
||
| ## Rationale | ||
|
|
||
| ### Why allowing both `POST` and `GET` HTTP verb? |
Member
There was a problem hiding this comment.
Suggested change
| ### Why allowing both `POST` and `GET` HTTP verb? | |
| ### Why allow both `POST` and `GET` HTTP verb? |
Just a grammatical nit.
|
|
||
| {% tab oas %} | ||
|
|
||
| {% sample 'batchget.oas.yaml', '$.paths./publishers/{publisherId}/books:batch-get' %} |
Member
There was a problem hiding this comment.
can the samples be updated to include a POST example? I think we'll want want paths field in the request body.
|
|
||
| - Allowing the `POST` HTTP verb address practical limitations such as URL length constraints (e.g., 2048 characters). | ||
| - Allowing the `GET` HTTP verb maintains backward compatibility and cacheability. | ||
|
|
Member
There was a problem hiding this comment.
Suggested change
| In AEP-2026, only the `GET` verb was allowed, originally to ensure cacheability of the request. However, query parameters along to specify a large number of IDs can face practical limitations, such as maximum URL length in a given browser. | |
| As such, `POST` is accepted as an alternative method. Although the IETF is working on a `QUERY` HTTP method, this is not generally implemented in API gateways, and therefore `POST` acts as more practical alternative. |
I think it's valuable to elaborate on the full conversation - oftentimes people come to the rationale section to hear about the "why" in depth, including context on pros / cons and alternatives.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #413
🍱 Types of changes
What types of changes does your code introduce to AEP? Put an
xin the boxesthat apply
📋 Your checklist for this pull request
Please review the AEP Style and Guidance for
contributing to this repository.
General
references AEPs
correctly.
(run
make lint)