Open-EO / openeo-processes

Interoperable processes for openEO's big Earth observation cloud processing.
https://processes.openeo.org
Apache License 2.0
48 stars 15 forks source link

How to handle exceptions in the specification #414

Closed m-mohr closed 1 year ago

m-mohr commented 1 year ago

Should errors be "optional"?

Is the specification a best-practice and implementations can change (throw an error) or should always keep the option open (may throw an error).

m-mohr commented 1 year ago

Candidates:

m-mohr commented 1 year ago

We discussed this today (vote: ++++oo). The consensus was to be strict in the user-facing documentation (i.e. the JSON process specification) so that errors are clearly stated without a "uncertainty" such as "may throw". Back-ends can extend their implementations and remove the exception from the documentation. For back-end implementations we add more documentation to the back-end implementation guide (and promote/use it more).

For this issue there is no further to do as we follow our past principles.