-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update population-density-data.yaml #64
base: main
Are you sure you want to change the base?
Conversation
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM !
* **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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks !
What type of PR is this?
What this PR does / why we need it:
Add async
operationId
for API consumers to track async responses.Which issue(s) this PR fixes:
Fixes #61