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

api: Allow patching a stream recordingSpec #2220

Merged
merged 4 commits into from
Jun 18, 2024
Merged

Conversation

victorges
Copy link
Member

@victorges victorges commented Jun 17, 2024

What does this pull request do? Explain your changes. (required)

This was initially to add support for patching a stream's recordingSpec field.

On the way to that, I spotted a few improvements or fixes that were necessary
in the multiple "profiles" fields we have in the schema. I've included those here.

Specific updates (required)

  • Add documentation to stream's and asset's profiles
  • Reference doc from payloads
  • Use right type for recordingSpec.profiles
  • Propagate profiles on upload APIs as well (didn't know they already were configurable there)
  • Avoid some repetition by cross-referencing payloads
  • Add validation to the recordingSpec field when creating a stream
  • Finally, add support for PATCHing a stream's recordingSpec, copying over the same validation logic

How did you test each of these updates (required)
yarn test

Does this pull request close any open issues?
Implements ENG-2110

Checklist

  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.

- Add documentation to stream's and asset's profiles
- Reference doc from payloads
- Use right type for recordingSpec.profiles
- Propagate profiles on upload APIs as well (didn't know they already were configurable there)
- Avoid some repetition by cross-referencing payloads
@victorges victorges requested a review from a team as a code owner June 17, 2024 17:27
Copy link

vercel bot commented Jun 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
livepeer-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 17, 2024 6:05pm

@victorges victorges merged commit 66a2165 into master Jun 18, 2024
8 checks passed
@victorges victorges deleted the vg/feat/patch-records branch June 18, 2024 15:27
Copy link
Member

@0xcadams 0xcadams left a comment

Choose a reason for hiding this comment

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

LGTM

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