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

Add ADR for a query option to filter get_urls #88

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

philipnbbc
Copy link
Contributor

Details

This PR adds an ADR that proposes a accept_get_urls query option to filter flow segment get_urls. This allows clients to indicate that pre-signed URLs are not required, potentially significantly reducing the request time when requesting a large number of flow segments.

Pivotal Story (if relevant)

Story URL: https://www.pivotaltracker.com/story/show/187930100

Related PRs

Where appropriate. Indicate order to be merged.

Submitter PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • API version has been incremented if necessary
  • ADR status has been updated, and ADR implementation has been recorded
  • Documentation updated (README, etc.)
  • PR added to Pivotal story (if relevant)
  • Follow-up stories added to Pivotal

Reviewer PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • Design makes sense, and fits with our current code base
  • Code is easy to follow
  • PR size is sensible
  • Commit history is sensible and tidy

Info on PRs

The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.

@philipnbbc philipnbbc requested a review from a team as a code owner September 17, 2024 16:48
Copy link
Contributor

@AndrewGibb AndrewGibb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A suggested change and a typo.

Once changed, LGTM.

docs/adr/0023-filter-segment-get-urls.md Outdated Show resolved Hide resolved
api/TimeAddressableMediaStore.yaml Outdated Show resolved Hide resolved
api/TimeAddressableMediaStore.yaml Outdated Show resolved Hide resolved
@philipnbbc
Copy link
Contributor Author

This PR will be left open for now as further discussion is needed to understand whether it fits the requirements or not.

@j616
Copy link
Contributor

j616 commented Nov 18, 2024

Follow the Workshop where this was discussed, we should also update the App Note describing the get_url label format to add an extra .presigned element. i.e. <provider>.<region[optional]>.<availabilityZone[optional]>:<storeType>.<presigned[optional]>:<storeName> which may be used as such example-cloud-provider.eu-west-1.a:example-storage-product.presigned:example-store-name

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants