Skip to content
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

Support Prefer: return header for /results endpoint #727

Open
9 tasks
fmigneault opened this issue Oct 5, 2024 · 0 comments
Open
9 tasks

Support Prefer: return header for /results endpoint #727

fmigneault opened this issue Oct 5, 2024 · 0 comments
Assignees
Labels
feature/job Issues related to job execution, reporting and logging. triage/feature New requested feature.

Comments

@fmigneault
Copy link
Collaborator

fmigneault commented Oct 5, 2024

Description

Allow Prefer to request an alternative GET /jobs/{jobId}/results response representation.

When Prefer: return=minimal|representation, response=raw|document and/or output-specific transmissionMode: value|reference are used during Job execution request, the results are adjusted accordingly for the response.

Note

since response and outputs cannot be submitted again in the GET results request, requesting a Prefer should rely only on OGC API - Processes v2.0 return strategies. However, a response=raw|document query parameter might be considered.

Requirements

  • Using a subsequent request to /results using Prefer should allow "ignoring" the original results representation saved in the Job.
  • Using a ?response=raw|document query parameter for /results would allow doing the similar resolution to the response body parameter during job submission.
  • Support outputs query parameter for /results #733
  • Add test to validate combinations, for single output and multi-output cases
  • Combining with Accept should allow appropriate resolution
  • Resolution of the various Prefer/response/Accept combinations must be equivalent to the resolution order of job submission (see job execution results #713)

References

@fmigneault fmigneault added the triage/feature New requested feature. label Oct 5, 2024
@fmigneault fmigneault self-assigned this Oct 5, 2024
@fmigneault fmigneault added the feature/job Issues related to job execution, reporting and logging. label Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature/job Issues related to job execution, reporting and logging. triage/feature New requested feature.
Projects
None yet
Development

No branches or pull requests

1 participant