Skip to content

clarification: canonical (signed) batch job result URL + partial query param? #507

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.

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

Closed
soxofaan opened this issue Sep 7, 2023 · 1 comment · Fixed by #513
Closed

clarification: canonical (signed) batch job result URL + partial query param? #507

soxofaan opened this issue Sep 7, 2023 · 1 comment · Fixed by #513
Milestone

Comments

@soxofaan
Copy link
Member

soxofaan commented Sep 7, 2023

I'm working on crossbackend job execution in aggeragtor (Open-EO/openeo-aggregator#115).

One of the pieces of the current solution we aim for is leveraging "partial" result listings through the partial parameter e.g. /jobs/{job_id}/results?partial=true.
However we also require signed URLs through a "canonical" link in /jobs/{job_id}/results, e.g. possibly https://whatever.com/azerty123 (where the azerty123 is an opaque blob that securely can be resolved to the original batch job result listing)

It is not completely clear how the partial=true should be included in the signed URL: should it be encoded automatically in the opaque blob, or should the user add it explicitly, e.g. https://whatever.com/azerty123?partial=true?

I guess it's the former, but we might have to clarify that a bit .

E.g. current description state:

It is strongly recommended to add a link with relation type canonical, which points to this STAC document using a signed URL. This way the STAC metadata can be used by non-openEO clients without additional authentication steps.

e.g.

... which points to this STAC document (including all query parameters like partial) using a signed URL...

@m-mohr
Copy link
Member

m-mohr commented Sep 8, 2023

I guess it's the former, but we might have to clarify that a bit .

Yeah, that makes sense to me, too.

See PR #513 for an updated view on this.

@m-mohr m-mohr added this to the 1.3.0 milestone Sep 8, 2023
soxofaan added a commit to soxofaan/openeo-api that referenced this issue Sep 29, 2023
soxofaan added a commit to soxofaan/openeo-api that referenced this issue Feb 7, 2025
soxofaan added a commit to soxofaan/openeo-api that referenced this issue Feb 7, 2025
m-mohr added a commit that referenced this issue Feb 14, 2025
…uery parameters (#513)

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

* Issue #507/#513 improve clarification of including query parameters in canonical URL

---------

Co-authored-by: Matthias Mohr <m.mohr@uni-muenster.de>
@m-mohr m-mohr closed this as completed Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants