diff --git a/CHANGELOG.md b/CHANGELOG.md index 17b18cb4..54505af1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased / Draft +### Fixed +- Clarified how process exceptions should be used. [#352](https://github.com/Open-EO/openeo-api/issues/352) + ## 1.0.1 - 2020-12-07 ### Changed diff --git a/openapi.yaml b/openapi.yaml index e8d0b246..fff4b28b 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -4842,11 +4842,13 @@ components: type: object title: Process Exceptions description: |- - Declares any exceptions (errors) that might occur during execution + Declares exceptions (errors) that might occur during execution of this process. This list is just for informative purposes and may be incomplete. This list MUST only contain exceptions that stop the execution of a process and MUST NOT contain warnings, notices or - debugging messages. + debugging messages. It is meant to primarily contain errors that + have been caused by the user. It is RECOMMENDED that exceptions + are referred to and explained in process or parameter descriptions. The keys define the error code and MUST match the following pattern: `^\w+$`