Issue Open-EO#507: clarify that "canonical" job result link should in…

…clude query parameters
soxofaan · Sep 29, 2023 · 6c0fe73 · 6c0fe73
1 parent 9555433
commit 6c0fe73
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,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 "canonical" job result link should include query parameters
 
 ## [1.2.0] - 2021-05-25
 

diff --git a/openapi.yaml b/openapi.yaml
@@ -4031,7 +4031,9 @@ components:
             default.
 
             It is **strongly recommended** to add a link with relation type
-            `canonical`, which points to this STAC document using a signed URL.
+            `canonical`, which points to this STAC document
+            (including all query parameters like `partial`)
+            using a signed URL.
             This way the STAC metadata can be used by non-openEO clients
             without additional authentication steps.