Skip to content

Issue #507: clarify that "canonical" job result link should include query parameters #513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 14, 2025
Merged

Issue #507: clarify that "canonical" job result link should include query parameters #513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6c0fe73
Issue #507: clarify that "canonical" job result link should include q…
soxofaan Sep 29, 2023
b0f8864
Merge branch 'draft' into issue507-signed-URL-partial
m-mohr Feb 6, 2025
66fb9ce
Issue #507/#513 improve clarification of including query parameters i…
soxofaan Feb 7, 2025
90f6671
Merge branch 'draft' into issue507-signed-URL-partial
m-mohr Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
3 changes: 3 additions & 0 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down