Clarifications for asynchronous responses #575
Conversation
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
PedroDiez
requested review from
jlurien,
patrice-conil,
rartych and
shilpa-padgaonkar
as code owners
PedroDiez
added
documentation
Kevsy
reviewed
Jan 16, 2026
|
|
||
| An asynchronous response is not really an event. An event is something that can happen or not, once or several times and it is the occurrence of the event that carries the main information, whereas an asynchronous response represents the metainformation carried over in the same format as it would be a synchronous response and will happen once and only once. | ||
|
|
||
| This is the rationale to NOT use [CAMARA cloudevents-based model for event notification](./CAMARA-API-Event-Subscription-and-Notification-Guide.md#3-event-notification) for these kind of scenarios but to use the same response model as in an analogous synchronous scenario. |
Collaborator
There was a problem hiding this comment.
'same response model' -> may be worth stating explicitly that an asychronous response would typically involve a different response status code (202 Acceptedfor the non-error scenarios )
Contributor
Author
There was a problem hiding this comment.
Making some updates. Also considering offline proposal by @rartych
rartych
reviewed
Jan 19, 2026
| $ref: "#/components/responses/<schema-name>" | ||
| ``` | ||
|
|
||
| ##### 5.7.6.1 Asynchronous responses |
Contributor
There was a problem hiding this comment.
We have 5.7.6.1 section proposed in #567
We need to decide on the sequence and resolve the conflict.
Contributor
Author
There was a problem hiding this comment.
Tentatively i assign 5.7.6.2 in this PR
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
What type of PR is this?
What this PR does / why we need it:
This PR address some guidelines with regards to scenarios where API response is provided asynchronously. It is stated that the response model does NOT have to follow CAMARA cloudevents-based event notification model as the conclusion from Issue #533.
Which issue(s) this PR fixes:
Fixes #533
Does this PR introduce a breaking change?
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.