From 6c0fe73fa128d05a42f0234933f1e40126b3af57 Mon Sep 17 00:00:00 2001
From: Stefaan Lippens <stefaan.lippens@vito.be>
Date: Fri, 29 Sep 2023 17:24:29 +0200
Subject: [PATCH] Issue #507: clarify that "canonical" job result link should
 include query parameters

---
 CHANGELOG.md | 1 +
 openapi.yaml | 4 +++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index fb557834..2a171ba2 100644
--- 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
index 966bdbcb..69b3429d 100644
--- 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.