swagger documentation: document /api/broadcaster, /api/orchestrator, and /api/orchestrator/external/:UUID
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 88
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
These endpoints all return cluster-specific or geo-located information about broadcasters and orchestrators.
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 documentation or API specification entry point, then inspect how endpoint definitions are organized. Document /api/broadcaster, /api/orchestrator, and /api/orchestrator/external/:UUID, including their cluster-specific or geo-located responses; done means all three endpoints are represented in the Swagger documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100