Issue #508 Clarify updating expiration of signed URL (#516)

Co-authored-by: Matthias Mohr <[email protected]>

CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `GET /file_formats`: Base paramater on top of normal JSON Schema, not Process JSON Schema
 - `PATCH /services/{service_id}` and `PATCH /jobs/{job_id}`: Explicitly allow updating back-end specific properties (as in `POST`)
 - `GET /services/{service_id}` and `GET /jobs/{job_id}`: Explicitly allow listing back-end specific properties (as provided in `POST`)
+- `GET /jobs/{job_id}/results`: Clarify that signed URLs (used as "canonical" link) should be regenerated each time.
 - Clarified for log levels which default values apply
 - Clarified how the relation types `license`, `version-history` and `author` can be used to enrich the process metadata. [#531](https://github.com/Open-EO/openeo-api/issues/531)
 - Clarified the behaviour of `federation:backends` for `POST /validation`

openapi.yaml

@@ -4033,9 +4033,11 @@ components:
             default.
 
             It is **strongly recommended** to add a link with relation type
-            `canonical`, which points to this STAC document using a signed URL.
-            This way the STAC metadata can be used by non-openEO clients
+            `canonical` pointing to this STAC document using a signed URL.
+            This signed URL allows consumption of the STAC metadata
+            by (possibly non-openEO) clients and tools
             without additional authentication steps.
+            It is recommended to regenerate the signed URL (and its expiry) with each request.
 
             For relation types see the lists of
             [common relation types in openEO](#section/API-Principles/Web-Linking).