Update video README with transcoding #2411
Conversation
videos/README.md
Outdated
|
|
||
| # Testing PRs with Transcoding | ||
|
|
||
| When working on or reviewing a PR that requires a video to be uploaded to YouTube, the transcode request needs to be simulated. To do that, first set `API_BEARER_TOKEN` in the `.env` file to some string. Then, use Postman or an equivalent tool to POST a message to `https://localhost:8043/api/transcode-jobs/`, with authorization set to the `API_BEARER_TOEN` and with the body as in [this example](/test_videos_webhook/cloudwatch_sns_complete.json), updated to match the relevant environment variables, course name, and video name. |
There was a problem hiding this comment.
@pt2302, I think the instructions here are a bit vague. We should mention that the endpoint here simulates a callback from the transcoding service. We should also mention that the sample payload /test_videos_webhook/cloudwatch_sns_complete.json should be updated with relevant values and used after the actual transcoding job with media conversion has been completed. Simulating the callback without job completion may lead to ambiguous states.
Should we put a reference to Matt's PR or bring more details from it regarding AWS setup?
Additionally, the https://localhost:8043/api/transcode-jobs/ endpoint does not require authorization. It allows unrestricted access. I used cURL with only content-type: application/json.
What are the relevant tickets?
Closes https://github.com/mitodl/hq/issues/6559.
Description (What does it do?)
This PR adds documentation about submitting video transcode requests locally, which is required for developing or testing any PRs that include videos submitted to YouTube.
How can this be tested?
Verify that the instructions in the new README section
Testing PRs with Transcodingare complete and correct.