Skip to content

docs: Add API documentation for listing transcoding jobs#93

Merged
Anif7 merged 2 commits intomainfrom
doc-listing-jobs
Mar 3, 2026
Merged

docs: Add API documentation for listing transcoding jobs#93
Anif7 merged 2 commits intomainfrom
doc-listing-jobs

Conversation

@Anif7
Copy link
Contributor

@Anif7 Anif7 commented Mar 3, 2026

  • Transcoding Jobs listing endpoint lacked dedicated documentation
  • Clients did not have clear guidance on filtering, ordering, and pagination behavior
  • Add documentation describing listing capability, supported query parameters, ordering options, and paginated response structure

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the API documentation by introducing a dedicated section for listing transcoding jobs. The changes aim to provide developers with explicit instructions on how to interact with this endpoint, covering essential aspects like query parameters for filtering and ordering, as well as the expected paginated response format. This enhancement ensures clients have clear guidance, reducing ambiguity and improving usability of the transcoding service API.

Highlights

  • New API Documentation: Added comprehensive documentation for the Transcoding Jobs listing endpoint, which was previously lacking.
  • Guidance on Filtering and Ordering: Provided clear guidance on how to filter transcoding jobs by status and DRM enablement, and how to order them by creation time.
  • Pagination Details: Included details on the paginated response structure for the listing endpoint, enhancing client understanding.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docs/transcoding-service/get-transcoding-job-details.md
    • Updated the sidebar position from 3 to 4.
  • docs/transcoding-service/list-all-transcoding-jobs.md
    • Added a new documentation file for listing all transcoding jobs.
    • Detailed the GET API endpoint for listing jobs.
    • Documented query parameters for filtering by status and DRM, and ordering by creation time.
    • Included an example request demonstrating filter usage.
    • Provided a sample paginated JSON response.
  • docs/transcoding-service/transcoding-cancelation.md
    • Updated the sidebar position from 4 to 5.
  • docs/transcoding-service/transcoding-service-introduction.md
    • Inserted a new link to the 'List all Transcoding Jobs' documentation.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds API documentation for listing transcoding jobs. The new documentation is comprehensive, covering the endpoint, query parameters for filtering and ordering, and a sample paginated response. I've suggested a few minor improvements to enhance clarity and consistency. Specifically, I've recommended formatting the example request URL as a code block for better readability and aligning the casing of the status field in the sample response with the query parameter documentation. These changes will help ensure developers have a clear and consistent guide to using the API.

@Anif7 Anif7 merged commit 2eee1fe into main Mar 3, 2026
3 checks passed
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.

1 participant