Fix API Key Using Property

[davidvonthenen]

Proposed changes

Addresses: https://github.com/deepgram/deepgram-dotnet-sdk/issues/342, https://github.com/deepgram/deepgram-dotnet-sdk/issues/346

Tested using microphone streaming example.

Types of changes

What types of changes does your code introduce to the community .NET SDK? Put an x in the boxes that apply

• [x] Bugfix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• [x] I have read the CONTRIBUTING doc
• [x] I have lint'ed all of my code using repo standards
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] I have added necessary documentation (if appropriate)

Further comments

NA

Summary by CodeRabbit

• New Features

  • Enhanced logging for ApiKey and BaseAddress in client options, improving visibility during initialization.
  • Improved validation for ApiKey in both DeepgramHttpClientOptions and DeepgramWsClientOptions.

• Bug Fixes

  • Removed the DetectTopics property from the Config record to address an identified error.

• Refactor

  • Updated constructor logic in DeepgramHttpClientOptions and DeepgramWsClientOptions for better error handling and configuration validation.

[coderabbitai[bot]]

Walkthrough

The pull request introduces modifications to the DeepgramHttpClientOptions and DeepgramWsClientOptions classes, primarily focusing on the constructor logic for handling the ApiKey property. Enhancements include conditional checks for empty or whitespace ApiKey values, improved logging for various parameters, and refined error handling. Additionally, the Config record in the Deepgram.Models.Manage.v1 namespace has seen the removal of the DetectTopics property, which has been commented out due to an error. Overall, these changes aim to improve validation and logging mechanisms within the client configuration.

Changes

File Path	Change Summary
Deepgram/Models/Authenticate/v1/DeepgramHttpClientOptions.cs	Modified constructor to include checks and logging for ApiKey, refined BaseAddress handling, and retained error handling for invalid ApiKey.
Deepgram/Models/Authenticate/v1/DeepgramWsClientOptions.cs	Updated constructor to check and log ApiKey, improved error handling, and refined BaseAddress management.
Deepgram/Models/Manage/v1/Config.cs	Commented out DetectTopics property due to an error, while retaining the rest of the properties.

Possibly related PRs

• #337: The changes in the DeepgramWsClientOptions class constructor are similar to those in the DeepgramHttpClientOptions class, as both involve modifications to the handling of the ApiKey property and logging enhancements.
• #340: This PR focuses on error handling related to WebSocket connections, which aligns with the error handling improvements made in the DeepgramHttpClientOptions constructor regarding the ApiKey.
• #343: Modifications to the Stop method in the IListenWebSocketClient interface relate to overall client configuration and error handling, similar to changes made in the DeepgramHttpClientOptions class.
• #349: The removal of the plain Send() method enhances API design, consistent with improvements made in the DeepgramHttpClientOptions class regarding API key handling and logging.

Suggested reviewers

• lukeocodes
• jpvajda
• naomi-lgbt

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@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 generate unit testing code.` - `@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.` 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.