chore: improve name for future base exception

[2ynn]

In an upcoming release, all SDK exceptions will inherit from a base exception to ease error handling. Given that the default exception is currently named APIException, this PR aims at improving naming consistency by editing the baseErrorName configuration parameter. Note this configuration change is a no-op for now and will only have effect once the new Error handling feature is released.

Summary by CodeRabbit

• Refactor
  • Renamed the base exception type in the C# SDK from “NovuError” to “BaseException” to align error handling.
  • This may require updating references in applications that catch or extend the previous exception type.

[coderabbitai]

Walkthrough

Updated the C# code generation configuration in .speakeasy/gen.yaml by changing baseErrorName from NovuError to BaseException.

Changes

Cohort / File(s)	Summary
Codegen configuration ./.speakeasy/gen.yaml	In csharp section, updated baseErrorName value from NovuError to BaseException.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I twitch my ears at configs fine,
A name swap hops along the line—
NovuError bids adieu,
BaseException hops into view.
Carrots checked, builds aligned,
One tiny change, release refined.

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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

🧹 Nitpick comments (2)

.speakeasy/gen.yaml (2)

27-27: Consider a product-scoped base exception name (e.g., NovuException) instead of the generic “BaseException”.

“BaseException” is very generic and can be confused with Python’s root exception. In .NET ecosystems it’s conventional to brand the base exception (e.g., NovuException or NovuSdkException) to avoid ambiguity and improve discoverability. This also reduces the chance of type-name collisions across libraries.

Suggested change:

-  baseErrorName: BaseException
+  baseErrorName: NovuException

---

27-27: Optional: Document the upcoming change in RELEASE/CHANGELOG to minimize surprises.

Even if this is a no-op today, a future swap-in of a differently named base type can be perceived as a breaking change by users who reference exception types directly. A short note in the changelog or migration guide will help set expectations.

Happy to draft the release note snippet when you’re ready.

📜 Review details

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

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between ac3e741 and 2d5cc57.

📒 Files selected for processing (1)

• .speakeasy/gen.yaml (1 hunks)

🔇 Additional comments (1)

.speakeasy/gen.yaml (1)

27-27: Confirm baseErrorName is a no-op today and prepare for future inheritance

• I ran a repository-wide search for NovuError, BaseException, NovuException, APIException, baseErrorName, and defaultErrorName.
  • There are zero mentions of BaseException (or the old NovuError/NovuException) in code or docs.
  • All thrown errors are Novu.Models.Errors.APIException, defined in src/Novu/Models/Errors/APIException.cs.
• As expected, adding baseErrorName: BaseException in .speakeasy/gen.yaml does not change the existing SDK today.
• Once the Speakeasy C# generator’s feature flag rolls out, it should generate exceptions (e.g. APIException) that inherit from your new BaseException per generator semantics.

Please verify with the Speakeasy C# generator documentation or a sample generation run that, under the feature flag, APIException : BaseException (and other exceptions likewise) is produced.