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

Review of Structs Naming Convention + Callback Processing Example #127

Merged
merged 1 commit into from
Nov 17, 2023

Conversation

dvonthenen
Copy link
Contributor

@dvonthenen dvonthenen commented Nov 13, 2023

Proposed changes

Changes:

  • Implements example code of the callback processing found here: https://developers.deepgram.com/docs/callback/
  • Adds omitempty to all nodes in struct in the event that there are times in which certain fields aren't required. This solves any issues with JSON parsing and gives best-effort return on values
  • Internal variable name changes from Result_id to ResultID to fix issues with Go naming conventions. Do this for all the names. This will trigger errors when we add the linter for Go.
  • It seems like there are a couple of different definitions of what Summary object is. This is an attempt to keep both definitions to maintain backwards compatibility within the SDK.

Types of changes

What types of changes does your code introduce to the community Go 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
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

NA

@dvonthenen dvonthenen changed the title Keep Backwards Compat Summary Review of Structs Naming Convention + Callback Processing Example Nov 13, 2023
@dvonthenen dvonthenen force-pushed the keep-backwards-compat-summary branch 7 times, most recently from 26c10d2 to 581e07d Compare November 16, 2023 18:31
@dvonthenen dvonthenen merged commit a7b8599 into deepgram:main Nov 17, 2023
1 check passed
@dvonthenen dvonthenen deleted the keep-backwards-compat-summary branch November 17, 2023 14:37
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