Skip to content

feat:Standardize model naming in OpenAPI documentation#163

Merged
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202603161004
Mar 16, 2026
Merged

feat:Standardize model naming in OpenAPI documentation#163
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202603161004

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Mar 16, 2026

Summary by CodeRabbit

  • Documentation
    • Updated model naming conventions to use standardized formatting for consistency across API documentation.

@HavenDV HavenDV merged commit 07bb8e1 into main Mar 16, 2026
1 of 3 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202603161004 branch March 16, 2026 10:05
@coderabbitai
Copy link

coderabbitai bot commented Mar 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fb8be5ae-de28-4160-b1a7-9a206bdbfe26

📥 Commits

Reviewing files that changed from the base of the PR and between 3af3129 and 93be833.

⛔ Files ignored due to path filters (2)
  • src/libs/AssemblyAI/Generated/AssemblyAI.Models.Transcript.g.cs is excluded by !**/generated/**
  • src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParams.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/AssemblyAI/openapi.yaml

Walkthrough

Updated OpenAPI specification documentation to standardize model naming conventions, replacing "Universal-3-Pro" with "Universal-3 Pro" across multiple description fields related to transcripts, prompts, and parameter annotations.

Changes

Cohort / File(s) Summary
Model Naming Standardization
src/libs/AssemblyAI/openapi.yaml
Corrected spacing in model references from "Universal-3-Pro" to "Universal-3 Pro" across keyterms prompts, note descriptions, and parameter documentation for consistent formatting throughout the specification.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

🐰 A dash becomes a space so fine,
Where "Universal-3" learns to shine,
Pro formatting, clean and bright—
Documentation done just right! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title Check ✅ Passed Title check skipped as CodeRabbit has written the PR title.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bot/update-openapi_202603161004
📝 Coding Plan
  • Generate coding plan for human review comments

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

You can customize the high-level summary generated by CodeRabbit.

Configure the reviews.high_level_summary_instructions setting to provide custom instructions for generating the high-level summary.

@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Standardize model naming in OpenAPI documentation Mar 16, 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.

1 participant