Skip to content

Return the RTMP publishing address from register_rtmp_input - #95

Open
Gawor270 wants to merge 1 commit into
mainfrom
fce-3761
Open

Return the RTMP publishing address from register_rtmp_input#95
Gawor270 wants to merge 1 commit into
mainfrom
fce-3761

Conversation

@Gawor270

Copy link
Copy Markdown
Member

Description

The composition API now reports a complete RTMP publish URL where it previously reported only a port.

  • Regenerated the composition client: RegisterInputResponse.port is replaced by publish_url, and register-input handles the 503 it can now answer with
  • register_rtmp_input returns the publish URL instead of None, raising InternalServerError when the server omits it
  • Covered the new return value and the missing-address case in tests

Motivation and Context

The publish address can no longer be derived from the composition origin and a port, so the server supplies the whole URL.

Documentation impact

  • Documentation update required

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

The register-input response now reports publish_url in place of port, so the
caller no longer has to build an address from the composition origin and a
port. Regenerated the composition client, which also picks up the 503 the
endpoint can now answer with.
@linear

linear Bot commented Sep 10, 2026

Copy link
Copy Markdown

FCE-3761

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The changes are consistent across client, generated types, and tests, and the updated behavior is explicitly covered by new test cases.

Pull request overview

This PR updates the Composition API client to return the full RTMP publish URL from register_rtmp_input, reflecting a server-side change where the publish address can no longer be derived from the composition origin + port.

Changes:

  • Updated CompositionClient.register_rtmp_input to return a str publish URL and raise InternalServerError when it’s missing.
  • Regenerated Composition OpenAPI client pieces to replace RegisterInputResponse.port with publish_url and to parse documented 503 responses for input registration.
  • Added/updated tests covering the new return value and the missing-publish-url error case.
File summaries
File Description
tests/test_composition.py Adds RTMP publish URL fixtures and tests the new return value + missing-address error behavior.
fishjam/api/_composition_client.py Changes register_rtmp_input to return the server-chosen publish URL and error if absent.
fishjam/_composition_openapi_client/models/register_input_response.py Replaces port with publish_url in the generated response model.
fishjam/_composition_openapi_client/api/inputs/register_input.py Updates the generated response parsing to handle 503 as an ApiError.
Review details
  • Files reviewed: 4/4 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@Gawor270 Gawor270 self-assigned this Sep 10, 2026
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.

2 participants