swagger documentation: document /live endpoint
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 88
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
This is the HTTP video ingest endpoint. Technically this isn't on the API, it's on broadcasters, but I think we'd _like_ it to be on the API at some point. Regardless, this is a good place to document the endpoint and its quirks such as the `content-duration` and `content-resolution` headers.
Here's an example of using it:
```bash
curl -XPOST -d @8.ts -H "authorization: Bearer 2de47e83-9c9f-4d2e-a9f1-7c798a01ddc3" -H "content-duration: 2030" -H "content-resolution: 1280x720" https://aks-default-16253462-vmss000000.livepeer.live/live/c25cb445-34df-44b6-aa4b-a5e0a4c207d3/8.ts
```
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the repository's Swagger/OpenAPI documentation and the existing description of the broadcaster HTTP endpoints. Document POST /live using the provided curl example, including the content-duration and content-resolution headers and the endpoint's quirks. Done means the endpoint and its usage are represented in the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100