fix(151): clarify protobuf response for no parallel requests #228
Conversation
This file contains 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
For protobuf guidance, it was unclear response code should be.
toumorokoshi
changed the title
wora
reviewed
Oct 19, 2024
|
@wora addressed comments! PTAL. |
|
LGTM. I think splitting into tabs per protocol is the right answer. I'm not a reviewer, so cannot approve. |
rofrankel
reviewed
Nov 1, 2024
Comment on lines
+78
to
+89
|
|
||
| {% tab proto %} | ||
|
|
||
| - A resource that does not support concurrent mutation requests **must** return an | ||
| `ABORTED` error if the resource has an outstanding mutation. | ||
|
|
||
| {% tab oas %} | ||
|
|
||
| - A resource that does not support concurrent mutation requests **must** respond | ||
| with a `409 Conflict` status code if the resource has an outstanding mutation. | ||
|
|
||
| {% endtabs %} |
There was a problem hiding this comment.
Suggested change
| {% tab proto %} | |
| - A resource that does not support concurrent mutation requests **must** return an | |
| `ABORTED` error if the resource has an outstanding mutation. | |
| {% tab oas %} | |
| - A resource that does not support concurrent mutation requests **must** respond | |
| with a `409 Conflict` status code if the resource has an outstanding mutation. | |
| {% endtabs %} | |
| - Resource that does not permit multiple requests in parallel (denying any new | |
| request until the one that is in progress finishes) **must** return | |
| `ABORTED`/`409 Conflict` if a user attempts a parallel request, and include an error | |
| message explaining the situation. |
We discussed this live - seems unfortunate to add all the tab chrome to the page just to vary a single term. Thoughts?
There was a problem hiding this comment.
I'm fine with consolidating it.
@wora gave feedback on the "include an error message" guidance earlier, and suggested that adding this type of guidance may result in users using the error string as a way to figure out the actual error (concurrent request). I removed that part intentionally based on that feedback (as I also agreed). Thoughts on that?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
For protobuf guidance, it was unclear response code should be.
Partially addresses #224
🍱 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.
(usually
prettier -w .)