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

Type definitions for custom backend response types #46

Closed
GreatEmerald opened this issue Feb 23, 2018 · 4 comments
Closed

Type definitions for custom backend response types #46

GreatEmerald opened this issue Feb 23, 2018 · 4 comments
Milestone

Comments

@GreatEmerald
Copy link
Member

Backends are able to return specific, custom-defined types as JSON objects, for instance for time series (a JSON dictionary with dates and values of the time series at a particular pixel). However, there is not enough information in the response to tell what type of response it is, so clients cannot tell how to parse the response into something that is immediately usable for the users. The Python client example currently just has the user parse the result from raw JSON, which is not very user-friendly.

@m-mohr
Copy link
Member

m-mohr commented Apr 9, 2018

@GreatEmerald Do you have a concrete suggestion for this? I can't really come up with a reasonable and satisfying solution.

This probably relates to how we solve #72.

@m-mohr m-mohr removed the accepted label Apr 9, 2018
@jdries
Copy link

jdries commented May 2, 2018

I also believe we should avoid returning custom responses as much as possible. Once we have solved #72 , the python client will be made more user friendly. So not sure if this issue is really valid.

@m-mohr
Copy link
Member

m-mohr commented May 2, 2018

This also relates to and might be solved with #47 as it also includes schema definitions for process results.

@m-mohr
Copy link
Member

m-mohr commented Jun 1, 2018

This will be solved with #47.

  • If your last process is returning images (most of them) or vector data, you'll retrieve them using any of the supported image output formats (GTiff, PNG, JPEG, etc.) or vector output formats (GeoJSON, KML, Shapefiles, etc.).
  • If your last process is returning anything else (usually structured data as JSON), it will be defined in the process specification and can be parsed accordingly. Therefore we need a JSON (or RAW?) output format.

If the back-end is not able to transform the data to the requested data format, an error with openEO error code 3004 should be thrown.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants