Skip to content

Commit 1f41ffb

Browse files
committed
Issue Open-EO#507/Open-EO#513 improve clarification of including query parameters in canonical URL
1 parent b0f8864 commit 1f41ffb

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1919
- `GET /file_formats`: Base parameter on top of normal JSON Schema, not Process JSON Schema
2020
- `PATCH /services/{service_id}` and `PATCH /jobs/{job_id}`: Explicitly allow updating back-end specific properties (as in `POST`)
2121
- `GET /services/{service_id}` and `GET /jobs/{job_id}`: Explicitly allow listing back-end specific properties (as provided in `POST`)
22-
- `GET /jobs/{job_id}/results`: Clarify that "canonical" job result link should include query parameters
2322
- `GET /jobs/{job_id}/results`: Clarify that signed URLs (used as "canonical" link) should be regenerated each time.
2423
- Clarified for log levels which default values apply
2524
- 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)
2625
- Clarified the behaviour of `federation:backends` for `POST /validation`
26+
- `GET /jobs/{job_id}/results`: Clarify that "canonical" job result link should include/encode the original query parameters
2727

2828
## [1.2.0] - 2021-05-25
2929

openapi.yaml

+4-1
Original file line numberDiff line numberDiff line change
@@ -4039,7 +4039,10 @@ components:
40394039
default.
40404040
40414041
It is **strongly recommended** to add a link with relation type
4042-
`canonical` pointing to this STAC document using a signed URL
4042+
`canonical` pointing to this STAC document using a signed URL.
4043+
Note that query parameters that influence the response of the current request
4044+
(like `partial`) MUST also be included or encoded within the signed URL
4045+
in order to give a consistent response when the signed URL is used.
40434046
(including all query parameters like `partial`).
40444047
This signed URL allows consumption of the STAC metadata
40454048
by (possibly non-openEO) clients and tools

0 commit comments

Comments
 (0)