Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Missing ExpirationDate Field on Key Object #320

Merged
merged 1 commit into from
Aug 1, 2024

Conversation

davidvonthenen
Copy link
Contributor

@davidvonthenen davidvonthenen commented Jul 31, 2024

Proposed changes

Addresses issue: #319

Types of changes

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

  • 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.

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

Further comments

NA

Summary by CodeRabbit

  • New Features

    • Introduced an ExpirationDate property for API keys, allowing better management of key lifecycle.
  • Documentation

    • Added XML documentation to clarify the purpose of the new ExpirationDate property.

Copy link
Contributor

coderabbitai bot commented Jul 31, 2024

Walkthrough

The recent update introduces a new ExpirationDate property in the Key record of the Deepgram API. This nullable DateTime field allows for tracking the expiration date of API keys, enhancing their management. The property includes XML documentation for clarity and is configured to be excluded from JSON serialization when it is null, improving the overall usability and functionality of API key handling.

Changes

Files Change Summary
Deepgram/Models/Manage/v1/Key.cs Added ExpirationDate property (nullable DateTime) to track API key expiration; includes XML docs and JSON serialization settings.

Possibly related issues


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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c4bb711 and 5bd80d1.

Files selected for processing (1)
  • Deepgram/Models/Manage/v1/Key.cs (1 hunks)
Additional comments not posted (1)
Deepgram/Models/Manage/v1/Key.cs (1)

51-56: LGTM! Verify JSON serialization attributes.

The ExpirationDate property is well-documented and follows the existing pattern. Ensure that the JsonIgnore and JsonPropertyName attributes are correctly applied.

Verification successful

Verified! The JSON serialization attributes for the ExpirationDate property are correctly applied.

The ExpirationDate property in Deepgram/Models/Manage/v1/Key.cs has the appropriate JsonIgnore and JsonPropertyName attributes, ensuring correct JSON serialization behavior.

  • JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)
  • JsonPropertyName("expiration_date")
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the JSON serialization attributes of the ExpirationDate property.

# Test: Search for the ExpirationDate property and check its attributes.
rg --type cs -A 5 $'public DateTime? ExpirationDate { get; set; }'

Length of output: 229


Script:

#!/bin/bash
# Description: Verify the JSON serialization attributes of the ExpirationDate property.

# Test: Search for the ExpirationDate property and check its attributes.
rg --type cs -A 5 $'public DateTime\\? ExpirationDate { get; set; }'

Length of output: 232


Script:

#!/bin/bash
# Description: Verify the JSON serialization attributes of the ExpirationDate property.

# Test: Search for the ExpirationDate property and check its attributes.
rg --type cs -A 5 'public DateTime? ExpirationDate { get; set; }'

Length of output: 229


Script:

#!/bin/bash
# Description: Verify the JSON serialization attributes of the ExpirationDate property.

# Test: Search for the ExpirationDate property and check its attributes.
grep -F -A 5 'public DateTime? ExpirationDate { get; set; }' $(find . -name '*.cs')

Length of output: 14532

@davidvonthenen davidvonthenen merged commit 24fb0e3 into deepgram:main Aug 1, 2024
4 checks passed
@davidvonthenen davidvonthenen deleted the create-key-ttl branch August 1, 2024 14:17
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.

2 participants