Skip to content

Commit

Permalink
Issue Open-EO#507/Open-EO#513 improve clarification of including quer…
Browse files Browse the repository at this point in the history
…y parameters in canonical URL
  • Loading branch information
soxofaan committed Feb 7, 2025
1 parent b0f8864 commit 1f41ffb
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `GET /file_formats`: Base parameter 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
- `GET /jobs/{job_id}/results`: Clarify that signed URLs (used as "canonical" link) should be regenerated each time.
- 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`
- `GET /jobs/{job_id}/results`: Clarify that "canonical" job result link should include/encode the original query parameters

## [1.2.0] - 2021-05-25

Expand Down
5 changes: 4 additions & 1 deletion openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4039,7 +4039,10 @@ components:
default.
It is **strongly recommended** to add a link with relation type
`canonical` pointing to this STAC document using a signed URL
`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.
(including all query parameters like `partial`).
This signed URL allows consumption of the STAC metadata
by (possibly non-openEO) clients and tools
Expand Down

0 comments on commit 1f41ffb

Please sign in to comment.