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

[docs] Add example requests to API Reference #775

Merged
merged 4 commits into from
Sep 20, 2024
Merged

Conversation

brzep
Copy link
Collaborator

@brzep brzep commented Sep 18, 2024

PR for #752

Added example requests to RTP/MP4/DeckLink pages to make going to HTTP Routes page not necessary.
Requests are split into two code blocks to make copying request json easier.

image image

"audio": {
"decoder": "opus"
},
"required": true,
Copy link
Member

Choose a reason for hiding this comment

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

I think that we should emphasize in docs, that setting required to true for failable streams will stop the entire processing of the LiveCompositor once such input fails/stops sending data and avoid setting it to true in example requests.

Copy link
Member

Choose a reason for hiding this comment

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

agree, but I don't think setting it to true is the issue here, specifying this field at all in the example is more of a problem

@WojciechBarczynski
Copy link
Member

@brzep BTW you don't have to assign the entire team for review. Usually assigning 1 or 2 team members should be enough.

@brzep
Copy link
Collaborator Author

brzep commented Sep 18, 2024

I know I don't have to assign everyone (normally I don't do that), but I assumed it's a very simple change and reviewing it will take like 2 minutes, so more people can do it. I think with the docs the more people see them, possibly the more feedback I'll receive so they'll be more user friendly.

Copy link
Member

@wkozyra95 wkozyra95 left a comment

Choose a reason for hiding this comment

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

Example requests should include stuff that is required, or optional fields that most use will need to specify. Stuff like offset/required/ffmpeg_options do not help here

docs/pages/api/inputs/decklink.md Outdated Show resolved Hide resolved
docs/pages/api/inputs/decklink.md Outdated Show resolved Hide resolved
docs/pages/api/inputs/decklink.md Outdated Show resolved Hide resolved
docs/pages/api/inputs/mp4.md Outdated Show resolved Hide resolved
docs/pages/api/inputs/rtp.md Outdated Show resolved Hide resolved
docs/pages/api/outputs/mp4.md Outdated Show resolved Hide resolved
docs/pages/api/outputs/mp4.md Outdated Show resolved Hide resolved
@brzep brzep merged commit 599fbdf into master Sep 20, 2024
3 checks passed
@brzep brzep deleted the @brzep/docs-add-links branch September 20, 2024 08:33
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