Added a status diagram that explains the status changes of batch jobs #436

Author: m-mohr

CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `version` property to `GET /processes` [#517](https://github.com/Open-EO/openeo-api/issues/517)
 - Added `queued`, `started` and `unpublished` to the batch job metadata and the corresponding STAC results [#542](https://github.com/Open-EO/openeo-api/issues/542)
 - Added all the batch job timestamps (including the new timestamps above) to the Collection type of batch job results
+- Added a status diagram that explains the status changes of batch jobs [#436](https://github.com/Open-EO/openeo-api/issues/436)
 
 ### Deprecated
 

assets/status-diagram.png

@@ -5608,6 +5608,7 @@ components:
             The current status of a batch job.
 
             The following status changes can occur:
+            
             * `POST /jobs`: The status is initialized as `created`.
             * `POST /jobs/{job_id}/results`: The status is set to `queued`, if
             processing does not start instantly.
@@ -5617,7 +5618,11 @@ components:
             * `DELETE /jobs/{job_id}/results`: The status is set to `canceled` if
             the status was `running` beforehand and partial or preliminary results
             are available to be downloaded. Otherwise the status is set to
-            `created`. 
+            `created`.
+
+            The following state diagram shows the possible status changes:
+
+            ![State diagram](assets/status-diagram.png)
           example: running
           default: created
         progress: