runner: add data_url to route/pipeline and codegen #710
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for a data_url parameter to the live video-to-video pipeline functionality to enable data publishing via the Trickle protocol. The change adds the new parameter across the API specification, route definitions, and pipeline implementation.
- Adds
data_urlfield to OpenAPI specifications for both runner and gateway - Updates the route parameter model to include the new
data_urlfield - Modifies the pipeline implementation to accept and pass through the
data_urlparameter
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| runner/openapi.yaml | Adds data_url field definition to API schema |
| runner/gateway.openapi.yaml | Adds data_url field definition to gateway API schema |
| runner/app/routes/live_video_to_video.py | Adds data_url parameter to route model |
| runner/app/pipelines/live_video_to_video.py | Updates pipeline method signature and data passing to include data_url |
| description: URL for publishing events via Trickle protocol for pipeline | ||
| status and logs. | ||
| default: '' | ||
| data_url: | ||
| type: string | ||
| title: Data Url | ||
| description: URL for publishing data via Trickle protocol for pipeline status | ||
| and logs. |
There was a problem hiding this comment.
The description for data_url is identical to events_url except for the word 'data' vs 'events'. This doesn't clearly explain what distinguishes data_url from events_url or what type of data will be published through this URL.
| description: URL for publishing events via Trickle protocol for pipeline | |
| status and logs. | |
| default: '' | |
| data_url: | |
| type: string | |
| title: Data Url | |
| description: URL for publishing data via Trickle protocol for pipeline status | |
| and logs. | |
| description: URL for publishing event-related information, such as pipeline | |
| status updates and logs, via the Trickle protocol. | |
| default: '' | |
| data_url: | |
| type: string | |
| title: Data Url | |
| description: URL for publishing data outputs generated by the pipeline, such as | |
| processed video frames or analysis results, via the Trickle protocol. |
Copilot uses AI. Check for mistakes.
| description: URL for publishing events via Trickle protocol for pipeline | ||
| status and logs. | ||
| default: '' | ||
| data_url: | ||
| type: string | ||
| title: Data Url | ||
| description: URL for publishing data via Trickle protocol for pipeline status | ||
| and logs. |
There was a problem hiding this comment.
The description for data_url is identical to events_url except for the word 'data' vs 'events'. This doesn't clearly explain what distinguishes data_url from events_url or what type of data will be published through this URL.
| description: URL for publishing events via Trickle protocol for pipeline | |
| status and logs. | |
| default: '' | |
| data_url: | |
| type: string | |
| title: Data Url | |
| description: URL for publishing data via Trickle protocol for pipeline status | |
| and logs. | |
| description: URL for publishing events, such as pipeline status updates and | |
| logs, via the Trickle protocol. | |
| default: '' | |
| data_url: | |
| type: string | |
| title: Data Url | |
| description: URL for publishing processed data or intermediate results via | |
| the Trickle protocol. |
Copilot uses AI. Check for mistakes.
| description="URL for publishing events via Trickle protocol for pipeline status and logs.", | ||
| ), | ||
| ] | ||
| data_url: Annotated[ | ||
| str, | ||
| Field( | ||
| default="", | ||
| description="URL for publishing data via Trickle protocol for pipeline status and logs.", |
There was a problem hiding this comment.
The description for data_url is identical to events_url except for the word 'data' vs 'events'. This doesn't clearly explain what distinguishes data_url from events_url or what type of data will be published through this URL.
| description="URL for publishing events via Trickle protocol for pipeline status and logs.", | |
| ), | |
| ] | |
| data_url: Annotated[ | |
| str, | |
| Field( | |
| default="", | |
| description="URL for publishing data via Trickle protocol for pipeline status and logs.", | |
| description="URL for publishing pipeline status updates and logs via the Trickle protocol.", | |
| ), | |
| ] | |
| data_url: Annotated[ | |
| str, | |
| Field( | |
| default="", | |
| description="URL for publishing processed data or results generated by the pipeline via the Trickle protocol.", |
Copilot uses AI. Check for mistakes.
Bare bones required changes to enable data_url in go-livepeer PR
Enables livepeer/go-livepeer#3689