Issue #507: clarify that "canonical" job result link should include q…

…uery parameters (#513) * Issue #507: clarify that "canonical" job result link should include query parameters * Issue #507/#513 improve clarification of including query parameters in canonical URL --------- Co-authored-by: Matthias Mohr <[email protected]>
Open-EO · Feb 14, 2025 · f7afd49 · f7afd49
1 parent 5d356f7
commit f7afd49
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `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.
+- `GET /jobs/{job_id}/results`: Clarify that "canonical" job result link should include/encode the original query parameters
 - 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`

diff --git a/openapi.yaml b/openapi.yaml
@@ -4053,6 +4053,9 @@ components:
 
             It is **strongly recommended** to add a link with relation type
             `canonical` pointing to this STAC document using a signed URL.
+            Note that query parameters that influence the response of the current request
+            (like `partial`) MUST also be included or encoded within the signed URL
+            in order to give a consistent response when the signed URL is used.
             This signed URL allows consumption of the STAC metadata
             by (possibly non-openEO) clients and tools
             without additional authentication steps.