Skip to content

feat:Replace $ref with inline types in List transcripts endpoint#152

Merged
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202603041252
Mar 4, 2026
Merged

feat:Replace $ref with inline types in List transcripts endpoint#152
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202603041252

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Mar 4, 2026

Summary by CodeRabbit

  • Documentation
    • Enhanced API specification for the List transcripts endpoint with explicit parameter definitions and constraints.

@HavenDV HavenDV merged commit 6505ce2 into main Mar 4, 2026
3 of 4 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202603041252 branch March 4, 2026 12:53
@coderabbitai
Copy link

coderabbitai bot commented Mar 4, 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: ec6dc889-3d0c-4587-b4e9-b3b734f6bc36

📥 Commits

Reviewing files that changed from the base of the PR and between 8395886 and ec793bd.

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

Walkthrough

The OpenAPI schema for the List transcripts endpoint was refactored to replace $ref-based parameter definitions with inline scalar type declarations. Parameters (limit, created_on, before_id, after_id, throttled_only) now explicitly define their types and constraints within the schema.

Changes

Cohort / File(s) Summary
API Schema Definition
src/libs/AssemblyAI/openapi.yaml
Converted 5 List transcripts parameters from $ref references to inline definitions with explicit types (integer, string with format constraints) and default values.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Hops through schemas with glee,
References gone, definitions run free,
Parameters now explicit and clear,
Inline constraints bring structure dear!
A simpler path for the API to see.

🚥 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_202603041252

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.

@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Replace $ref with inline types in List transcripts endpoint Mar 4, 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