Skip to content
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

Add capability for async response behaviour. #37

Open
bigludo7 opened this issue Sep 25, 2024 · 2 comments · May be fixed by #42
Open

Add capability for async response behaviour. #37

bigludo7 opened this issue Sep 25, 2024 · 2 comments · May be fixed by #42
Labels
enhancement New feature or request

Comments

@bigludo7
Copy link
Collaborator

bigludo7 commented Sep 25, 2024

Problem description
The standard behavior of the API is synchronous, although for large area requests the API may behave asynchronously

Possible evolution
An API invoquer can enforce asynchronous behavior by providing a callback URL (sink) is in the request, in this case the API sends a callback to the callback URL provided with the result of the request.
Additionally response code 202 should be added.

Alternative solution

Additional context
This is a pattern already provided in Population Density Data API and make sense to replicate it.
It means that we add in the request sink attribute & sinkCredential object.

@bigludo7 bigludo7 added the enhancement New feature or request label Sep 25, 2024
@bigludo7 bigludo7 changed the title Add capability for async behaviour. Add capability for async response behaviour. Sep 25, 2024
@chinaunicomyangfan
Copy link
Collaborator

@bigludo7 A great suggestion. For larger areas, the statistical time may indeed be longer. Introducing asynchronous interfaces is a good solution, and the Population Density Data API provides a great implementation. I will refer to and add this feature to our API

@bigludo7
Copy link
Collaborator Author

Thanks @chinaunicomyangfan !! :)

@chinaunicomyangfan chinaunicomyangfan linked a pull request Dec 16, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants