-
Notifications
You must be signed in to change notification settings - Fork 11
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
/preview does not really align with use cases of sync api calls #162
Comments
Personally, I'd not promote preview too much and let batch jobs and web services handle the use cases as it is quite limited in some regards. If I remember correctly, If we want to keep it in the long run and there's any name that fits better and follows the current "style", I'm happy to adopt it. I didn't found a better one yet and I would not like to introduce |
Thanks for the explanation, it clarifies the reasoning. As already stated, I have a bit of a different view on relevance of the different calls:
Now all of the above is just context to explain why it goes beyond previewing. So for naming, given that we now use |
Good point.
So how does the user know that UDFs may not be the best options in synchronous calls?
I personally don't like those ridiculously long URLs, but could still be something we want to standardize nevertheless, so could be worth a separate issue.
I'm sure I considered this option when renaming the endpoint and rejected it for some reason, but at the moment I think that could be an option. It seems consistent with the jobs, too ( |
The user will have to learn either by documentation or by clear error messages when to use what endpoint. Unfortunately, a call that works synchronously on one backend, might not work on another one, and there's not much we can do about that. (Except that 'slow' backends will simply not be used a lot by people looking for interactive queries.) |
Okay, I renamed it to |
In 0.3.x, synchronous API calls now go through '/preview' (https://open-eo.github.io/openeo-api/v/0.3.1/apireference/#tag/Job-Management/paths/~1preview/post)
The use case of synchronous api calls goes beyond previewing stuff:
What was wrong with 'execute'?
The text was updated successfully, but these errors were encountered: