Include operation ID for the async mechanism#64
Conversation
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports MegaLinter is graciously provided by |
bigludo7
left a comment
There was a problem hiding this comment.
Thanks Jorge.
I think we should document a bit this operationId in the documentation / Notification URL and token part no?
We have just to indicate that in case of async pattern an operationId must be sent in the 204 response and then once the 'real' result in send back asynchronously via a notification this operationId must be part of the notification to allow API consumer to "connect the dots".
WDYT?
Thanks ludo for the proposal, description included! |
| * **Notification URL and token**: Developers may provide a callback URL (`sink`) for receiving an async response. | ||
| This is an optional parameter. If `sink` is included, it is RECOMMENDED for the client to provide as well the `sinkCredential` | ||
| property to protect the notification endpoint. In the current version,`sinkCredential.credentialType` MUST be set to `ACCESSTOKEN` if provided. | ||
| When an asynchronous response is requested, the 202 response of the API will include with an `operationId` property, this `operationId` will |
There was a problem hiding this comment.
| When an asynchronous response is requested, the 202 response of the API will include with an `operationId` property, this `operationId` will | |
| When an asynchronous response is requested, the 202 response of the API will include an `operationId` property. This `operationId` property will |
Co-authored-by: Jose Luis Urien <jlurien@gmail.com>
|
@sachinvodafone @bigludo7 PR reviewed and errors fixed, can be validated and merged |
What type of PR is this?
What this PR does / why we need it:
Add async
operationIdfor API consumers to track async responses.Which issue(s) this PR fixes:
Fixes #61