feat:Flatten LemurTaskParams schema by embedding LemurBaseParams properties

[HavenDV]

Summary by CodeRabbit

• New Features

  • Expanded support for additional input parameters when configuring Lemur tasks, including transcript IDs, input text, model selection, output size, and temperature settings.

• Documentation

  • Updated schema documentation to reflect new required fields and available parameters for Lemur tasks.

[coderabbitai]

Walkthrough

The schema for LemurTaskParams in the OpenAPI specification was modified to directly include properties from LemurBaseParams, removing inheritance. Additional properties were added, required fields updated, and the example adjusted. The schema hierarchy was flattened by embedding all relevant parameters within LemurTaskParams.

Changes

Cohort / File(s)	Change Summary
LemurTaskParams Schema Flattening src/libs/AssemblyAI/openapi.yaml	Expanded LemurTaskParams to directly define properties from LemurBaseParams, updated required fields, removed inheritance, and revised example.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

In YAML fields, the schemas grow,
Flattened roots where base once flowed.
Now Lemur’s tasks are clear and neat,
With all their traits in one retreat.
A rabbit hops and gives a cheer—
For tidy specs bring joy this year! 🐇✨

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch bot/update-openapi_202507310926

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🔭 Outside diff range comments (1)

src/libs/AssemblyAI/openapi.yaml (1)

5641-5647: context field silently dropped – this is an un-documented breaking change
LemurTaskParams previously inherited context through LemurBaseParams.
By flattening the schema but not re-adding context, the parameter is no longer accepted for the /lemur/v3/generate/task endpoint.
Any client that relied on passing extra context will now fail validation at runtime.
Please either:

1. Restore the field, or
2. Explicitly document the removal and bump the API version.

             prompt:
               x-label: Prompt
               description: Your text to prompt the model to produce a desired output, including any context you want to pass into the model.
               type: string
+            context:
+              x-label: Context
+              description: Context to provide the model. This can be a string or any free-form JSON value.
+              oneOf:
+                - type: string
+                - type: object
+                  additionalProperties: true

🧹 Nitpick comments (1)

src/libs/AssemblyAI/openapi.yaml (1)

5647-5663: Schema duplication increases maintenance risk
transcript_ids and input_text are now defined twice (here and in LemurBaseParams).
Any future tweak (e.g. description wording, limits) will have to be applied in two places and will diverge easily.

Prefer keeping a single source of truth – e.g. keep the allOf: [$ref: LemurBaseParams] and override only the few fields that really need to differ, or extract these common properties into a reusable component.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eaafad3 and 5b7a0d3.

⛔ Files ignored due to path filters (3)

• src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.LemurTaskParams.g.cs is excluded by !**/generated/**
• src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurTaskParams.g.cs is excluded by !**/generated/**
• src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurTaskParamsVariant1.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/AssemblyAI/openapi.yaml (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/libs/AssemblyAI/openapi.yaml (2)

src/libs/AssemblyAI/Conversions/LemurTaskParams.cs (2)

• struct (5-36)
• FromPrompt (25-35)

src/libs/AssemblyAI/Conversions/LemurTaskParamsVariant1.cs (2)

• FromPrompt (24-30)
• LemurTaskParamsVariant1 (5-31)

🔇 Additional comments (1)

src/libs/AssemblyAI/openapi.yaml (1)

5664-5670: Restore string fallback for final_model to preserve custom model support

In src/libs/AssemblyAI/openapi.yaml (around lines 5664–5670), the final_model schema was changed from accepting either a known LemurModel or an arbitrary string to only allowing LemurModel. Removing the string branch will break any callers supplying ad-hoc model IDs.

If you intend to continue supporting custom model identifiers, please revert to:

-              oneOf:
-                - $ref: "#/components/schemas/LemurModel"
+              anyOf:
+                - $ref: "#/components/schemas/LemurModel"
+                - type: string

Otherwise, confirm that disallowing arbitrary strings is an intentional breaking change.